org.hippoecm.frontend.dialog

Class AbstractDialog<T>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.form.Form<T>

org.hippoecm.frontend.dialog.AbstractDialog<T>

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.ajax.IAjaxIndicatorAware, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<T>, org.apache.wicket.IRequestListener, org.apache.wicket.markup.html.form.IFormSubmitListener, 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, IDialogService.Dialog

Direct Known Subclasses:

AbstractWorkflowDialog, CompatibilityWorkflowPlugin.WorkflowAction.WorkflowDialog, ConfirmDialog, Dialog, ExceptionDialog, TextDialog

public abstract class AbstractDialog<T>
extends org.apache.wicket.markup.html.form.Form<T>
implements IDialogService.Dialog, org.apache.wicket.ajax.IAjaxIndicatorAware

Utility class for implementing the IDialogService.Dialog interface. Provides OK and Cancel buttons by default, and has support for fullscreen mode which is enabled by overriding isFullscreenEnabled.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractDialog.ExceptionFeedbackPanel
protected static class	AbstractDialog.PersistentFeedbackMessagesModel

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.form.Form

org.apache.wicket.markup.html.form.Form.MethodMismatchResponse, org.apache.wicket.markup.html.form.Form.ValidationVisitor

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cancelled
protected org.apache.wicket.markup.html.panel.FeedbackPanel	feedback
protected AbstractDialog.PersistentFeedbackMessagesModel	fmm

Fields inherited from class org.apache.wicket.markup.html.form.Form

ENCTYPE_MULTIPART_FORM_DATA, METHOD_GET, METHOD_POST

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

Fields inherited from interface org.apache.wicket.markup.html.form.IFormSubmitListener

INTERFACE

Constructor Summary

Constructors

Constructor and Description
AbstractDialog()
AbstractDialog(org.apache.wicket.model.IModel<T> model)

Method Summary

Modifier and Type	Method and Description
protected boolean	addAjaxIndicator()
protected void	addButton(org.apache.wicket.markup.html.form.Button button) Add a Button to the button bar.
protected void	closeDialog()
protected void	delegateSubmit(org.apache.wicket.markup.html.form.IFormSubmitter submittingComponent)
protected String	getAdditionalFullscreenScript(boolean isFullscreen) Add custom javascript to be executed after the dialog has gone fullscreen or returned to it's initial size.
String	getAjaxIndicatorMarkupId() Implement IAjaxIndicatorAware, to let ajax components in the dialog trigger the ajax indicator when they trigger an ajax request.
org.apache.wicket.Component	getComponent()
protected org.apache.wicket.model.IModel<String>	getExceptionTranslation(Throwable t, Object... parameters)
protected org.apache.wicket.feedback.FeedbackMessagesModel	getFeedbackMessagesModel()
protected String	getFullscreenScript() Construct javascript that looks up the latest dialog and executes the toggleFullscreen function.
org.apache.wicket.util.value.IValueMap	getProperties() Properties that determine how the dialog is rendered.
UserSession	getSession()
protected void	handleSubmit() Method that handles the submit to a form.
protected boolean	isFullscreenEnabled() If this method returns true a fullscreen button will be added to the dialog which toggle's the between fullscreen and initial size.
protected org.apache.wicket.markup.html.panel.FeedbackPanel	newFeedbackPanel(String id) Create a feedback panel and display only messages from children components.
protected void	onCancel() Callback method invoked when the user clicks the 'Cancel' button.
void	onClose() Implement onClose callback, invoked when the dialog is closed.
protected void	onDetach()
protected void	onError()
protected void	onOk() Callback method invoked when the user clicks the 'OK' button.
protected void	onRemove()
protected void	onSubmit()
void	process(org.apache.wicket.markup.html.form.IFormSubmitter submittingComponent)
protected void	removeButton(org.apache.wicket.markup.html.form.Button button) Remove a button from the button bar.
void	render(PluginRequestTarget target) Part of the pre-rendering registration.
void	setAjaxChannel(org.apache.wicket.ajax.AjaxChannel ajaxChannel)
protected void	setButtonCssClass(String buttonCssClass) Set a specific class that is added to all the buttons in the dialog
protected void	setCancelEnabled(boolean isset)
protected void	setCancelKeyType(wicket.contrib.input.events.key.KeyType keyType)
protected void	setCancelLabel(org.apache.wicket.model.IModel<String> label)
protected void	setCancelLabel(String label)
protected void	setCancelVisible(boolean isset)
void	setDialogService(IDialogService dialogService) When the dialog is shown (IDialogService.show(Dialog)), the dialog service is injected into the dialog.
AjaxUpdatingWidget<?>	setFocus(AjaxUpdatingWidget<?> widget)
org.apache.wicket.Component	setFocus(org.apache.wicket.Component c)
protected void	setFocusOnCancel()
protected void	setFocusOnOk()
void	setNonAjaxSubmit()
protected void	setOkEnabled(boolean isset)
protected void	setOkKeyType(wicket.contrib.input.events.key.KeyType keyType)
protected void	setOkLabel(org.apache.wicket.model.IModel<String> label)
protected void	setOkLabel(String label)
protected void	setOkVisible(boolean isset)

