Package com.googlecode.wicket.jquery.core

Class JQueryBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

com.googlecode.wicket.jquery.core.JQueryAbstractBehavior

com.googlecode.wicket.jquery.core.JQueryBehavior

All Implemented Interfaces:

Serializable, IComponentAwareEventSink, IComponentAwareHeaderContributor, IClusterable

public class JQueryBehavior
extends JQueryAbstractBehavior

Provides a default implementation of JQueryAbstractBehavior.

Since:

1.0

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	method
protected Options	options
protected String	selector

Constructor Summary

Constructors

Constructor	Description
JQueryBehavior(String selector)	Constructor
JQueryBehavior(String selector, String method)	Constructor
JQueryBehavior(String selector, String method, Options options)	Constructor

Method Summary

Modifier and Type	Method	Description
protected String	$()	Gets the jQuery statement.
String	$(Options options)	Gets the jQuery statement. Warning: This method is *not* called by the behavior directly (only $() is).
String	$(Object... options)	Gets the jQuery statement. Warning: This method is *not* called by the behavior directly (only $() is).
String	$(String options)	Gets the jQuery statement. Warning: This method is *not* called by the behavior directly (only $() is).
void	beforeRender(Component component)	Also, beforeRender(Component) will call IJQueryWidget.onBeforeRender(JQueryBehavior) (if the component IS-A IJQueryWidget) If a property is set in beforeRender(Component) and is needed in IJQueryWidget.onBeforeRender(JQueryBehavior), super.beforeRender(component) should be the last statement.
void	detach(IPartialPageRequestHandler handler)	Removes the element matching the current selector from the DOM. The #detach method is the same as #remove, except that #detach keeps all jQuery data associated with the removed elements. This method is useful when removed elements are to be reinserted into the DOM at a later time.
String	getMethod()	Gets the jQuery method
<T> T	getOption(String key)	Gets a behavior option, referenced by its key
Options	getOptions()	Gets the Options
String	getSelector()	Gets the selector
protected void	off(String selector, String event)	Unregisters a jQuery event callback
protected void	on(String event, String callback)	Registers a jQuery event callback
protected void	on(String selector, String event, String callback)	Registers a jQuery event callback
void	onConfigure(Component component)	Also, onConfigure(Component) will call IJQueryWidget.onConfigure(JQueryBehavior) (if the component IS-A IJQueryWidget) If a property is set in onConfigure(Component) and is needed in IJQueryWidget.onConfigure(JQueryBehavior), super.onConfigure(component) should be the last statement.
protected void	register(String statement)	Registers a jQuery event statement
void	remove(IPartialPageRequestHandler handler)	Removes the element matching the current selector from the DOM. Use #remove when you want to remove the element itself, as well as everything inside it. In addition to the elements themselves, all bound events and jQuery data associated with the elements are removed. To remove the elements without removing data and events, use #detach instead.
void	renderHead(Component component, IHeaderResponse response)
JQueryBehavior	setOption(String key, Object value)	Sets a behavior option.
JQueryBehavior	setOption(String key, Object... values)	Sets a behavior option, with multiple values.
JQueryBehavior	setOption(String key, List<?> values)	Sets a behavior option, with multiple values.
void	setOptions(Options options)	Adds or replace behavior options
protected void	setSelector(String selector)	Sets the selector

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, bind, 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

selector

protected String selector

method

protected final String method

options

protected final Options options

Constructor Detail

JQueryBehavior

public JQueryBehavior(String selector)

Constructor

Parameters:

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

JQueryBehavior

public JQueryBehavior(String selector,
                      String method)

Constructor

Parameters:

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

method - the jquery method

JQueryBehavior

public JQueryBehavior(String selector,
                      String method,
                      Options options)

Constructor

Parameters:

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

method - the jquery method

options - the Options

Method Detail

renderHead

public void renderHead(Component component,
                       IHeaderResponse response)

Specified by:

renderHead in interface IComponentAwareHeaderContributor

Overrides:

renderHead in class JQueryAbstractBehavior

detach

public void detach(IPartialPageRequestHandler handler)

