org.wicketstuff.jwicket.ui.tooltip

Class JQueryUiTooltip

java.lang.Object

org.apache.wicket.behavior.Behavior

org.apache.wicket.behavior.AbstractAjaxBehavior

org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

org.wicketstuff.jwicket.JQueryAjaxBehavior

org.wicketstuff.jwicket.JQueryDurableAjaxBehavior

org.wicketstuff.jwicket.ui.tooltip.JQueryUiTooltip

All Implemented Interfaces:

Serializable, org.apache.wicket.behavior.IBehaviorListener, org.apache.wicket.IComponentAwareEventSink, org.apache.wicket.IRequestListener, org.apache.wicket.markup.html.IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable

public class JQueryUiTooltip
extends JQueryDurableAjaxBehavior

This is an integration of the jQuery UI tooltip widget. You can add it to a Wicket Component to give it a jQuery UI tooltip. This Behavior will generate the tooltip JavaScript.

adf

Default selector: the component's markup id

Default tooltip content: value(s) of the title attribute(s) or the data-tolltip attribute(s) dynamically obtained by a JS function

You can use custom CSS through ResourceReferences. If no user ResourceReference for CSS is provided a default style will be used.

An instance of this class can be added to one and only one Component. Another Component that should have exactly the same behavior needs it's own instance.

Author:

Martin Knopf

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.wicketstuff.jwicket.JQueryAjaxBehavior

JQueryAjaxBehavior.JsAjaxCallbackFunction, JQueryAjaxBehavior.JsBuilder, JQueryAjaxBehavior.JsFunction

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.wicket.request.resource.CssResourceReference	uiTooltipCss_1_10_3
static JQueryResourceReference	uiTooltipJs_1_10_3

Fields inherited from class org.wicketstuff.jwicket.JQueryDurableAjaxBehavior

rendered

Fields inherited from class org.wicketstuff.jwicket.JQueryAjaxBehavior

rawOptions

Fields inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

INDICATOR

Fields inherited from interface org.apache.wicket.behavior.IBehaviorListener

INTERFACE

Constructor Summary

Constructors

Modifier	Constructor and Description
	JQueryUiTooltip(JQueryResourceReference customJQueryUiTooltipJs)
protected	JQueryUiTooltip(JQueryUiWidget widget) Constructor for testing.
	JQueryUiTooltip(String componentSelector, JQueryResourceReference customJQueryUiTooltipJs)

Method Summary

Methods

