com.googlecode.wicket.jquery.ui.widget.dialog

Class InputDialog<T extends java.io.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.wicket.markup.html.panel.GenericPanel<T>

com.googlecode.wicket.jquery.ui.widget.dialog.AbstractDialog<T>

com.googlecode.wicket.jquery.ui.widget.dialog.AbstractFormDialog<T>

com.googlecode.wicket.jquery.ui.widget.dialog.InputDialog<T>

Type Parameters:

T - the type of the model object of the RequiredTextField

All Implemented Interfaces:

IJQueryWidget, java.io.Serializable, java.lang.Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<T>, 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 InputDialog<T extends java.io.Serializable>
extends AbstractFormDialog<T>

Provides a modal dialog box that ask an input to the user

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

Nested classes/interfaces inherited from interface com.googlecode.wicket.jquery.core.IJQueryWidget

IJQueryWidget.JQueryWidget

Field Summary

Fields inherited from class com.googlecode.wicket.jquery.ui.widget.dialog.AbstractDialog

LBL_CANCEL, LBL_CLOSE, LBL_NO, LBL_OK, LBL_SUBMIT, LBL_YES

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 and Description
InputDialog(java.lang.String id, org.apache.wicket.model.IModel<java.lang.String> title, org.apache.wicket.model.IModel<java.lang.String> label) Constructor supplying a new default model.
InputDialog(java.lang.String id, org.apache.wicket.model.IModel<java.lang.String> title, org.apache.wicket.model.IModel<java.lang.String> label, org.apache.wicket.model.IModel<T> model)
InputDialog(java.lang.String id, java.lang.String title, java.lang.String label) Constructor supplying a new default model.
InputDialog(java.lang.String id, java.lang.String title, java.lang.String label, org.apache.wicket.model.IModel<T> model)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.util.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.
org.apache.wicket.markup.html.form.Form<?>	getForm() Gets the form to be validated by this dialog. Warning, the onSubmit and the onError are being delegated to this dialog.
org.apache.wicket.model.IModel<java.lang.String>	getLabel() Sets the text that will be displayed in front of the text field.
protected DialogButton	getSubmitButton() Gets the button that is in charge to submit the form. It should be in the list of buttons returned by AbstractDialog.getButtons()
boolean	isRequired() Indicates whether the underlying input is required
boolean	isResizable() Indicated whether the dialog is resizable
void	onError(org.apache.wicket.ajax.AjaxRequestTarget target) Triggered when the form is submitted, but the validation failed
protected void	onOpen(org.apache.wicket.ajax.AjaxRequestTarget target) Triggered when the dialog opens
void	setLabel(org.apache.wicket.model.IModel<java.lang.String> label) Sets the text that will be displayed in front of the text field.

Methods inherited from class com.googlecode.wicket.jquery.ui.widget.dialog.AbstractFormDialog

getDefaultFormProcessing, getForm, getModelComparator, newButtonAjaxBehavior, onClose, onInitialize, onModelChanged, onSubmit

Methods inherited from class com.googlecode.wicket.jquery.ui.widget.dialog.AbstractDialog

close, findButton, getTitle, getWidth, isDefaultCloseEventEnabled, isEscapeCloseEventEnabled, isModal, newWidgetBehavior, onBeforeRender, onClick, onConfigure, onDetach, open, setTitle, setTitle, setTitle

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

getModel, getModelObject, setModel, setModelObject

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

newMarkupSourcingStrategy

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

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, 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, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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

Constructor Detail

InputDialog

public InputDialog(java.lang.String id,
           java.lang.String title,
           java.lang.String label)

Constructor supplying a new default model.

Parameters:

id - the markupId, an html div suffice to host a dialog.

title - the title of the dialog

label - text that will be displayed in front of the text field.

InputDialog

public InputDialog(java.lang.String id,
           org.apache.wicket.model.IModel<java.lang.String> title,
           org.apache.wicket.model.IModel<java.lang.String> label)

Constructor supplying a new default model.

Parameters:

id - the markupId, an html div suffice to host a dialog.

title - the title of the dialog

label - text that will be displayed in front of the text field.

InputDialog

public InputDialog(java.lang.String id,
           java.lang.String title,
           java.lang.String label,
           org.apache.wicket.model.IModel<T> model)

Parameters:

id - the markupId, an html div suffice to host a dialog.

title - the title of the dialog

label - text that will be displayed in front of the text field.

model - the model to be used

InputDialog

public InputDialog(java.lang.String id,
           org.apache.wicket.model.IModel<java.lang.String> title,
           org.apache.wicket.model.IModel<java.lang.String> label,
           org.apache.wicket.model.IModel<T> model)

Parameters:

id - the markupId, an html div suffice to host a dialog.

title - the title of the dialog

label - text that will be displayed in front of the text field.

model - the model to be used

Method Detail

getLabel

public org.apache.wicket.model.IModel<java.lang.String> getLabel()

Sets the text that will be displayed in front of the text field.

Returns:

the dialog's label

setLabel

public void setLabel(org.apache.wicket.model.IModel<java.lang.String> label)

Sets the text that will be displayed in front of the text field.

Parameters:

label - the dialog's label

isRequired

public boolean isRequired()

Indicates whether the underlying input is required

Returns:

true by default

getForm

public org.apache.wicket.markup.html.form.Form<?> getForm()

Description copied from class: AbstractFormDialog

Gets the form to be validated by this dialog.
Warning, the onSubmit and the onError are being delegated to this dialog. However, it does not prevent the use of Form#onSubmit nor Form#onError

Specified by:

getForm in class AbstractFormDialog<T extends java.io.Serializable>

Returns:

the form

isResizable

public boolean isResizable()

Description copied from class: AbstractDialog

Indicated whether the dialog is resizable

Overrides:

isResizable in class AbstractDialog<T extends java.io.Serializable>

Returns:

false by default

getButtons

protected java.util.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 class AbstractDialog<T extends java.io.Serializable>

Returns:

AbstractDialog.btnOk by default

getSubmitButton

protected DialogButton getSubmitButton()

Description copied from class: AbstractFormDialog

Gets the button that is in charge to submit the form.
It should be in the list of buttons returned by AbstractDialog.getButtons()

Specified by:

getSubmitButton in class AbstractFormDialog<T extends java.io.Serializable>

Returns:

the submit button

onOpen

protected void onOpen(org.apache.wicket.ajax.AjaxRequestTarget target)

Description copied from class: AbstractDialog

Triggered when the dialog opens

Overrides:

onOpen in class AbstractDialog<T extends java.io.Serializable>

Parameters:

target - the AjaxRequestTarget

onError

public final void onError(org.apache.wicket.ajax.AjaxRequestTarget target)

Description copied from class: AbstractFormDialog

Triggered when the form is submitted, but the validation failed

Specified by:

onError in class AbstractFormDialog<T extends java.io.Serializable>