Removes the element matching the current selector from the DOM.
The #detach method is the same as #remove, except that #detach keeps all jQuery data associated with the removed elements.
This method is useful when removed elements are to be reinserted into the DOM at a later time.

Parameters:

handler - the IPartialPageRequestHandler

See Also:

remove(IPartialPageRequestHandler)

remove

public void remove(IPartialPageRequestHandler handler)

Removes the element matching the current selector from the DOM.
Use #remove when you want to remove the element itself, as well as everything inside it.
In addition to the elements themselves, all bound events and jQuery data associated with the elements are removed.
To remove the elements without removing data and events, use #detach instead.

Parameters:

handler - the IPartialPageRequestHandler

See Also:

detach(IPartialPageRequestHandler)

getSelector

public String getSelector()

Gets the selector

Returns:

the selector

setSelector

protected void setSelector(String selector)

Sets the selector

Parameters:

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

getMethod

public String getMethod()

Gets the jQuery method

Returns:

the method

getOption

public <T> T getOption(String key)

Gets a behavior option, referenced by its key

Type Parameters:

T - the object type

Parameters:

key - the option key

Returns:

null if the key does not exists

setOption

public JQueryBehavior setOption(String key,
                                Object value)

Sets a behavior option.

Parameters:

key - the option key

value - the option value

Returns:

the JQueryBehavior (this)

setOption

public JQueryBehavior setOption(String key,
                                Object... values)

Sets a behavior option, with multiple values.

Parameters:

key - the option key

values - the option values

Returns:

the JQueryBehavior (this)

setOption

public JQueryBehavior setOption(String key,
                                List<?> values)

Sets a behavior option, with multiple values.

Parameters:

key - the option key

values - the option values

Returns:

the JQueryBehavior (this)

getOptions

public Options getOptions()

Gets the Options

Returns:

the Options

setOptions

public void setOptions(Options options)

Adds or replace behavior options

Parameters:

options - the Options

on

protected void on(String event,
                  String callback)

Registers a jQuery event callback

Parameters:

event - the jQuery event (ie: "click")

callback - the jQuery callback

on

protected void on(String selector,
                  String event,
                  String callback)

Registers a jQuery event callback

Parameters:

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

event - the jQuery event (ie: "click")

callback - the jQuery callback

off

protected void off(String selector,
                   String event)

Unregisters a jQuery event callback

Parameters:

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

event - the jQuery event (ie: "click")

register

protected void register(String statement)

Registers a jQuery event statement

Parameters:

statement - the jQuery statement (ie: "jQuery('#myId').on('click', function() {});")

$

protected String $()

Description copied from class: JQueryAbstractBehavior

Gets the jQuery statement.

Specified by:

$ in class JQueryAbstractBehavior

Returns:

the jQuery statement

$

public String $(String options)

Gets the jQuery statement.
Warning: This method is *not* called by the behavior directly (only $() is).

Parameters:

options - the options to be supplied to the current method

Returns:

the jQuery statement

$

public String $(Options options)

Gets the jQuery statement.
Warning: This method is *not* called by the behavior directly (only $() is).

Parameters:

options - the Options to be supplied to the current method

Returns:

the jQuery statement

$

public String $(Object... options)

Gets the jQuery statement.
Warning: This method is *not* called by the behavior directly (only $() is).

Parameters:

options - the list of options to be supplied to the current method

Returns:

the jQuery statement

onConfigure

public void onConfigure(Component component)

Also, onConfigure(Component) will call IJQueryWidget.onConfigure(JQueryBehavior) (if the component IS-A IJQueryWidget)
If a property is set in onConfigure(Component) and is needed in IJQueryWidget.onConfigure(JQueryBehavior), super.onConfigure(component) should be the last statement.

Overrides:

onConfigure in class Behavior

beforeRender

public void beforeRender(Component component)

Also, beforeRender(Component) will call IJQueryWidget.onBeforeRender(JQueryBehavior) (if the component IS-A IJQueryWidget)
If a property is set in beforeRender(Component) and is needed in IJQueryWidget.onBeforeRender(JQueryBehavior), super.beforeRender(component) should be the last statement.

Overrides:

beforeRender in class Behavior