de.agilecoders.wicket.markup.html.bootstrap.components

Class TooltipConfig

java.lang.Object

de.agilecoders.wicket.markup.html.bootstrap.common.AbstractConfig

de.agilecoders.wicket.markup.html.bootstrap.components.TooltipConfig

All Implemented Interfaces:

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

Direct Known Subclasses:

PopoverConfig

public class TooltipConfig
extends AbstractConfig

TooltipBehavior configuration

Author:

miha

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TooltipConfig.IPlacement interface for tooltip placement. can be used to inject functions.
static class	TooltipConfig.OpenTrigger all possible trigger for tooltip
static class	TooltipConfig.Placement holds all possible tooltip positions

Nested classes/interfaces inherited from class de.agilecoders.wicket.markup.html.bootstrap.common.AbstractConfig

AbstractConfig.IKey<T>

Constructor Summary

Constructors

Constructor and Description
TooltipConfig() Construct.

Method Summary

Methods

Modifier and Type	Method and Description
TooltipConfig	withAnimation(boolean value) apply a css fade transition to the tooltip
TooltipConfig	withContent(String value) default content value if `data-content` attribute isn't present
TooltipConfig	withDelay(org.apache.wicket.util.time.Duration value) delay showing and hiding the tooltip (ms) - does not apply to manual trigger type Not implemented: If a number is supplied, delay is applied to both hide/show Object structure is: delay: { show: 500, hide: 100 }
TooltipConfig	withHtml(boolean value) Insert html into the tooltip.
TooltipConfig	withPlacement(TooltipConfig.IPlacement value) how to position the tooltip - top | bottom | left | right
TooltipConfig	withSelector(String value) If a selector is provided, tooltip objects will be delegated to the specified targets.
TooltipConfig	withTitle(String value) default title value if `title` tag isn't present
TooltipConfig	withTrigger(TooltipConfig.OpenTrigger value) how tooltip is triggered - click | hover | focus | manual

Methods inherited from class de.agilecoders.wicket.markup.html.bootstrap.common.AbstractConfig

all, getString, isEmpty, newKey, put, remove, toJsonString, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

TooltipConfig

public TooltipConfig()

Construct.

Method Detail

withAnimation

public TooltipConfig withAnimation(boolean value)

apply a css fade transition to the tooltip

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withPlacement

public TooltipConfig withPlacement(TooltipConfig.IPlacement value)

how to position the tooltip - top | bottom | left | right

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withSelector

public TooltipConfig withSelector(String value)

If a selector is provided, tooltip objects will be delegated to the specified targets.

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withTitle

public TooltipConfig withTitle(String value)

default title value if `title` tag isn't present

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withContent

public TooltipConfig withContent(String value)

default content value if `data-content` attribute isn't present

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withTrigger

public TooltipConfig withTrigger(TooltipConfig.OpenTrigger value)

how tooltip is triggered - click | hover | focus | manual

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withDelay

public TooltipConfig withDelay(org.apache.wicket.util.time.Duration value)

delay showing and hiding the tooltip (ms) - does not apply to manual trigger type

Not implemented: If a number is supplied, delay is applied to both hide/show Object structure is: delay: { show: 500, hide: 100 }

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withHtml

public TooltipConfig withHtml(boolean value)

Insert html into the tooltip. If false, jquery's text method will be used to insert content into the dom. Use text if you're worried about XSS attacks.

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.