Class MessageFormDialog
- 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.wicket.markup.html.panel.GenericPanel<T>
-
- com.googlecode.wicket.jquery.ui.widget.dialog.AbstractDialog<T>
-
- com.googlecode.wicket.jquery.ui.widget.dialog.AbstractFormDialog<String>
-
- com.googlecode.wicket.jquery.ui.widget.dialog.MessageFormDialog
-
- All Implemented Interfaces:
com.googlecode.wicket.jquery.core.IJQueryWidget
,IDialogListener
,Serializable
,Iterable<org.apache.wicket.Component>
,org.apache.wicket.event.IEventSink
,org.apache.wicket.event.IEventSource
,org.apache.wicket.feedback.IFeedbackContributor
,org.apache.wicket.IConverterLocator
,org.apache.wicket.IGenericComponent<String,org.apache.wicket.markup.html.panel.GenericPanel<String>>
,org.apache.wicket.IMetadataContext<Serializable,org.apache.wicket.Component>
,org.apache.wicket.IQueueRegion
,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 MessageFormDialog extends AbstractFormDialog<String>
Provides a modal dialog box that displays a specific message, with a predefined icon and a predefined button set.
Note:MessageDialog
&MessageFormDialog
are sharing the same code, they just does not extend the same class.- Author:
- Sebastien Briquet - sebfz1
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.googlecode.wicket.jquery.ui.widget.dialog.AbstractFormDialog
AbstractFormDialog.DialogFormSubmitter
-
-
Field Summary
-
Fields inherited from class com.googlecode.wicket.jquery.ui.widget.dialog.AbstractDialog
CANCEL, CLOSE, LBL_CANCEL, LBL_CLOSE, LBL_NO, LBL_OK, LBL_SUBMIT, LBL_YES, NO, OK, SUBMIT, YES
-
-
Constructor Summary
Constructors Constructor Description MessageFormDialog(String id, String title, String message, DialogButtons buttons)
Constructor.MessageFormDialog(String id, String title, String message, DialogButtons buttons, DialogIcon icon)
Constructor.MessageFormDialog(String id, String title, String message, List<DialogButton> buttons)
Constructor.MessageFormDialog(String id, String title, String message, List<DialogButton> buttons, DialogIcon icon)
Constructor.MessageFormDialog(String id, org.apache.wicket.model.IModel<String> title, org.apache.wicket.model.IModel<String> message, DialogButtons buttons)
Constructor.MessageFormDialog(String id, org.apache.wicket.model.IModel<String> title, org.apache.wicket.model.IModel<String> message, DialogButtons buttons, DialogIcon icon)
Constructor.MessageFormDialog(String id, org.apache.wicket.model.IModel<String> title, org.apache.wicket.model.IModel<String> message, List<DialogButton> buttons)
Constructor.MessageFormDialog(String id, org.apache.wicket.model.IModel<String> title, org.apache.wicket.model.IModel<String> message, List<DialogButton> buttons, DialogIcon icon)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected List<DialogButton>
getButtons()
Gets the dialog's buttons.
It is allowed to return a predefined list (ie: DialogButtons#OK_CANCEL#toList()) as long as the buttons state (enable and/or visible) are not modified
Warning: It is not legal to create the buttons to be returned in this method.protected org.apache.wicket.Component
newLabel(String id, org.apache.wicket.model.IModel<String> model)
Gets a newComponent
that will be used as a label in the dialog.
Override this method when you need to show formatted label.void
onClose(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, DialogButton button)
Triggered when the dialog closes.protected void
onInitialize()
protected void
onOpen(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)
Triggered when the dialog opens-
Methods inherited from class com.googlecode.wicket.jquery.ui.widget.dialog.AbstractFormDialog
getDefaultFormProcessing, getForm, getForm, getModelComparator, getSubmitButton, newButtonAjaxBehavior, onError, onModelChanged, onSubmit
-
Methods inherited from class com.googlecode.wicket.jquery.ui.widget.dialog.AbstractDialog
close, findButton, getTitle, getWidth, isDefaultCloseEventEnabled, isEscapeCloseEventEnabled, isModal, isResizable, newDialogListenerWrapper, newWidgetBehavior, onBeforeRender, onClick, onConfigure, onDetach, open, setTitle, setTitle, setTitle
-
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, 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, 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, onEvent, 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.IGenericComponent
getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel, setModelObject
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Constructor Detail
-
MessageFormDialog
public MessageFormDialog(String id, String title, String message, DialogButtons buttons)
Constructor.- Parameters:
id
- the markup id, an html div suffice to host a dialog.title
- the title of the dialogmessage
- the message to be displayedbuttons
- button set to be displayed
-
MessageFormDialog
public MessageFormDialog(String id, String title, String message, List<DialogButton> buttons)
Constructor.- Parameters:
id
- the markup id, an html div suffice to host a dialog.title
- the title of the dialogmessage
- the message to be displayedbuttons
- list of buttons to be displayed
-
MessageFormDialog
public MessageFormDialog(String id, String title, String message, DialogButtons buttons, DialogIcon icon)
Constructor.- Parameters:
id
- the markup id, an html div suffice to host a dialog.title
- the title of the dialogmessage
- the message to be displayedbuttons
- button set to be displayedicon
- the predefined icon to display
-
MessageFormDialog
public MessageFormDialog(String id, String title, String message, List<DialogButton> buttons, DialogIcon icon)
Constructor.- Parameters:
id
- the markup id, an html div suffice to host a dialog.title
- the title of the dialogmessage
- the message to be displayedbuttons
- list of buttons to be displayedicon
- the predefined icon to display
-
MessageFormDialog
public MessageFormDialog(String id, org.apache.wicket.model.IModel<String> title, org.apache.wicket.model.IModel<String> message, DialogButtons buttons)
Constructor.- Parameters:
id
- the markup id, an html div suffice to host a dialog.title
- the title of the dialogmessage
- the message to be displayedbuttons
- button set to be displayed
-
MessageFormDialog
public MessageFormDialog(String id, org.apache.wicket.model.IModel<String> title, org.apache.wicket.model.IModel<String> message, List<DialogButton> buttons)
Constructor.- Parameters:
id
- the markup id, an html div suffice to host a dialog.title
- the title of the dialogmessage
- the message to be displayedbuttons
- list of buttons to be displayed
-
MessageFormDialog
public MessageFormDialog(String id, org.apache.wicket.model.IModel<String> title, org.apache.wicket.model.IModel<String> message, DialogButtons buttons, DialogIcon icon)
Constructor.- Parameters:
id
- the markup id, an html div suffice to host a dialog.title
- the title of the dialogmessage
- the message to be displayedbuttons
- button set to be displayedicon
- the predefined icon to display
-
MessageFormDialog
public MessageFormDialog(String id, org.apache.wicket.model.IModel<String> title, org.apache.wicket.model.IModel<String> message, List<DialogButton> buttons, DialogIcon icon)
Constructor.- Parameters:
id
- the markup id, an html div suffice to host a dialog.title
- the title of the dialogmessage
- the message to be displayedbuttons
- list of buttons to be displayedicon
- the predefined icon to display
-
-
Method Detail
-
getButtons
protected final List<DialogButton> getButtons()
Description copied from class:AbstractDialog
Gets the dialog's buttons.
It is allowed to return a predefined list (ie: DialogButtons#OK_CANCEL#toList()) as long as the buttons state (enable and/or visible) are not modified
Warning: It is not legal to create the buttons to be returned in this method.- Overrides:
getButtons
in classAbstractDialog<String>
- Returns:
AbstractDialog.btnOk
by default
-
onInitialize
protected void onInitialize()
- Overrides:
onInitialize
in classAbstractFormDialog<String>
-
onOpen
protected void onOpen(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)
Description copied from class:AbstractDialog
Triggered when the dialog opens- Overrides:
onOpen
in classAbstractDialog<String>
- Parameters:
handler
- theIPartialPageRequestHandler
-
onClose
public void onClose(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, DialogButton button)
Description copied from interface:IDialogListener
Triggered when the dialog closes.- Specified by:
onClose
in interfaceIDialogListener
- Overrides:
onClose
in classAbstractFormDialog<String>
- Parameters:
handler
- theIPartialPageRequestHandler
button
- the button that closed the dialog
-
newLabel
protected org.apache.wicket.Component newLabel(String id, org.apache.wicket.model.IModel<String> model)
Gets a newComponent
that will be used as a label in the dialog.
Override this method when you need to show formatted label.- Parameters:
id
- the markup idmodel
- the labelIModel
- Returns:
- the new label component.
-
-