Package 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, IComponentAwareEventSink, IComponentAwareHeaderContributor, 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	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	Description
static String	METHOD

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

method, options, selector

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	bind(Component component)
void	close(IPartialPageRequestHandler handler)	Closes the dialogs in ajax.
protected abstract List<DialogButton>	getButtons()	Gets the dialog's buttons.
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(AjaxRequestTarget target, com.googlecode.wicket.jquery.core.JQueryEvent event)
void	onConfigure(Component component)
void	open(IPartialPageRequestHandler handler)	Opens the dialogs in ajax.

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

destroy, onDestroy, widget, widget, widget, widget

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

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

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

add, getJQueryLibrarySettings, renderOnDomReadyScript, renderPriorityHeaderItem, toString

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

afterRender, canCallListener, detach, getStatelessHint, isEnabled, isTemporary, onAttribute, onComponentTag, onEvent, onException, onRemove, onTag, 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,
                      IDialogListener listener)

Constructor

Parameters:

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

listener - the IDialogListener

DialogBehavior

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

Constructor

Parameters:

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

options - the Options

listener - the IDialogListener

Method Detail

getButtons

protected abstract List<DialogButton> getButtons()

Gets the dialog's buttons.

Returns:

the List of Button

bind

public void bind(Component component)

Overrides:

bind in class Behavior

open

public void open(IPartialPageRequestHandler handler)

Opens the dialogs in ajax.

Parameters:

handler - the IPartialPageRequestHandler

close

public void close(IPartialPageRequestHandler handler)

Closes the dialogs in ajax.

Parameters:

handler - the IPartialPageRequestHandler

onConfigure

public void onConfigure(Component component)

Overrides:

onConfigure in class JQueryUIBehavior

onAjax

public void onAjax(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 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 OnEscapeCloseAjaxBehavior by default