Package com.inductiveautomation.ignition.gateway.web.components

Class AbstractRecordEditPanel

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

com.inductiveautomation.ignition.gateway.web.components.ConfigPanel

com.inductiveautomation.ignition.gateway.web.components.AbstractRecordEditPanel

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

Direct Known Subclasses:

RecordEditForm, RecordEditWizard

public abstract class AbstractRecordEditPanel
extends ConfigPanel

This class is the base for RecordEditForm and RecordEditWizard

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected IConfigPage	configPage
protected ConfigPanel	destinationPanel
protected static org.apache.log4j.Logger	log
protected org.apache.wicket.model.IModel<String>	titleModel

Fields inherited from class com.inductiveautomation.ignition.gateway.web.components.ConfigPanel

feedback, returnPanel

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor	Description
AbstractRecordEditPanel(IConfigPage configPage, ConfigPanel destinationPanel, org.apache.wicket.model.IModel<String> titleModel, org.apache.wicket.model.IModel<? extends List<? extends SRecordInstance>> records)	Creates a new record edit component.
AbstractRecordEditPanel(IConfigPage configPage, ConfigPanel destinationPanel, org.apache.wicket.model.IModel<String> titleModel, SRecordInstance... records)	Creates a new record edit component.

Method Summary

Modifier and Type	Method	Description
protected void	commitRecords(GatewayContext context, RecordEditMode editMode, List<SRecordInstance> records)	Called by onSubmit() to commit the altered records.
protected String	createErrorMessage(GatewayContext context, String noun, String name)
protected org.apache.wicket.markup.html.WebMarkupContainer	createFooterComponent(String id)	Creates a component to use as a form footer.
org.apache.commons.lang3.tuple.Pair<String,String>	getMenuLocation()
RecordEditMode	getMode()
protected RecordEditMode	getMode(List<SRecordInstance> recs)
protected List<SRecordInstance>	getModelObjectAsRecordList()
String	getRecordTypeNoun()	Gets the name of the first record type.
org.apache.wicket.model.IModel<String>	getTitleModel()
protected void	notifyListeners(GatewayContext context, RecordEditMode editMode, List<SRecordInstance> records)	Called by onSubmit() if commitRecords() doesn't throw an error.
protected void	onAfterCommit(List<SRecordInstance> records)
protected void	onBeforeCommit(PersistenceSession session, List<SRecordInstance> records)
protected void	onError()	Called when the wicket form calls onError().
protected void	onRecordEdited(SRecordInstance record)	Called after the record is successfully edited and saved to the database
protected void	onSubmit()
protected void	onSubmit(RecordEditMode mode, List<SRecordInstance> records)

Methods inherited from class com.inductiveautomation.ignition.gateway.web.components.ConfigPanel

getHelpResourceKey, getHelpTopicId, getMenuPath, getTipLabelKey, getTipLabelModel, getTitleKey, initTitleArea, isEscapeHtmlInTipLabel, isFeedbackEnabled, isTitleVisible, log, renderHead

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

newMarkupSourcingStrategy

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

log

protected static org.apache.log4j.Logger log

configPage

protected IConfigPage configPage

destinationPanel

protected ConfigPanel destinationPanel

titleModel

protected org.apache.wicket.model.IModel<String> titleModel

Constructor Details

AbstractRecordEditPanel

public AbstractRecordEditPanel(IConfigPage configPage,
 ConfigPanel destinationPanel,
 org.apache.wicket.model.IModel<String> titleModel,
 SRecordInstance... records)

Creates a new record edit component. The model must resolve to either a single SRecordInstance or a List containing one or more SRecordInstances

AbstractRecordEditPanel

public AbstractRecordEditPanel(IConfigPage configPage,
 ConfigPanel destinationPanel,
 org.apache.wicket.model.IModel<String> titleModel,
 org.apache.wicket.model.IModel<? extends List<? extends SRecordInstance>> records)

Creates a new record edit component. The model must resolve to either a single SRecordInstance or a List containing one or more SRecordInstances

Method Details

getMenuLocation

public org.apache.commons.lang3.tuple.Pair<String,String> getMenuLocation()

Overrides:

getMenuLocation in class ConfigPanel

Returns:

Pair of strings representing categoryId (matching ConfigCategory.getName()) and item id (matching INamedTab.getTabName()) which lets the menu know where in the config menu should be highlighted when this config page is visible.

getTitleModel

public org.apache.wicket.model.IModel<String> getTitleModel()

Overrides:

getTitleModel in class ConfigPanel

getMode

protected RecordEditMode getMode(List<SRecordInstance> recs)

getRecordTypeNoun

public String getRecordTypeNoun()

Gets the name of the first record type. Public so the property resolver can see it

getModelObjectAsRecordList

protected List<SRecordInstance> getModelObjectAsRecordList()

getMode

public RecordEditMode getMode()

onSubmit

protected void onSubmit()

onBeforeCommit

protected void onBeforeCommit(PersistenceSession session,
 List<SRecordInstance> records)
                       throws Exception

Throws:

Exception

onAfterCommit

protected void onAfterCommit(List<SRecordInstance> records)

onSubmit

protected void onSubmit(RecordEditMode mode,
 List<SRecordInstance> records)

notifyListeners

protected void notifyListeners(GatewayContext context,
 RecordEditMode editMode,
 List<SRecordInstance> records)
                        throws Exception

Called by onSubmit() if commitRecords() doesn't throw an error. Notifies record listeners of add/update, and then calls onRecordEdited()

Throws:

Exception

commitRecords

protected void commitRecords(GatewayContext context,
 RecordEditMode editMode,
 List<SRecordInstance> records)
                      throws Exception

Called by onSubmit() to commit the altered records. Calls onBeforCommit() before committing (and detatching) the dataset, calls onAfterCommit() afterwards

Throws:

Exception

onRecordEdited

protected void onRecordEdited(SRecordInstance record)
                       throws Exception

Called after the record is successfully edited and saved to the database

Throws:

Exception

createErrorMessage

protected String createErrorMessage(GatewayContext context,
 String noun,
 String name)

onError

protected void onError()

Called when the wicket form calls onError(). Default implementation is no-op.

createFooterComponent

protected org.apache.wicket.markup.html.WebMarkupContainer createFooterComponent(String id)

Creates a component to use as a form footer. Default implementation creates an InvisibleContainer.