Modifier and Type	Method and Description
JQueryUiTooltip	addCssResource(org.apache.wicket.request.resource.ResourceReference cssResourceReference) Adds the given CSS ResourceReference to the response for custom tooltip styling.
protected JQueryAjaxBehavior.JsBuilder	getJsBuilder()
void	renderHead(org.apache.wicket.Component component, org.apache.wicket.markup.head.IHeaderResponse response) Do not override this method unless you know exactly what you do.
JQueryUiTooltip	setContent(org.apache.wicket.Component content) Sets the content option of the tooltip widget like this: content:$('#markupIdOfGivenComponent').html().
JQueryUiTooltip	setContent(JQueryAjaxBehavior.JsFunction content) Sets the content option of the tooltip widget like this: content:function(){return 'tooltip content';}.
JQueryUiTooltip	setContent(String content) Sets the content option of the tooltip widget like this: {@code content: '
JQueryUiTooltip	setDisabled(boolean disabled) Sets the disabled option of the tooltip widget like this: disabled:true.
JQueryUiTooltip	setHide(Boolean hide) Sets the hide option of the tooltip widget.
JQueryUiTooltip	setHide(int hide) Sets the hide option of the tooltip widget.
JQueryUiTooltip	setHide(JsOption... options) Sets the hide option of the tooltip widget.
JQueryUiTooltip	setHide(String hide) Sets the hide option of the tooltip widget.
JQueryUiTooltip	setItems(String itemsSelector) Sets the items option of the tooltip widget like this: items:'.element'.
JQueryUiTooltip	setOnClose(String close) Sets the close event handler of the tooltip widget like this: close:function(event,ui){some code;}.
JQueryUiTooltip	setOnCreate(String create) Sets the create event handler of the tooltip widget like this: create:function(event,ui){some code;}.
JQueryUiTooltip	setOnOpen(String open) Sets the open event handler of the tooltip widget like this: open:function(event,ui){some code;}.
JQueryUiTooltip	setPosition(JsOption... options) Sets the position option of the tooltip widget like this: position:{my:'center'}.
JQueryUiTooltip	setShow(Boolean show) Sets the show option of the tooltip widget.
JQueryUiTooltip	setShow(int show) Sets the show option of the tooltip widget.
JQueryUiTooltip	setShow(JsOption... options) Sets the show option of the tooltip widget.
JQueryUiTooltip	setShow(String show) Sets the show option of the tooltip widget.
JQueryUiTooltip	setTooltipClass(String tooltipClass) Sets the tooltipClass option of the tooltip widget which will be rendered like this: tooltipClass:'className'.
JQueryUiTooltip	setTrack(boolean track) Sets the track option of the tooltip widget like this: track:true .
static JQueryUiTooltip	tooltip_1_10_3() Factory method.
static JQueryUiTooltip	tooltip_1_10_3(String componentSelector) Factory method.
JQueryUiTooltip	withoutCss() Turns of adding any jQuery UI CSS to the response (even the default one).

Methods inherited from class org.wicketstuff.jwicket.JQueryDurableAjaxBehavior

isAlreadyRendered, setRestoreAfterRedraw, updateBehavior

Methods inherited from class org.wicketstuff.jwicket.JQueryAjaxBehavior

addCssResources, addUserProvidedResourceReferences, addUserProvidedResourceReferences, getUserProvidedResourceReferences, printParameters, printParameters, respond, setRawOptions

Methods inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

findIndicatorId, getAttributes, getCallbackFunction, getCallbackFunctionBody, getCallbackScript, getCallbackScript, onBind, onRequest, postprocessConfiguration, renderAjaxAttributes, renderAjaxAttributes, updateAjaxAttributes

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

afterRender, bind, getCallbackUrl, getComponent, onComponentRendered, onComponentTag, onComponentTag, onUnbind, unbind

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

beforeRender, canCallListenerInterface, detach, getStatelessHint, isEnabled, isTemporary, onConfigure, onEvent, onException, onRemove

Methods inherited from class java.lang.Object

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

Field Detail

uiTooltipJs_1_10_3

public static final JQueryResourceReference uiTooltipJs_1_10_3

uiTooltipCss_1_10_3

public static final org.apache.wicket.request.resource.CssResourceReference uiTooltipCss_1_10_3

Constructor Detail

JQueryUiTooltip

public JQueryUiTooltip(JQueryResourceReference customJQueryUiTooltipJs)

Parameters:

customJQueryUiTooltipJs - a JQueryResourceReference which should provide all jQuery UI libraries needed to use the jQuery UI tooltip widget

JQueryUiTooltip

public JQueryUiTooltip(String componentSelector,
               JQueryResourceReference customJQueryUiTooltipJs)

Parameters:

componentSelector - the selector which will be used by jQuery to add the tooltip(s)

customJQueryUiTooltipJs - a JQueryResourceReference which should provide all jQuery UI libraries needed to use the jQuery UI tooltip widget

JQueryUiTooltip

protected JQueryUiTooltip(JQueryUiWidget widget)

Constructor for testing.

Parameters:

widget -

Method Detail

tooltip_1_10_3

public static JQueryUiTooltip tooltip_1_10_3()

Factory method.

Returns:

a new instance of JQueryUiTooltip using jQuery UI 1.10.3

tooltip_1_10_3

public static JQueryUiTooltip tooltip_1_10_3(String componentSelector)

Factory method.

Parameters:

componentSelector - the selector which will be used by jQuery to add the tooltip(s)

Returns:

a new instance of JQueryUiTooltip using jQuery UI 1.10.3

renderHead

public void renderHead(org.apache.wicket.Component component,
              org.apache.wicket.markup.head.IHeaderResponse response)

Description copied from class: JQueryDurableAjaxBehavior

Do not override this method unless you know exactly what you do. It is an internal method that handles the rendering of the JavaScript stuff for the behavior.

If you need to override this method, you must call super.renderHead(response).

Specified by:

renderHead in interface org.apache.wicket.markup.html.IComponentAwareHeaderContributor

Overrides:

renderHead in class JQueryDurableAjaxBehavior

getJsBuilder

protected JQueryAjaxBehavior.JsBuilder getJsBuilder()

Specified by:

getJsBuilder in class JQueryDurableAjaxBehavior

addCssResource

public JQueryUiTooltip addCssResource(org.apache.wicket.request.resource.ResourceReference cssResourceReference)

Adds the given CSS ResourceReference to the response for custom tooltip styling. If no user ResourceReference is provided a default style will be used.

Parameters:

cssResourceReference -

Returns:

withoutCss

public JQueryUiTooltip withoutCss()

Turns of adding any jQuery UI CSS to the response (even the default one).

Returns:

setContent

public JQueryUiTooltip setContent(String content)

Sets the content option of the tooltip widget like this: content: '<h1>tooltip content</h1>'.

Note: The content option has to stay in sync with the items option (see http://api.jqueryui.com/tooltip/#option-content).

Parameters:

content - a String containing the content of this tooltip (e.g. <h1>tooltip content</h1>)

Returns:

setContent

public JQueryUiTooltip setContent(JQueryAjaxBehavior.JsFunction content)

Sets the content option of the tooltip widget like this: content:function(){return 'tooltip content';}.

Note: The content option has to stay in sync with the items option (see http://api.jqueryui.com/tooltip/#option-content).

Parameters:

content - a JsFunction containing a JavaScript function which returns the content of this tooltip (e.g. new JsFunction("function(){return 'tooltip content';}"))

Returns:

setContent

public JQueryUiTooltip setContent(org.apache.wicket.Component content)

Sets the content option of the tooltip widget like this: content:$('#markupIdOfGivenComponent').html().

Note: The content option has to stay in sync with the items option (see http://api.jqueryui.com/tooltip/#option-content).

Parameters:

content - the Component whose markup will be used as the content of this tooltip

Returns:

setDisabled

public JQueryUiTooltip setDisabled(boolean disabled)

Sets the disabled option of the tooltip widget like this: disabled:true.

Parameters:

disabled - a boolean containing the disabled option of this tooltip

Returns:

setHide

public JQueryUiTooltip setHide(Boolean hide)

Sets the hide option of the tooltip widget.

Parameters:

hide - see http://api.jqueryui.com/tooltip/#option-hide

Returns:

setHide

public JQueryUiTooltip setHide(int hide)

Sets the hide option of the tooltip widget.

Parameters:

hide - see http://api.jqueryui.com/tooltip/#option-hide

Returns:

setHide

public JQueryUiTooltip setHide(String hide)

Sets the hide option of the tooltip widget.

Parameters:

hide - see http://api.jqueryui.com/tooltip/#option-hide

Returns:

setHide

public JQueryUiTooltip setHide(JsOption... options)

Sets the hide option of the tooltip widget.

Parameters:

options - see http://api.jqueryui.com/tooltip/#option-hide

Returns:

setItems

public JQueryUiTooltip setItems(String itemsSelector)

Sets the items option of the tooltip widget like this: items:'.element'.

Note: The items option has to stay in sync with the content option (see http://api.jqueryui.com/tooltip/#option-items).

Parameters:

itemsSelector - a String containing the selector(s) of the element(s) this tooltip should be applied to (e.g. .element)

Returns:

setPosition

public JQueryUiTooltip setPosition(JsOption... options)

Sets the position option of the tooltip widget like this: position:{my:'center'}.

Parameters:

position - a String containing the position object of this tooltip (e.g. {my:'center'})

Returns:

setShow

public JQueryUiTooltip setShow(Boolean show)

Sets the show option of the tooltip widget.

Parameters:

show - see http://api.jqueryui.com/tooltip/#option-show

Returns:

setShow

public JQueryUiTooltip setShow(int show)

Sets the show option of the tooltip widget.

Parameters:

show - see http://api.jqueryui.com/tooltip/#option-show

Returns:

setShow

public JQueryUiTooltip setShow(String show)

Sets the show option of the tooltip widget.

Parameters:

show - see http://api.jqueryui.com/tooltip/#option-show

Returns:

setShow

public JQueryUiTooltip setShow(JsOption... options)

Sets the show option of the tooltip widget.

Parameters:

options - see http://api.jqueryui.com/tooltip/#option-show

Returns:

setTooltipClass

public JQueryUiTooltip setTooltipClass(String tooltipClass)

Sets the tooltipClass option of the tooltip widget which will be rendered like this: tooltipClass:'className'.

Parameters:

tooltipClass - a String containing the tooltipClass option of this tooltip (e.g. className)

Returns:

setTrack

public JQueryUiTooltip setTrack(boolean track)

Sets the track option of the tooltip widget like this: track:true .

Parameters:

track - a boolean containing the track option of this tooltip

Returns:

setOnClose

public JQueryUiTooltip setOnClose(String close)

Sets the close event handler of the tooltip widget like this: close:function(event,ui){some code;}.

Parameters:

close - a String containing the close event handler of this tooltip (e.g. function(event,ui){some code;}.)

Returns:

setOnCreate

public JQueryUiTooltip setOnCreate(String create)

Sets the create event handler of the tooltip widget like this: create:function(event,ui){some code;}.

Parameters:

create - a String containing the create event handler of this tooltip (e.g. function(event,ui){some code;}.)

Returns:

setOnOpen

public JQueryUiTooltip setOnOpen(String open)

Sets the open event handler of the tooltip widget like this: open:function(event,ui){some code;}.

Parameters:

open - a String containing the open event handler of this tooltip (e.g. function(event,ui){some code;}.)

Returns: