Package org.apache.syncope.client.console.wizards

Class WizardMgtPanel<T extends Serializable>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

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

org.apache.syncope.client.ui.commons.wizards.AbstractWizardMgtPanel<T>

org.apache.syncope.client.console.wizards.WizardMgtPanel<T>

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IQueueRegion, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

Direct Known Subclasses:

DirectoryPanel, JobActionPanel, ListViewPanel, Realm, RelationshipViewPanel, SCIMConfPanel, TogglePanel

public abstract class WizardMgtPanel<T extends Serializable>
extends AbstractWizardMgtPanel<T>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WizardMgtPanel.Builder<T extends Serializable>	PanelInWizard abstract builder.
static class	WizardMgtPanel.ExitEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	actualId
protected final AjaxLink<?>	addAjaxLink
protected boolean	footerVisibility
protected final Fragment	initialFragment
protected final BaseModal<T>	modal
protected ModalPanelBuilder<T>	newItemPanelBuilder
protected NotificationPanel	notificationPanel
protected PageReference	pageRef
protected boolean	showResultPanel
protected AjaxLink<?>	utilityAjaxLink
protected Label	utilityIcon
protected final boolean	wizardInModal

Fields inherited from class org.apache.syncope.client.ui.commons.wizards.AbstractWizardMgtPanel

WIZARD_ID

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

PANEL

Fields inherited from class org.apache.wicket.Component

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WizardMgtPanel(String id)
protected	WizardMgtPanel(String id, boolean wizardInModal)

Method Summary

Modifier and Type	Method	Description
MarkupContainer	addInnerObject(Component... childs)	Add object inside the main container.
protected <B extends ModalPanelBuilder<T>> WizardMgtPanel<T>	addNewItemPanelBuilder(B panelBuilder, boolean newItemDefaultButtonEnabled)
protected WizardMgtPanel<T>	addNotificationPanel(NotificationPanel notificationPanel)
MarkupContainer	addOrReplaceInnerObject(Component... childs)	Add or replace object inside the main container.
final WizardMgtPanel<T>	addOuterObject(Component... childs)	Add object outside the main container.
protected void	customActionCallback(AjaxRequestTarget target)	Custom action to perform on create/edit action callback.
protected void	customActionOnCancelCallback(AjaxRequestTarget target)	Custom action to perform on close callback on cancel event.
protected void	customActionOnFinishCallback(AjaxRequestTarget target)	Custom action to perform on close callback on finish event.
protected Panel	customResultBody(String panelId, T item, Serializable result)
protected final WizardMgtPanel<T>	disableContainerAutoRefresh()
protected final WizardMgtPanel<T>	enableUtilityButton()	Show utility button sending ExitEvent payload by default.
String	getActualId()
boolean	isReadOnly()
void	onEvent(IEvent<?> event)
WizardMgtPanel<T>	setFooterVisibility(boolean footerVisibility)
<B extends ModalPanelBuilder<T>> WizardMgtPanel<T>	setPageRef(PageReference pageRef)
void	setReadOnly(boolean readOnly)
<B extends ModalPanelBuilder<T>> WizardMgtPanel<T>	setShowResultPanel(boolean showResultPanel)
protected void	setWindowClosedReloadCallback(BaseModal<?> modal)	Set window close callback for the given modal.

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

getRegionMarkup, 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, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, 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, getMarkupTag, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, 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 org.apache.wicket.event.IEventSource

send

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

actualId

protected final String actualId

initialFragment

protected final Fragment initialFragment

wizardInModal

protected final boolean wizardInModal

pageRef

protected PageReference pageRef

addAjaxLink

protected final AjaxLink<?> addAjaxLink

utilityIcon

protected Label utilityIcon

utilityAjaxLink

protected AjaxLink<?> utilityAjaxLink

newItemPanelBuilder

protected ModalPanelBuilder<T extends Serializable> newItemPanelBuilder

notificationPanel

protected NotificationPanel notificationPanel

footerVisibility

protected boolean footerVisibility

showResultPanel

protected boolean showResultPanel

modal

protected final BaseModal<T extends Serializable> modal

Constructor Details

WizardMgtPanel

protected WizardMgtPanel(String id)

WizardMgtPanel

protected WizardMgtPanel(String id,
 boolean wizardInModal)

Method Details

getActualId

public String getActualId()

onEvent

public void onEvent(IEvent<?> event)

Specified by:

onEvent in interface IEventSink

Overrides:

onEvent in class Component

disableContainerAutoRefresh

protected final WizardMgtPanel<T> disableContainerAutoRefresh()

customResultBody

protected Panel customResultBody(String panelId,
 T item,
 Serializable result)

enableUtilityButton

protected final WizardMgtPanel<T> enableUtilityButton()

Show utility button sending ExitEvent payload by default.

Returns:

the current instance.

addInnerObject

public MarkupContainer addInnerObject(Component... childs)

Add object inside the main container.

Parameters:

childs - components to be added.

Returns:

the current panel instance.

addOrReplaceInnerObject

public MarkupContainer addOrReplaceInnerObject(Component... childs)

Add or replace object inside the main container.

Parameters:

childs - components to be added.

Returns:

the current panel instance.

addOuterObject

public final WizardMgtPanel<T> addOuterObject(Component... childs)

Add object outside the main container. Use this method just to be not influenced by specific inner object css'. Be sure to provide outer as id.

Parameters:

childs - components to be added.

Returns:

the current panel instance.

setPageRef

public <B extends ModalPanelBuilder<T>>
WizardMgtPanel<T> setPageRef(PageReference pageRef)

setShowResultPanel

public <B extends ModalPanelBuilder<T>>
WizardMgtPanel<T> setShowResultPanel(boolean showResultPanel)

addNewItemPanelBuilder

protected <B extends ModalPanelBuilder<T>>
WizardMgtPanel<T> addNewItemPanelBuilder(B panelBuilder,
 boolean newItemDefaultButtonEnabled)

addNotificationPanel

protected WizardMgtPanel<T> addNotificationPanel(NotificationPanel notificationPanel)

setFooterVisibility

public WizardMgtPanel<T> setFooterVisibility(boolean footerVisibility)

setWindowClosedReloadCallback

protected void setWindowClosedReloadCallback(BaseModal<?> modal)

Set window close callback for the given modal.

Parameters:

modal - target modal.

customActionCallback

protected void customActionCallback(AjaxRequestTarget target)

Custom action to perform on create/edit action callback.

Parameters:

target - Ajax request target.

customActionOnFinishCallback

protected void customActionOnFinishCallback(AjaxRequestTarget target)

Custom action to perform on close callback on finish event.

Parameters:

target - Ajax request target.

customActionOnCancelCallback

protected void customActionOnCancelCallback(AjaxRequestTarget target)

Custom action to perform on close callback on cancel event.

Parameters:

target - Ajax request target.

isReadOnly

public boolean isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)