com.inductiveautomation.ignition.gateway.web.components

Class RecordEditForm

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

com.inductiveautomation.ignition.gateway.web.components.RecordEditForm

All Implemented Interfaces:

java.io.Serializable, java.lang.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

public class RecordEditForm
extends AbstractRecordEditPanel

A Wicket panel that provides web-form editing capability for persistent record objects. Can edit more than one record at once, flattening them and combining their field categories to make them look like a single object. In this way extension object parent records and their type-specific properties records can be edited as a whole.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<org.apache.wicket.Component>	ajaxComponents A list of components to be included in ajax request targets when advanced visibility is toggled.
protected boolean	showAdvanced

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

configPage, destinationPanel, log, titleModel

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

feedback

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 and Description
RecordEditForm(IConfigPage configPage, ConfigPanel destinationPanel, org.apache.wicket.model.IModel<java.lang.String> titleModel, org.apache.wicket.model.IModel<? extends java.util.List<? extends SRecordInstance>> records) Creates a new record edit component.
RecordEditForm(IConfigPage configPage, ConfigPanel destinationPanel, org.apache.wicket.model.IModel<java.lang.String> titleModel, SRecordInstance... records) Creates a new record edit component.

Method Summary

Modifier and Type	Method and Description
protected void	addAdvancedCategories(org.apache.wicket.markup.repeater.RepeatingView tableRepeater, RecordEditMode mode, java.util.Map<Category,java.util.List<FormMeta>> categories, java.util.Map<SFieldMeta,SRecordInstance> recordLookup)
protected void	addField(org.apache.wicket.markup.repeater.RepeatingView rowRepeater, FormMeta formMeta, RecordEditMode mode, java.util.Map<SFieldMeta,SRecordInstance> recordLookup)
protected void	addStandardCategories(org.apache.wicket.markup.repeater.RepeatingView tableRepeater, RecordEditMode mode, java.util.Map<Category,java.util.List<FormMeta>> categories, java.util.Map<SFieldMeta,SRecordInstance> recordLookup) Add category tables to the view.
protected org.apache.wicket.Component	createCustomEditPanel(java.lang.String id) Override this and return something useful to insert your own custom editing panel into the form.
protected void	init()
protected void	initComponents(java.util.List<SRecordInstance> records)
boolean	isShowAdvanced()
protected org.apache.wicket.Component	newEditorComponent(java.lang.String id, FormMeta formMeta, RecordEditMode mode, SRecordInstance record)
void	setShowAdvanced(boolean showAdvanced)
protected boolean	showAdvancedCheckbox(java.util.Set<Category> categories)

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

commitRecords, createErrorMessage, createFooterComponent, getMenuPath, getMode, getMode, getModelObjectAsRecordList, getRecordTypeNoun, getTitleModel, notifyListeners, onAfterCommit, onBeforeCommit, onError, onRecordEdited, onSubmit, onSubmit

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

getHelpResourceKey, getHelpTopicId, getTipLabelKey, getTipLabelModel, getTitleKey, initTitleArea, isEscapeHTMLInTipLabel, isFeedbackEnabled, isTitleVisible, log

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

newMarkupSourcingStrategy

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

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, 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, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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 Detail

showAdvanced

protected boolean showAdvanced

ajaxComponents

protected java.util.List<org.apache.wicket.Component> ajaxComponents

A list of components to be included in ajax request targets when advanced visibility is toggled.

Constructor Detail

RecordEditForm

public RecordEditForm(IConfigPage configPage,
                      ConfigPanel destinationPanel,
                      org.apache.wicket.model.IModel<java.lang.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

RecordEditForm

public RecordEditForm(IConfigPage configPage,
                      ConfigPanel destinationPanel,
                      org.apache.wicket.model.IModel<java.lang.String> titleModel,
                      org.apache.wicket.model.IModel<? extends java.util.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 Detail

init

protected void init()

initComponents

protected void initComponents(java.util.List<SRecordInstance> records)

createCustomEditPanel

protected org.apache.wicket.Component createCustomEditPanel(java.lang.String id)

Override this and return something useful to insert your own custom editing panel into the form.

addStandardCategories

protected void addStandardCategories(org.apache.wicket.markup.repeater.RepeatingView tableRepeater,
                                     RecordEditMode mode,
                                     java.util.Map<Category,java.util.List<FormMeta>> categories,
                                     java.util.Map<SFieldMeta,SRecordInstance> recordLookup)

Add category tables to the view. Must use the view's newChildId() function to obtain the id for the child. The two markup children are "category-header" and "field"

addAdvancedCategories

protected void addAdvancedCategories(org.apache.wicket.markup.repeater.RepeatingView tableRepeater,
                                     RecordEditMode mode,
                                     java.util.Map<Category,java.util.List<FormMeta>> categories,
                                     java.util.Map<SFieldMeta,SRecordInstance> recordLookup)

addField

protected void addField(org.apache.wicket.markup.repeater.RepeatingView rowRepeater,
                        FormMeta formMeta,
                        RecordEditMode mode,
                        java.util.Map<SFieldMeta,SRecordInstance> recordLookup)

showAdvancedCheckbox

protected boolean showAdvancedCheckbox(java.util.Set<Category> categories)

newEditorComponent

protected org.apache.wicket.Component newEditorComponent(java.lang.String id,
                                                         FormMeta formMeta,
                                                         RecordEditMode mode,
                                                         SRecordInstance record)

isShowAdvanced

public boolean isShowAdvanced()

setShowAdvanced

public void setShowAdvanced(boolean showAdvanced)