org.odlabs.wiquery.ui.button

Class ButtonBehavior

java.lang.Object

org.apache.wicket.behavior.AbstractBehavior

org.odlabs.wiquery.core.behavior.WiQueryAbstractBehavior

org.odlabs.wiquery.ui.button.ButtonBehavior

All Implemented Interfaces:

Serializable, org.apache.wicket.behavior.IBehavior, org.apache.wicket.behavior.IComponentConfigurationBehavior, org.apache.wicket.IClusterable, org.apache.wicket.markup.html.IHeaderContributor, IWiQueryPlugin

public class ButtonBehavior
extends WiQueryAbstractBehavior

$Id: ButtonBehavior.java 553 2010-11-15 08:30:58Z hielke.hoeve@gmail.com $

Creates a jQuery UI button behavior to decorate a link or a button HTML markup.

The click event is not a part of the jQuery UI framework

Since:

1.1

Author:

Julien Roche, Ernesto Reinaldo

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ButtonBehavior() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(org.apache.wicket.Component component)
void	contribute(WiQueryResourceManager wiQueryResourceManager) Declares resources (JavaScript and CSS files) to import.
JsStatement	destroy() Method to destroy the button This will return the element back to its pre-init state.
void	destroy(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget) Method to destroy the button within the ajax request
void	detach(org.apache.wicket.Component component)
JsStatement	disable() Method to disable the button
void	disable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget) Method to disable the button within the ajax request
JsStatement	enable() Method to enable the button
void	enable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget) Method to enable the button within the ajax request
ButtonIcon	getIcons()
String	getLabel()
protected Options	getOptions() Method retrieving the options of the component
Boolean	isDisabled()
boolean	isText()
void	onComponentTag(org.apache.wicket.Component component, org.apache.wicket.markup.ComponentTag tag)
ButtonBehavior	setDisabled(boolean disabled) Disables (true) or enables (false) the button.
ButtonBehavior	setIcons(ButtonIcon icons) Icons to display, with or without text (see text option).
ButtonBehavior	setIcons(UiIcon primary, UiIcon secondary) * Icons to display, with or without text (see text option).
ButtonBehavior	setLabel(org.apache.wicket.model.IModel<String> label) Text to show on the button.
ButtonBehavior	setLabel(String label) Text to show on the button.
ButtonBehavior	setText(boolean text) Whether to show any text - when set to false (display no text), icons (see icons option) must be enabled, otherwise it'll be ignored.
JsStatement	statement() Returns the main JsStatement used to create the plugin.
JsStatement	widget() Method to returns the .ui-autocomplete element
void	widget(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget) Method to returns the .ui-autocomplete element within the ajax request

Methods inherited from class org.odlabs.wiquery.core.behavior.WiQueryAbstractBehavior

getComponent

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

afterRender, beforeRender, cleanup, detachModel, exception, getStatelessHint, isEnabled, isTemporary, onConfigure, onException, onRendered, rendered, renderHead

Methods inherited from class java.lang.Object

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

Constructor Detail

ButtonBehavior

public ButtonBehavior()

Default constructor

Method Detail

bind

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

Specified by:

bind in interface org.apache.wicket.behavior.IBehavior

Overrides:

bind in class WiQueryAbstractBehavior

detach

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

Specified by:

detach in interface org.apache.wicket.behavior.IBehavior

Overrides:

detach in class org.apache.wicket.behavior.AbstractBehavior

contribute

public void contribute(WiQueryResourceManager wiQueryResourceManager)

Declares resources (JavaScript and CSS files) to import.

Specified by:

contribute in interface IWiQueryPlugin

Overrides:

contribute in class WiQueryAbstractBehavior

Parameters:

wiQueryResourceManager - The WiQueryResourceManager instance managing this component resources.

See Also:

WiQueryAbstractBehavior.contribute(org.odlabs.wiquery.core.commons.WiQueryResourceManager)

getOptions

protected Options getOptions()

Method retrieving the options of the component

Returns:

the options

