de.agilecoders.wicket.markup.html.bootstrap.dialog

Class Modal

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

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

de.agilecoders.wicket.markup.html.bootstrap.dialog.Modal

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

Direct Known Subclasses:

TextContentModal

public class Modal
extends org.apache.wicket.markup.html.panel.Panel

The Modal dialog is a simple component with header, footer and body.

Author:

miha

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUTTON_MARKUP_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_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
Modal(String markupId) Constructor.
Modal(String id, org.apache.wicket.model.IModel<String> model) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Modal	addButton(org.apache.wicket.Component button) adds a button to footer section.
Modal	addCloseButton() adds a close button with default label ("Close")
Modal	addCloseButton(org.apache.wicket.model.IModel<String> label) adds a close button with specific label
Modal	addOpenerAttributesTo(org.apache.wicket.Component component)
Modal	appendCloseDialogJavaScript(org.apache.wicket.ajax.AjaxRequestTarget target)
Modal	appendShowDialogJavaScript(org.apache.wicket.ajax.AjaxRequestTarget target)
protected String	createActionScript(String markupId, String action) creates an action script to open/close the dialog on client side.
protected String	createBasicInitializerScript(String markupId) creates the basic initialization script of the modal dialog.
Modal	header(org.apache.wicket.model.IModel<String> label) Sets the header label text.
Modal	header(org.apache.wicket.model.IModel<String> label, boolean escapeMarkup) Sets the header label text and whether model strings should be escaped.
protected void	onClose(org.apache.wicket.ajax.AjaxRequestTarget target) hook to react on modal close event.
protected void	onComponentTag(org.apache.wicket.markup.ComponentTag tag)
protected void	onConfigure()
protected void	onInitialize()
void	renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
Modal	setFadeIn(boolean fadein) Whether to fadin/fadeout the modal dialog or not
Modal	setFooterVisible(boolean visible) Sets whether the footer and any children are visible.
Modal	setHeaderVisible(boolean visible) Sets whether the header and any children are visible.
Modal	setUseCloseHandler(boolean useCloseHandler) Sets whether the close handler is used or not.
Modal	setUseKeyboard(boolean keyboard) Whether to enable keyboard interaction like ESC to close the dialog.
Modal	show(boolean show) Sets the initial visibility of the modal dialog.
protected boolean	showImmediately()
protected boolean	useFadein()
protected boolean	useKeyboard()

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, 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, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onDetach, onEvent, onModelChanged, onModelChanging, 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

Field Detail

BUTTON_MARKUP_ID

public static final String BUTTON_MARKUP_ID

See Also:

Constant Field Values

Constructor Detail

Modal

public Modal(String markupId)

Constructor.

Parameters:

markupId - The non-null id of this component

Modal

public Modal(String id,
     org.apache.wicket.model.IModel<String> model)

Constructor.

Parameters:

id - The non-null id of this component

model - The component's body model

Method Detail

onComponentTag

protected void onComponentTag(org.apache.wicket.markup.ComponentTag tag)

Overrides:

onComponentTag in class org.apache.wicket.Component

onClose

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

hook to react on modal close event. The

Parameters:

target - The current AjaxRequestTarget

header

public Modal header(org.apache.wicket.model.IModel<String> label)

Sets the header label text.

Parameters:

label - The header label

Returns:

This

header

public Modal header(org.apache.wicket.model.IModel<String> label,
           boolean escapeMarkup)

Sets the header label text and whether model strings should be escaped.

Parameters:

label - The header label

escapeMarkup - True is model strings should be escaped

Returns:

This

setFooterVisible

public Modal setFooterVisible(boolean visible)

Sets whether the footer and any children are visible.

Parameters:

visible - True if footer and any children should be visible

Returns:

This

setHeaderVisible

public Modal setHeaderVisible(boolean visible)

Sets whether the header and any children are visible.

Parameters:

visible - True if header and any children should be visible

Returns:

This

setUseCloseHandler

public final Modal setUseCloseHandler(boolean useCloseHandler)

Sets whether the close handler is used or not. Default is false.

Parameters:

useCloseHandler - True if close handler should be used

Returns:

This

show

public Modal show(boolean show)

Sets the initial visibility of the modal dialog.

Parameters:

show - Whether to show the dialog or not

Returns:

This

appendCloseDialogJavaScript

public Modal appendCloseDialogJavaScript(org.apache.wicket.ajax.AjaxRequestTarget target)

appendShowDialogJavaScript

public Modal appendShowDialogJavaScript(org.apache.wicket.ajax.AjaxRequestTarget target)

createActionScript

protected String createActionScript(String markupId,
                        String action)

creates an action script to open/close the dialog on client side.

Parameters:

markupId - The component's markup id

action - Possible values: show/hide

Returns:

new script.

addOpenerAttributesTo

public Modal addOpenerAttributesTo(org.apache.wicket.Component component)

addCloseButton

public Modal addCloseButton(org.apache.wicket.model.IModel<String> label)

adds a close button with specific label

Parameters:

label - The label of close button

Returns:

this instance

addCloseButton

public Modal addCloseButton()

adds a close button with default label ("Close")

Returns:

this instance

addButton

public Modal addButton(org.apache.wicket.Component button)

adds a button to footer section.

Parameters:

button - Button to add to footer

Returns:

this instance.

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.Component

onConfigure

protected void onConfigure()

Overrides:

onConfigure in class org.apache.wicket.Component

renderHead

public void renderHead(org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IHeaderContributor

Overrides:

renderHead in class org.apache.wicket.Component

createBasicInitializerScript

protected String createBasicInitializerScript(String markupId)

creates the basic initialization script of the modal dialog. Override this to pass in your custom initialization, add event handlers, etc.

Parameters:

markupId - markup id

Returns:

initializer script

See Also:

createInitializerScript(java.lang.String)

useFadein

protected final boolean useFadein()

Returns:

true, if fade in animation is activated

useKeyboard

protected final boolean useKeyboard()

Returns:

true, if keyboard usage is activated

showImmediately

protected final boolean showImmediately()

Returns:

true, if modal dialog should be shown after initialization

setFadeIn

public final Modal setFadeIn(boolean fadein)

Whether to fadin/fadeout the modal dialog or not

Parameters:

fadein - true, if dialog should be animated

Returns:

This

setUseKeyboard

public final Modal setUseKeyboard(boolean keyboard)

Whether to enable keyboard interaction like ESC to close the dialog.

Parameters:

keyboard - true, if keyboard interaction is enabled

Returns:

This