de.agilecoders.wicket.util

Class JQuery

java.lang.Object

de.agilecoders.wicket.util.JQuery

All Implemented Interfaces:

Serializable, org.apache.wicket.util.io.IClusterable

public final class JQuery
extends Object
implements org.apache.wicket.util.io.IClusterable

The Jquery class helps to keep all javascript jquery scripts type safe.

Author:

miha

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JQuery.AbstractFunction A simple implementation of JQuery.IFunction that allows you to chain function parameters in a javascript safe way.
static class	JQuery.ConfigurableFunction a configurable function with one parameter (an AbstractConfig) and without body
static class	JQuery.EachJqueryFunction java abstraction of jquery each function
static interface	JQuery.IFunction simple interface to represent a jquery function.
static class	JQuery.JavaScriptInlineFunction simple class to represent a javascript function.
static class	JQuery.SimpleFunction a simple function without params and body

Method Summary

Methods

Modifier and Type	Method and Description
static JQuery	$(org.apache.wicket.Component component) helper method to allow a jquery like code style
static JQuery	$(org.apache.wicket.Component component, String... additionalSelector) helper method to allow a jquery like code style
static JQuery	$(String selector) helper method to allow a jquery like code style
org.apache.wicket.markup.head.OnDomReadyHeaderItem	asDomReadyScript()
JQuery	chain(JQuery.IFunction function) adds a chained function to this jquery instance
JQuery	chain(String functionName) adds a chained function to this jquery instance
JQuery	chain(String functionName, AbstractConfig config) adds a chained function to this jquery instance
String	get()

Methods inherited from class java.lang.Object

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

Method Detail

$

public static JQuery $(String selector)

helper method to allow a jquery like code style

Parameters:

selector - The jquery selector

Returns:

new Jquery instance

$

public static JQuery $(org.apache.wicket.Component component)

helper method to allow a jquery like code style

Parameters:

component - The markup id of given component is used as jquery selector

Returns:

new Jquery instance

$

public static JQuery $(org.apache.wicket.Component component,
       String... additionalSelector)

helper method to allow a jquery like code style

Parameters:

component - The markup id of given component is used as jquery selector

additionalSelector - an additional initial selector

Returns:

new Jquery instance

chain

public JQuery chain(JQuery.IFunction function)

adds a chained function to this jquery instance

Parameters:

function - the function to add

Returns:

this instance for chaining

chain

public JQuery chain(String functionName)

adds a chained function to this jquery instance

Parameters:

functionName - the function to add

Returns:

this instance for chaining

get

public String get()

Returns:

this jquery chain as string.

asDomReadyScript

public final org.apache.wicket.markup.head.OnDomReadyHeaderItem asDomReadyScript()

Returns:

this jquery script as OnDomReadyHeaderItem instance

chain

public JQuery chain(String functionName,
           AbstractConfig config)

adds a chained function to this jquery instance

Parameters:

functionName - the function to add

config - the function configuration

Returns:

this instance for chaining