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

Class UserEditForm

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.user.UserEditForm

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 UserEditForm
extends ConfigPanel

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserEditForm.ExtendedPropertyListModel

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	addContactInfo
boolean	alterPassword
protected IConfigPage	configPage
protected ConfigPanel	destinationPanel
protected org.apache.wicket.model.IModel<List<String>>	groupModel
protected RecordEditMode	mode
protected String	originalUsername
String	password
protected org.apache.wicket.markup.html.form.PasswordTextField	password1
protected org.apache.wicket.markup.html.form.PasswordTextField	password2
protected org.apache.wicket.model.IModel<User>	userModel

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
UserEditForm(IConfigPage configPage, ConfigPanel destinationPanel, User user, RecordEditMode mode, org.apache.wicket.model.IModel<List<String>> groupModel)

Method Summary

Modifier and Type	Method	Description
boolean	allowAlterPassword()	Override this and return false to prevent the password editing UI to show
org.apache.commons.lang3.tuple.Pair<String,String>	getMenuLocation()
org.apache.wicket.model.IModel<String>	getTitleModel()
protected User	getUser()
protected void	initComponents()
protected void	onError()	Called when the wicket form calls onError().
protected void	onSubmit()
protected abstract void	onUserEdited(User user)	Called when the user has been edited.
boolean	saveContactInfoEnabled()

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

alterPassword

public boolean alterPassword

password

public String password

configPage

protected IConfigPage configPage

destinationPanel

protected ConfigPanel destinationPanel

mode

protected RecordEditMode mode

originalUsername

protected String originalUsername

userModel

protected org.apache.wicket.model.IModel<User> userModel

password1

protected org.apache.wicket.markup.html.form.PasswordTextField password1

password2

protected org.apache.wicket.markup.html.form.PasswordTextField password2

groupModel

protected org.apache.wicket.model.IModel<List<String>> groupModel

addContactInfo

protected boolean addContactInfo

Constructor Details

UserEditForm

public UserEditForm(IConfigPage configPage,
 ConfigPanel destinationPanel,
 User user,
 RecordEditMode mode,
 org.apache.wicket.model.IModel<List<String>> groupModel)

Method Details

getUser

protected User getUser()

getTitleModel

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

Overrides:

getTitleModel in class ConfigPanel

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.

allowAlterPassword

public boolean allowAlterPassword()

Override this and return false to prevent the password editing UI to show

initComponents

protected void initComponents()

saveContactInfoEnabled

public boolean saveContactInfoEnabled()

onSubmit

protected void onSubmit()

onUserEdited

protected abstract void onUserEdited(User user)

Called when the user has been edited. This is when you should save the changes back to a persistent store.

onError

protected void onError()

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