org.wicketstuff.jwicket.tooltip

Class BeautyTips

java.lang.Object

org.apache.wicket.behavior.Behavior

org.wicketstuff.jwicket.tooltip.AbstractToolTip

org.wicketstuff.jwicket.tooltip.BeautyTips

All Implemented Interfaces:

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

public class BeautyTips
extends AbstractToolTip

This Class is a wrapper around the jQuery plugin BeautyTips

The implementation covers version 0.9.5 RC1 of BeautyTips together with jQuery 1.3.2.

Only a few options are controllable directly through Java methods until BeautyTips reaches 1.0 version. But you can control anything via setRawOptions(String).

For a detailed description of options, CSS styling and other thins have a look at the original documentation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BeautyTips(String tooltipText)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.wicket.markup.html.IComponentAwareHeaderContributor	getHeaderContributor()
String	getJavaScript()
void	renderHead(org.apache.wicket.Component component, org.apache.wicket.markup.head.IHeaderResponse response)
BeautyTips	setActiveClass(String activeClassName) Sets the CSS class for the Component that triggers the ToolTip.
BeautyTips	setCornerRadius(int radius) Sets the radius of the ToolTip box.
BeautyTips	setCssClass(String cssClassName) Sets the CSS class for the ToolTip content.
BeautyTips	setCssStyles(String cssStyles) Sets some CSS styles for the ToolTip content, e.g.
BeautyTips	setPadding(int paddingInPx) Sets the padding of the ToolTip's content in px.
BeautyTips	setRawOptions(String options) You can use this method to set special options not covered by other methods.
BeautyTips	setSpikeGirth(int width) Sets the width of the spike.
BeautyTips	setSpikeLength(int length) Sets the length of the spike.
BeautyTips	setSpikeOverlap(int overlap) Sets the overlap of the spike onto target.
BeautyTips	setTooltipText(String htmlCode) Set the content of the ToolTip.
BeautyTips	setWidth(int widthInPx) Sets the width of the ToolTip in px.

Methods inherited from class org.wicketstuff.jwicket.tooltip.AbstractToolTip

bind, getTooltipText, update

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

afterRender, beforeRender, canCallListenerInterface, detach, getStatelessHint, isEnabled, isTemporary, onComponentTag, onConfigure, onEvent, onException, onRemove, unbind

Methods inherited from class java.lang.Object

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

Constructor Detail

BeautyTips

public BeautyTips(String tooltipText)

Method Detail

renderHead

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

Specified by:

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

Overrides:

renderHead in class AbstractToolTip

getHeaderContributor

protected org.apache.wicket.markup.html.IComponentAwareHeaderContributor getHeaderContributor()

Specified by:

getHeaderContributor in class AbstractToolTip

setTooltipText

public BeautyTips setTooltipText(String htmlCode)

Set the content of the ToolTip. You can provide a simple text or complex HTML code.

Overrides:

setTooltipText in class AbstractToolTip

Parameters:

htmlCode - the content

getJavaScript

public String getJavaScript()

Specified by:

getJavaScript in class AbstractToolTip

setRawOptions

public BeautyTips setRawOptions(String options)

You can use this method to set special options not covered by other methods. The options must not start or end with "{" and "}".

Parameters:

options - the special options, e.g. "width:15px,trigger:['focus mouseover', 'blur mouseout']"

Returns:

this object

setWidth

public BeautyTips setWidth(int widthInPx)

Sets the width of the ToolTip in px. If the parameter widthInPx is <= 0 the width of the ToolTip is reset to the internal default.

Parameters:

widthInPx - The width of the ToolTip in px

Returns:

this object

setPadding

public BeautyTips setPadding(int paddingInPx)

Sets the padding of the ToolTip's content in px. If the parameter paddingInPx is < 0 the padding is reset to the internal default.

Parameters:

paddingInPx - The padding of the ToolTip's content of the ToolTip in px

Returns:

this object

setSpikeGirth

public BeautyTips setSpikeGirth(int width)

Sets the width of the spike. If the width < 0 then the width is reset to the internal default.

Parameters:

width - The width of the spike

Returns:

this object

setSpikeLength

public BeautyTips setSpikeLength(int length)

Sets the length of the spike. If the length < 0 then the length is reset to the internal default.

Parameters:

length - The length of the spike

Returns:

this object

setSpikeOverlap

public BeautyTips setSpikeOverlap(int overlap)

Sets the overlap of the spike onto target. If the overlap < 0 then the overlap is reset to the internal default.

Parameters:

overlap - The overlap of the spike onto target

Returns:

this object

setCornerRadius

public BeautyTips setCornerRadius(int radius)

Sets the radius of the ToolTip box. If the radius < 0 then the radius is reset to the internal default. If the radius = 0 then a square ToolTip box is displayed.

Parameters:

radius - The radius of the ToolTip box.

Returns:

this object

setCssClass

public BeautyTips setCssClass(String cssClassName)

Sets the CSS class for the ToolTip content.

Parameters:

cssClassName - the name of a CSS class

Returns:

this object

setCssStyles

public BeautyTips setCssStyles(String cssStyles)

Sets some CSS styles for the ToolTip content, e.g. "color: red, background-color: black"

Parameters:

cssStyles - the CSS styles

Returns:

this object

setActiveClass

public BeautyTips setActiveClass(String activeClassName)

Sets the CSS class for the Component that triggers the ToolTip.

Parameters:

activeClassName - the name of a CSS class

Returns:

this object