com.github.gwtbootstrap.client.ui.base

Class HoverBase

java.lang.Object

com.github.gwtbootstrap.client.ui.base.MarkupWidget

com.github.gwtbootstrap.client.ui.base.HoverBase

All Implemented Interfaces:

HasId, HasPlacement, HasShowDelay, HasTrigger, HasVisibility, IsAnimated, AcceptsOneWidget, HasOneWidget, HasText, HasWidgets, IsWidget, Iterable<Widget>

Direct Known Subclasses:

Popover, Tooltip

public abstract class HoverBase
extends MarkupWidget
implements IsWidget, HasWidgets, HasOneWidget, IsAnimated, HasTrigger, HasPlacement, HasText, HasShowDelay, HasVisibility

Base class for widgets that hover above other widgets.

Since:

2.0.4.0

Author:

Dominik Mayer

See Also:

Bootstrap documentation

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

HasWidgets.ForIsWidget

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.

Fields inherited from class com.github.gwtbootstrap.client.ui.base.MarkupWidget

widget

Constructor Summary

Constructors

Constructor and Description
HoverBase() Creates a new widget based on the provided HTML tag.

Method Summary

Methods

Modifier and Type	Method and Description
Widget	asWidget()
protected abstract void	changeVisibility(VisibilityChange visibilityChange) Changes the visibility of the widget.
boolean	getAnimation() Gets whether the widget is animated.
String	getContainer()
protected abstract String	getDataName() Get data name of JS Data API.
int	getHideDelay() Gets the time to wait until the widget is hidden.
Placement	getPlacement() Gets the widget's placement.
int	getShowDelay() Gets the time to wait until the widget is shown.
Trigger	getTrigger() Gets the widget's Trigger.
void	hide() Hides the widget if it was previously shown.
abstract void	reconfigure() Redraws the widget with the currently set options.
protected void	removeDataIfExists()
protected abstract void	removeDataIfExists(Element e, String dataName)
void	setAnimation(boolean animated) Sets whether the Widget should be animated.
void	setContainer(String container) Set specific element the Popover/Tooltip is appended to
protected void	setDataAttribute(Element e, String attribute, String value) Adds an HTML data attribute to the widget's tag.
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	setTrigger(Trigger trigger) Sets the trigger that activates the widget.
void	show() Shows the widget if it was previously hidden.
void	toggle() Toggles the view state of the widget.

Methods inherited from class com.github.gwtbootstrap.client.ui.base.MarkupWidget

add, add, clear, getId, getWidget, iterator, remove, setId, setWidget, setWidget

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.user.client.ui.HasWidgets

add, clear, iterator, remove

Methods inherited from interface com.google.gwt.user.client.ui.HasOneWidget

getWidget, setWidget

Methods inherited from interface com.google.gwt.user.client.ui.AcceptsOneWidget

setWidget

Methods inherited from interface com.google.gwt.user.client.ui.HasText

getText, setText

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

HoverBase

public HoverBase()

Creates a new widget based on the provided HTML tag.

Method Detail

asWidget

public Widget asWidget()

Specified by:

asWidget in interface IsWidget

Overrides:

asWidget in class MarkupWidget

removeDataIfExists

protected void removeDataIfExists()

removeDataIfExists

protected abstract void removeDataIfExists(Element e,
                      String dataName)

setDataAttribute

protected void setDataAttribute(Element e,
                    String attribute,
                    String value)

Adds an HTML data attribute to the widget's tag.

Parameters:

e - target element

attribute - the name of the attribute without leading "data-"

value - the value to be stored

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.

reconfigure

public abstract void reconfigure()

Redraws the widget with the currently set options. This must not be called when a parameter is updated because it would deactivate all other parameters. No idea why...

getAnimation

public boolean getAnimation()

Gets whether the widget is animated.

Specified by:

getAnimation in interface IsAnimated

Returns:

true if the widget is animated

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

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

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

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

show

public void show()

Shows the widget if it was previously hidden.

Specified by:

show in interface HasVisibility

hide

public void hide()

Hides the widget if it was previously shown.

Specified by:

hide in interface HasVisibility

toggle

public void toggle()

Toggles the view state of the widget.

It will be hidden if it was previously shown and shown if it was previously hidden.

Specified by:

toggle in interface HasVisibility

changeVisibility

protected abstract void changeVisibility(VisibilityChange visibilityChange)

Changes the visibility of the widget.

Parameters:

visibilityChange - the action to be performed

getDataName

protected abstract String getDataName()

Get data name of JS Data API.

Returns:

data name

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.