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

Class RemoteConfigItemChoicePanel<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.RemoteConfigItemChoicePanel<R>

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

public abstract class RemoteConfigItemChoicePanel<R extends PersistentRecord>
extends ConfigPanel

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected IConfigPage	configPage
protected final GatewayNetworkManager	manager
protected ConfigPanel	parentPanel

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
RemoteConfigItemChoicePanel(GatewayNetworkManager manager, String bundleKey, PersistentRecord[] records, IConfigPage configPage, ConfigPanel parentPanel, com.inductiveautomation.metro.api.ServerId serverId)

Method Summary

Modifier and Type	Method	Description
protected abstract List<String>	getChoices(com.inductiveautomation.metro.api.ServerId gateway)	Return a list of choices fetched from the remote server.
org.apache.commons.lang3.tuple.Pair<String,String>	getMenuLocation()
protected void	goToEditForm(PersistentRecord[] records)
protected abstract void	recordEditCallback(R childRecord, com.inductiveautomation.metro.api.ServerId serverId, String selection)	Called to modify the child record after a selection has been made.

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

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

configPage

protected IConfigPage configPage

parentPanel

protected ConfigPanel parentPanel

manager

protected final transient GatewayNetworkManager manager

Constructor Details

RemoteConfigItemChoicePanel

public RemoteConfigItemChoicePanel(GatewayNetworkManager manager,
 String bundleKey,
 PersistentRecord[] records,
 IConfigPage configPage,
 ConfigPanel parentPanel,
 com.inductiveautomation.metro.api.ServerId serverId)

Method Details

getChoices

protected abstract List<String> getChoices(@Nullable
 com.inductiveautomation.metro.api.ServerId gateway)

Return a list of choices fetched from the remote server. There is no guarantee the remote server is actually available.

Returns:

A list of options. The "Other" option will be automatically added.

recordEditCallback

protected abstract void recordEditCallback(@Nonnull
 R childRecord,
 @Nullable
 com.inductiveautomation.metro.api.ServerId serverId,
 @Nonnull
 String selection)

Called to modify the child record after a selection has been made. Selection will be an empty string if the "other" choice was selected.

goToEditForm

protected void goToEditForm(PersistentRecord[] records)

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.