com.inductiveautomation.ignition.gateway.web.components

Class RecordChoicePanel<R extends PersistentRecord>

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.RecordChoicePanel<R>

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 RecordChoicePanel<R extends PersistentRecord>
extends ConfigPanel

A ConfigPanel that presents a dropdown of records to choose from, and lets subclasses decide what to do upon submit.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected DescriptiveRadioChoice<R>	choice
protected org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String>	menuLocation
protected RecordMeta<R>	meta
protected java.lang.String	tableName

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 and Description
RecordChoicePanel(org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String> menuLocation, java.lang.String titleKey, java.lang.String descriptionKey, RecordMeta<R> meta)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFieldHeader()
org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String>	getMenuLocation()
protected RecordMeta<R>	getMeta()
protected RecordChoiceModel<R>	newModel(RecordMeta<R> meta)
protected void	onSubmit(R selectedChoice)

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

getHelpResourceKey, getHelpTopicId, getMenuPath, getTipLabelKey, getTipLabelModel, getTitleKey, getTitleModel, 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

tableName

protected java.lang.String tableName

meta

protected transient RecordMeta<R extends PersistentRecord> meta

menuLocation

protected org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String> menuLocation

choice

protected DescriptiveRadioChoice<R extends PersistentRecord> choice

Constructor Detail

RecordChoicePanel

public RecordChoicePanel(org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String> menuLocation,
                         java.lang.String titleKey,
                         java.lang.String descriptionKey,
                         RecordMeta<R> meta)

Method Detail

newModel

protected RecordChoiceModel<R> newModel(RecordMeta<R> meta)

getMeta

protected RecordMeta<R> getMeta()

getFieldHeader

public java.lang.String getFieldHeader()

getMenuLocation

public org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.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.

onSubmit

protected void onSubmit(R selectedChoice)