Methods inherited from class org.apache.wicket.markup.html.form.Form

add, appendDefaultButtonField, beforeUpdateFormComponentModels, callOnError, clearInput, encodeUrlInHiddenFields, error, findForm, findSubmittingButton, getActionUrl, getDefaultButton, getFileMaxSize, getFormValidators, getHiddenFieldId, getInputNamePrefix, getJsForInterfaceUrl, getMaxSize, getMethod, getModel, getModelObject, getRootForm, getRootFormRelativeId, getStatelessHint, getValidatorKeyPrefix, handleMultiPart, hasError, internalOnModelChanged, isMultiPart, isRootForm, isSubmitted, markFormComponentsInvalid, markFormComponentsValid, onBeforeRender, onComponentTag, onComponentTagBody, onFileUploadException, onFormSubmitted, onFormSubmitted, onMethodMismatch, onValidate, onValidateModelObjects, registerJavaScriptNamespaces, remove, renderHead, renderPlaceholderTag, setDefaultButton, setFileMaxSize, setMaxSize, setModel, setModelObject, setMultiPart, setVersioned, updateFormComponentModels, validate, validateComponents, validateFormValidator, validateFormValidators, visitFormComponents, visitFormComponentsPostOrder, wantSubmitOnNestedFormSubmit, wantSubmitOnParentFormSubmit, writeParamsAsHiddenFields

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, 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, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onConfigure, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, 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 org.hippoecm.frontend.dialog.IDialogService.Dialog

getTitle

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

fmm

protected AbstractDialog.PersistentFeedbackMessagesModel fmm

feedback

protected org.apache.wicket.markup.html.panel.FeedbackPanel feedback

cancelled

protected boolean cancelled

Constructor Detail

AbstractDialog

public AbstractDialog()

AbstractDialog

public AbstractDialog(org.apache.wicket.model.IModel<T> model)

Method Detail

getExceptionTranslation

protected org.apache.wicket.model.IModel<String> getExceptionTranslation(Throwable t,
                                                                         Object... parameters)

addAjaxIndicator

protected boolean addAjaxIndicator()

getFullscreenScript

protected String getFullscreenScript()

Construct javascript that looks up the latest dialog and executes the toggleFullscreen function. Additional javascript can be added by overriding getAdditionalFullscreenScript

Returns:

Javascript that toggles the dialog between fullscreen and initial size

getAdditionalFullscreenScript

protected String getAdditionalFullscreenScript(boolean isFullscreen)

Add custom javascript to be executed after the dialog has gone fullscreen or returned to it's initial size.

Parameters:

isFullscreen - flag indicating the current fullscreen state

Returns:

Custom javascript that is executed after the dialog changed fullscreen state

isFullscreenEnabled

protected boolean isFullscreenEnabled()

If this method returns true a fullscreen button will be added to the dialog which toggle's the between fullscreen and initial size.

Returns:

true to enable fullscreen support

getSession

public UserSession getSession()

Overrides:

getSession in class org.apache.wicket.Component

onDetach

protected void onDetach()

Overrides:

onDetach in class org.apache.wicket.markup.html.form.Form<T>

newFeedbackPanel

protected org.apache.wicket.markup.html.panel.FeedbackPanel newFeedbackPanel(String id)

Create a feedback panel and display only messages from children components.

getFeedbackMessagesModel

protected final org.apache.wicket.feedback.FeedbackMessagesModel getFeedbackMessagesModel()

