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

Class DialogBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

com.googlecode.wicket.jquery.core.JQueryAbstractBehavior

com.googlecode.wicket.jquery.core.JQueryBehavior

com.googlecode.wicket.jquery.ui.JQueryUIBehavior

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

All Implemented Interfaces:

com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware, JQueryDestroyListener.IDestroyable, Serializable, org.apache.wicket.IComponentAwareEventSink, org.apache.wicket.markup.html.IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable

public abstract class DialogBehavior
extends JQueryUIBehavior
implements com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware

Provides a jQuery dialog behavior.

Since:

1.2.3, 6.0.1

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DialogBehavior.CloseEvent Provides an event object that will be broadcasted by the DialogBehavior.OnDefaultCloseAjaxBehavior and the DialogBehavior.OnEscapeCloseAjaxBehavior callbacks
protected static class	DialogBehavior.OnDefaultCloseAjaxBehavior Provides a JQueryAjaxBehavior that aims to be wired to the 'close' event Underlying callback will be triggered when the user clicks on the X-icon
protected static class	DialogBehavior.OnEscapeCloseAjaxBehavior Provides a JQueryAjaxBehavior that aims to be wired to the 'beforeClose' event Underlying callback will be triggered when the user presses the escape key

Field Summary

Fields

Modifier and Type	Field and Description
static String	METHOD

Fields inherited from class com.googlecode.wicket.jquery.core.JQueryBehavior

method, options, selector

Constructor Summary

Constructors

Constructor and Description
DialogBehavior(String selector) Constructor
DialogBehavior(String selector, com.googlecode.wicket.jquery.core.Options options) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(org.apache.wicket.Component component)
void	close(org.apache.wicket.ajax.AjaxRequestTarget target) Closes the dialogs in ajax.
protected abstract List<DialogButton>	getButtons() Gets the dialog's buttons.
boolean	isDefaultCloseEventEnabled() Indicates whether the default close event (the click on the X-icon) is enabled If true, the onClose(AjaxRequestTarget, DialogButton) event will be triggered, with a null DialogButton
boolean	isEscapeCloseEventEnabled() Indicates whether the escape close event (pressing escape key) is enabled If true, the onClose(AjaxRequestTarget, DialogButton) event will be triggered, with a null DialogButton
protected abstract ButtonAjaxBehavior	newButtonAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source, DialogButton button) Gets a new ButtonAjaxBehavior that will be called by the corresponding DialogButton.
protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior	newOnDefaultCloseAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source) Gets a new JQueryAjaxBehavior that will be wired to the 'close' event, triggered when the user clicks on the X-icon
protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior	newOnEscapeCloseAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source) Gets a new JQueryAjaxBehavior that will be wired to the 'beforeClose' event, triggered when the user presses the escape key
void	onAjax(org.apache.wicket.ajax.AjaxRequestTarget target, com.googlecode.wicket.jquery.core.JQueryEvent event)
void	onClick(org.apache.wicket.ajax.AjaxRequestTarget target, DialogButton button) Triggered when a button is clicked.
void	onClose(org.apache.wicket.ajax.AjaxRequestTarget target, DialogButton button) Triggered when the dialog closes.
void	onConfigure(org.apache.wicket.Component component)
void	open(org.apache.wicket.ajax.AjaxRequestTarget target) Opens the dialogs in ajax.

Methods inherited from class com.googlecode.wicket.jquery.ui.JQueryUIBehavior

destroy, onDestroy, widget, widget

Methods inherited from class com.googlecode.wicket.jquery.core.JQueryBehavior

$, $, $, $, beforeRender, detach, getMethod, getOption, getOptions, getSelector, on, on, on, remove, renderHead, setOption, setOption, setOption, setOptions, setSelector

Methods inherited from class com.googlecode.wicket.jquery.core.JQueryAbstractBehavior

add, getJQueryLibrarySettings, getToken, renderScript, toString

Methods inherited from class org.apache.wicket.behavior.Behavior

afterRender, canCallListenerInterface, detach, getStatelessHint, isEnabled, isTemporary, onComponentTag, onEvent, onException, onRemove, unbind

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

METHOD

public static final String METHOD

See Also:

Constant Field Values

Constructor Detail

DialogBehavior

public DialogBehavior(String selector)

Constructor

Parameters:

selector - the html selector (ie: "#myId")

DialogBehavior

public DialogBehavior(String selector,
              com.googlecode.wicket.jquery.core.Options options)

Constructor

Parameters:

selector - the html selector (ie: "#myId")

options - the Options

Method Detail

getButtons

protected abstract List<DialogButton> getButtons()

Gets the dialog's buttons.

Returns:

the List of Button

bind

public void bind(org.apache.wicket.Component component)

Overrides:

bind in class org.apache.wicket.behavior.Behavior

open

public void open(org.apache.wicket.ajax.AjaxRequestTarget target)

Opens the dialogs in ajax.

Parameters:

target - the AjaxRequestTarget

close

public void close(org.apache.wicket.ajax.AjaxRequestTarget target)

Closes the dialogs in ajax.

Parameters:

target - the AjaxRequestTarget

onConfigure

public void onConfigure(org.apache.wicket.Component component)

Overrides:

onConfigure in class JQueryUIBehavior

onAjax

public void onAjax(org.apache.wicket.ajax.AjaxRequestTarget target,
          com.googlecode.wicket.jquery.core.JQueryEvent event)

Specified by:

onAjax in interface com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware

newButtonAjaxBehavior

protected abstract ButtonAjaxBehavior newButtonAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source,
                                       DialogButton button)

Gets a new ButtonAjaxBehavior that will be called by the corresponding DialogButton.

Parameters:

source - the IJQueryAjaxAware source

button - the button that is passed to the behavior so it can be retrieved via the ButtonAjaxBehavior.ClickEvent

Returns:

the ButtonAjaxBehavior

newOnDefaultCloseAjaxBehavior

protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior newOnDefaultCloseAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source)

Gets a new JQueryAjaxBehavior that will be wired to the 'close' event, triggered when the user clicks on the X-icon

Parameters:

source - the IJQueryAjaxAware

Returns:

a new DialogBehavior.OnDefaultCloseAjaxBehavior by default

newOnEscapeCloseAjaxBehavior

protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior newOnEscapeCloseAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source)

Gets a new JQueryAjaxBehavior that will be wired to the 'beforeClose' event, triggered when the user presses the escape key

Parameters:

source - the IJQueryAjaxAware

Returns:

a new DialogBehavior.OnEscapeCloseAjaxBehavior by default

isDefaultCloseEventEnabled

public boolean isDefaultCloseEventEnabled()

Indicates whether the default close event (the click on the X-icon) is enabled If true, the onClose(AjaxRequestTarget, DialogButton) event will be triggered, with a null DialogButton

Returns:

false by default

isEscapeCloseEventEnabled

public boolean isEscapeCloseEventEnabled()

Indicates whether the escape close event (pressing escape key) is enabled If true, the onClose(AjaxRequestTarget, DialogButton) event will be triggered, with a null DialogButton

Returns:

false by default

onClick

public void onClick(org.apache.wicket.ajax.AjaxRequestTarget target,
           DialogButton button)

Triggered when a button is clicked. This method may be overridden to handle button behaviors, but the dialog will not been closed until super.onClick(event) or close(AjaxRequestTarget) is called.

Parameters:

target - the AjaxRequestTarget

button - the button that closed the dialog

onClose

public void onClose(org.apache.wicket.ajax.AjaxRequestTarget target,
           DialogButton button)

Triggered when the dialog closes.

Parameters:

target - the AjaxRequestTarget

button - the button that closed the dialog