onComponentTag

public void onComponentTag(org.apache.wicket.Component component,
                  org.apache.wicket.markup.ComponentTag tag)

Specified by:

onComponentTag in interface org.apache.wicket.behavior.IBehavior

Overrides:

onComponentTag in class org.apache.wicket.behavior.AbstractBehavior

See Also:

AbstractBehavior.onComponentTag(org.apache.wicket.Component, org.apache.wicket.markup.ComponentTag)

statement

public JsStatement statement()

Returns the main JsStatement used to create the plugin.

Specified by:

statement in interface IWiQueryPlugin

Specified by:

statement in class WiQueryAbstractBehavior

Returns:

The JsStatement corresponding to this component.

See Also:

WiQueryAbstractBehavior.statement()

setDisabled

public ButtonBehavior setDisabled(boolean disabled)

Disables (true) or enables (false) the button. Can be set when initialising (first creating) the button.

Parameters:

disabled -

Returns:

instance of the current behavior

isDisabled

public Boolean isDisabled()

Returns:

the disabled option

setText

public ButtonBehavior setText(boolean text)

Whether to show any text - when set to false (display no text), icons (see icons option) must be enabled, otherwise it'll be ignored.

Parameters:

text -

Returns:

the Button

isText

public boolean isText()

Returns:

the text option value

setIcons

public ButtonBehavior setIcons(ButtonIcon icons)

Icons to display, with or without text (see text option). The primary icon is displayed on the left of the label text, the secondary on the right. Value for the primary and secondary properties must be a classname (String), eg. "ui-icon-gear". For using only a primary icon: icons: {primary:'ui-icon-locked'}. For using both primary and secondary icon: icons: {primary:'ui-icon-gear',secondary:'ui-icon-triangle-1-s'}

Parameters:

icons -

Returns:

the button

setIcons

public ButtonBehavior setIcons(UiIcon primary,
                      UiIcon secondary)

* Icons to display, with or without text (see text option). The primary icon is displayed on the left of the label text, the secondary on the right. Value for the primary and secondary properties must be a classname (String), eg. "ui-icon-gear". For using only a primary icon: icons: {primary:'ui-icon-locked'}. For using both primary and secondary icon: icons: {primary:'ui-icon-gear',secondary:'ui-icon-triangle-1-s'}

Parameters:

primary - The primary icon (should be non-null)

secondary - The secondary icon (might be null).

Returns:

getIcons

public ButtonIcon getIcons()

Returns:

the icons value option

setLabel

public ButtonBehavior setLabel(String label)

Text to show on the button. When not specified (null), the element's html content is used, or its value attribute when it's an input element of type submit or reset; or the html content of the associated label element if its an input of type radio or checkbox

Parameters:

label -

Returns:

the button

setLabel

public ButtonBehavior setLabel(org.apache.wicket.model.IModel<String> label)

Text to show on the button. When not specified (null), the element's html content is used, or its value attribute when it's an input element of type submit or reset; or the html content of the associated label element if its an input of type radio or checkbox

Parameters:

label -

Returns:

the button

getLabel

public String getLabel()

Returns:

the label value option

destroy

public JsStatement destroy()

Method to destroy the button This will return the element back to its pre-init state.

Returns:

the associated JsStatement

destroy

public void destroy(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)

Method to destroy the button within the ajax request

Parameters:

ajaxRequestTarget -

disable

public JsStatement disable()

Method to disable the button

Returns:

the associated JsStatement

disable

public void disable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)

Method to disable the button within the ajax request

Parameters:

ajaxRequestTarget -

enable

public JsStatement enable()

Method to enable the button

Returns:

the associated JsStatement

enable

public void enable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)

Method to enable the button within the ajax request

Parameters:

ajaxRequestTarget -

widget

public JsStatement widget()

Method to returns the .ui-autocomplete element

Returns:

the associated JsStatement

widget

public void widget(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)

Method to returns the .ui-autocomplete element within the ajax request

Parameters:

ajaxRequestTarget -