getAjaxIndicatorMarkupId

public String getAjaxIndicatorMarkupId()

Implement IAjaxIndicatorAware, to let ajax components in the dialog trigger the ajax indicator when they trigger an ajax request.

Specified by:

getAjaxIndicatorMarkupId in interface org.apache.wicket.ajax.IAjaxIndicatorAware

Returns:

the markup id of the ajax indicator

closeDialog

protected final void closeDialog()

setNonAjaxSubmit

public void setNonAjaxSubmit()

setAjaxChannel

public void setAjaxChannel(org.apache.wicket.ajax.AjaxChannel ajaxChannel)

setOkEnabled

protected void setOkEnabled(boolean isset)

setOkVisible

protected void setOkVisible(boolean isset)

setOkLabel

protected void setOkLabel(String label)

setOkLabel

protected void setOkLabel(org.apache.wicket.model.IModel<String> label)

setFocusOnOk

protected void setFocusOnOk()

setCancelEnabled

protected void setCancelEnabled(boolean isset)

setCancelVisible

protected void setCancelVisible(boolean isset)

setCancelLabel

protected void setCancelLabel(String label)

setCancelLabel

protected void setCancelLabel(org.apache.wicket.model.IModel<String> label)

setFocusOnCancel

protected void setFocusOnCancel()

setOkKeyType

protected void setOkKeyType(wicket.contrib.input.events.key.KeyType keyType)

setCancelKeyType

protected void setCancelKeyType(wicket.contrib.input.events.key.KeyType keyType)

setDialogService

public void setDialogService(IDialogService dialogService)

When the dialog is shown (IDialogService.show(Dialog)), the dialog service is injected into the dialog.

Specified by:

setDialogService in interface IDialogService.Dialog

addButton

protected void addButton(org.apache.wicket.markup.html.form.Button button)

Add a Button to the button bar. The id of the button must equal "button".

removeButton

protected void removeButton(org.apache.wicket.markup.html.form.Button button)

Remove a button from the button bar.

setButtonCssClass

protected void setButtonCssClass(String buttonCssClass)

Set a specific class that is added to all the buttons in the dialog

handleSubmit

protected void handleSubmit()

Method that handles the submit to a form.

delegateSubmit

protected void delegateSubmit(org.apache.wicket.markup.html.form.IFormSubmitter submittingComponent)

Overrides:

delegateSubmit in class org.apache.wicket.markup.html.form.Form<T>

onSubmit

protected final void onSubmit()

Overrides:

onSubmit in class org.apache.wicket.markup.html.form.Form<T>

onError

protected final void onError()

Overrides:

onError in class org.apache.wicket.markup.html.form.Form<T>

onOk

protected void onOk()

Callback method invoked when the user clicks the 'OK' button. When no errors are reported, this will cause the dialog to be closed.

onCancel

protected void onCancel()

Callback method invoked when the user clicks the 'Cancel' button.

getComponent

public org.apache.wicket.Component getComponent()

Specified by:

getComponent in interface IDialogService.Dialog

Returns:

a component with wicket id "content"

onRemove

protected void onRemove()

Overrides:

onRemove in class org.apache.wicket.Component

render

public void render(PluginRequestTarget target)

Part of the pre-rendering registration. When the dialog has components that should be rendered, they can be registered with the target.

Implementations must invoke IRenderService.render(PluginRequestTarget) on render services that contribute to the wicket component hierarchy.

Specified by:

render in interface IDialogService.Dialog

onClose

public void onClose()

Implement onClose callback, invoked when the dialog is closed. Make sure the keyboard shortcuts are cleaned up correctly. Subclasses overriding this method should also invoke super#onClose();

Specified by:

onClose in interface IDialogService.Dialog

getProperties

public org.apache.wicket.util.value.IValueMap getProperties()

Properties that determine how the dialog is rendered. In particular, the width and height properties are used for the size (in pixels).

Specified by:

getProperties in interface IDialogService.Dialog

setFocus

public org.apache.wicket.Component setFocus(org.apache.wicket.Component c)

setFocus

public AjaxUpdatingWidget<?> setFocus(AjaxUpdatingWidget<?> widget)

process

public void process(org.apache.wicket.markup.html.form.IFormSubmitter submittingComponent)

Overrides:

process in class org.apache.wicket.markup.html.form.Form<T>