com.github.gwtbootstrap.client.ui

Class TooltipCellDecorator<C>

java.lang.Object

com.github.gwtbootstrap.client.ui.TooltipCellDecorator<C>

Type Parameters:

C - Decorated Cell Parameter

All Implemented Interfaces:

HasPlacement, HasShowDelay, HasTrigger, IsAnimated, Cell<C>, HasText

public class TooltipCellDecorator<C>
extends Object
implements Cell<C>, IsAnimated, HasTrigger, HasPlacement, HasText, HasShowDelay

Cell decorator as a Tooltip.

Author:

ohashi keisuke

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gwt.cell.client.Cell

Cell.Context

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	animated Whether the widget is animated or not.
protected String	container Appends the popover to a specific element.
protected int	hideDelayInMilliseconds The delay until the widget is hidden.
protected Placement	placement The placement of the widget relative to its trigger element.
protected int	showDelayInMilliseconds The delay until the widget is shown.
protected Trigger	trigger The action that triggers the widget.

Constructor Summary

Constructors

Constructor and Description
TooltipCellDecorator(Cell<C> cell) Create Decorator cell

Method Summary

Methods

Modifier and Type	Method and Description
boolean	dependsOnSelection()
boolean	getAnimation() Gets whether the widget is animated.
protected boolean	getAnimation(Cell.Context context, C value)
Set<String>	getConsumedEvents()
String	getContainer()
int	getHideDelay() Gets the time to wait until the widget is hidden.
protected int	getHideDelay(Cell.Context context, C value)
Placement	getPlacement() Gets the widget's placement.
protected Placement	getPlacement(Cell.Context context, C value)
int	getShowDelay() Gets the time to wait until the widget is shown.
protected int	getShowDelay(Cell.Context context, C value)
String	getText()
protected String	getTooltipText(Cell.Context context, C value)
Trigger	getTrigger() Gets the widget's Trigger.
protected Trigger	getTrigger(Cell.Context context, C value)
boolean	handlesSelection()
boolean	isEditing(Cell.Context context, Element parent, C value)
void	onBrowserEvent(Cell.Context context, Element parent, C value, NativeEvent event, ValueUpdater<C> valueUpdater)
void	render(Cell.Context context, C value, SafeHtmlBuilder sb)
boolean	resetFocus(Cell.Context context, Element parent, C value)
void	setAnimation(boolean animated) Sets whether the Widget should be animated.
void	setContainer(String container) Set specific element the Popover/Tooltip is appended to
void	setHideDelay(int delayInMilliseconds) Sets the time to wait until the widget is hidden.
void	setPlacement(Placement placement) Sets the widget's placement.
void	setShowDelay(int delayInMilliseconds) Sets the time to wait until the widget is shown.
void	setText(String text)
void	setTrigger(Trigger trigger) Sets the trigger that activates the widget.
void	setValue(Cell.Context context, Element parent, C value)

Methods inherited from class java.lang.Object

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

Field Detail

animated

protected boolean animated

Whether the widget is animated or not.

placement

protected Placement placement

The placement of the widget relative to its trigger element.

trigger

protected Trigger trigger

The action that triggers the widget.

showDelayInMilliseconds

protected int showDelayInMilliseconds

The delay until the widget is shown.

hideDelayInMilliseconds

protected int hideDelayInMilliseconds

The delay until the widget is hidden.

container

protected String container

Appends the popover to a specific element.

Constructor Detail

TooltipCellDecorator

public TooltipCellDecorator(Cell<C> cell)

Create Decorator cell

Parameters:

cell - decorated cell

Method Detail

dependsOnSelection

public boolean dependsOnSelection()

Specified by:

dependsOnSelection in interface Cell<C>

getConsumedEvents

public Set<String> getConsumedEvents()

Specified by:

getConsumedEvents in interface Cell<C>

handlesSelection

public boolean handlesSelection()

Specified by:

handlesSelection in interface Cell<C>

isEditing

public boolean isEditing(Cell.Context context,
                Element parent,
                C value)

Specified by:

isEditing in interface Cell<C>

onBrowserEvent

public void onBrowserEvent(Cell.Context context,
                  Element parent,
                  C value,
                  NativeEvent event,
                  ValueUpdater<C> valueUpdater)

Specified by:

onBrowserEvent in interface Cell<C>

render

public void render(Cell.Context context,
          C value,
          SafeHtmlBuilder sb)

Specified by:

render in interface Cell<C>

resetFocus

public boolean resetFocus(Cell.Context context,
                 Element parent,
                 C value)

Specified by:

resetFocus in interface Cell<C>

setValue

public void setValue(Cell.Context context,
            Element parent,
            C value)

Specified by:

setValue in interface Cell<C>

setAnimation

public void setAnimation(boolean animated)

Sets whether the Widget should be animated.

Specified by:

setAnimation in interface IsAnimated

Parameters:

animated - true if the widget should be animated.

getAnimation

public boolean getAnimation()

Gets whether the widget is animated.

Specified by:

getAnimation in interface IsAnimated

Returns:

true if the widget is animated

getAnimation

protected boolean getAnimation(Cell.Context context,
                   C value)

setPlacement

public void setPlacement(Placement placement)

Sets the widget's placement. Relative to its trigger element.

Specified by:

setPlacement in interface HasPlacement

Parameters:

placement - the placement

getPlacement

public Placement getPlacement()

Gets the widget's placement.

Specified by:

getPlacement in interface HasPlacement

Returns:

the widget's placement

getPlacement

protected Placement getPlacement(Cell.Context context,
                     C value)

setTrigger

public void setTrigger(Trigger trigger)

Sets the trigger that activates the widget.

Specified by:

setTrigger in interface HasTrigger

Parameters:

trigger - the trigger

getTrigger

public Trigger getTrigger()

Gets the widget's Trigger.

Specified by:

getTrigger in interface HasTrigger

Returns:

the trigger

getTrigger

protected Trigger getTrigger(Cell.Context context,
                 C value)

setShowDelay

public void setShowDelay(int delayInMilliseconds)

Sets the time to wait until the widget is shown.

Specified by:

setShowDelay in interface HasShowDelay

Parameters:

delayInMilliseconds - the delay in milliseconds

getShowDelay

public int getShowDelay()

Gets the time to wait until the widget is shown.

Specified by:

getShowDelay in interface HasShowDelay

Returns:

the delay in milliseconds

getShowDelay

protected int getShowDelay(Cell.Context context,
               C value)

setHideDelay

public void setHideDelay(int delayInMilliseconds)

Sets the time to wait until the widget is hidden.

Specified by:

setHideDelay in interface HasShowDelay

Parameters:

delayInMilliseconds - the delay in milliseconds

getHideDelay

public int getHideDelay()

Gets the time to wait until the widget is hidden.

Specified by:

getHideDelay in interface HasShowDelay

Returns:

the delay in milliseconds

getHideDelay

protected int getHideDelay(Cell.Context context,
               C value)

getText

public String getText()

Specified by:

getText in interface HasText

setText

public void setText(String text)

Specified by:

setText in interface HasText

getTooltipText

protected String getTooltipText(Cell.Context context,
                    C value)

getContainer

public String getContainer()

Returns:

Specific element the Popover/Tooltip is appended to

setContainer

public void setContainer(String container)

Set specific element the Popover/Tooltip is appended to

Parameters:

container - Specific element the Popover/Tooltip is appended to. E.g. 'body' or null.