AbstractTooltip (GwtBootstrap3 0.9.4 API)

Object
- AbstractTooltip

All Implemented Interfaces:

AcceptsOneWidget, HasOneWidget, HasWidgets, IsWidget, Iterable<Widget>, HasHover, HasId

Direct Known Subclasses:

Popover, Tooltip
```
public abstract class AbstractTooltip
extends Object
implements IsWidget, HasWidgets, HasOneWidget, HasId, HasHover
```
Common implementation for the Bootstrap tooltip and popover.

Author:

Joshua Godi, Pontus Enmark, Steven Jardine

Nested Class Summary
- Nested classes/interfaces inherited from interface HasWidgets
  HasWidgets.ForIsWidget

Constructor Summary

Constructors
Constructor and Description
`AbstractTooltip(String dataTarget)` Creates the empty Tooltip
`AbstractTooltip(String dataTarget, String title)` Creates the tooltip with given title.
`AbstractTooltip(String dataTarget, Widget w)` Creates the tooltip around this widget
`AbstractTooltip(String dataTarget, Widget w, String title)` Creates the tooltip around this widget with given title

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`add(Widget child)`
`HandlerRegistration`	`addHiddenHandler(HiddenHandler hiddenHandler)` Adds a hidden handler to the Tooltip that will be fired when the Tooltip's hidden event is fired
`HandlerRegistration`	`addHideHandler(HideHandler hideHandler)` Adds a hide handler to the Tooltip that will be fired when the Tooltip's hide event is fired
`HandlerRegistration`	`addShowHandler(ShowHandler showHandler)` Adds a show handler to the Tooltip that will be fired when the Tooltip's show event is fired
`HandlerRegistration`	`addShownHandler(ShownHandler shownHandler)` Adds a shown handler to the Tooltip that will be fired when the Tooltip's shown event is fired
`void`	`addTooltipArrowClassName(String tooltipArrowClassName)` Add a tooltip arrow div class name
`void`	`addTooltipClassName(String tooltipClassName)` Add a tooltip div class name
`void`	`addTooltipInnerClassName(String tooltipInnerClassName)` Add a tooltip inner div class name
`Widget`	`asWidget()`
`protected void`	`bindJavaScriptEvents(Element e)`
`protected abstract void`	`call(String arg)`
`void`	`clear()`
`protected JavaScriptObject`	`createOptions(Element e, boolean animation, boolean html, String selector, String trigger, int showDelay, int hideDelay, String container, String template, String viewportSelector, int viewportPadding)` Create the options for the tooltip.
`void`	`destroy()` Force the Tooltip to be destroyed
`String`	`getAlternateTemplate()` Get the alternate template used to render the tooltip.
`String`	`getContainer()` Get where the hover will render it's HTML code
`int`	`getHideDelayMs()` Get the delay in MS to hide the hover component
`String`	`getId()` Gets the ID of the widget
`Placement`	`getPlacement()` Get the Placement of the hover component
`String`	`getSelector()` Get the tooltip's selector
`int`	`getShowDelayMs()` Get the delay in MS to show the hover component
`String`	`getTitle()` Gets the tooltip's display string
`String`	`getTooltipArrowClassNames()` Get the tooltip arrow div class names
`String`	`getTooltipClassNames()` Get the tooltip div class names
`String`	`getTooltipInnerClassNames()` Get the tooltip inner div class names
`Trigger`	`getTrigger()` Get the hover component's trigger
`int`	`getViewportPadding()`
`String`	`getViewportSelector()`
`Widget`	`getWidget()`
`void`	`hide()` Force hide the Tooltip
`abstract void`	`init()` Initializes the tooltip for use.
`boolean`	`isAnimated()` Get whether or not the hover widget will be animated
`boolean`	`isHtml()` Get whether or not the hover widget will render HTML
`boolean`	`isInitialized()`
`Iterator<Widget>`	`iterator()`
`protected void`	`onHidden(Event evt)` Can be override by subclasses to handle Tooltip's "hidden" event however it's recommended to add an event handler to the tooltip.
`protected void`	`onHide(Event evt)` Can be override by subclasses to handle Tooltip's "hide" event however it's recommended to add an event handler to the tooltip.
`protected void`	`onInserted(Event evt)` Can be override by subclasses to handle Tooltip's "inserted" event however it's recommended to add an event handler to the tooltip.
`protected void`	`onShow(Event evt)` Can be override by subclasses to handle Tooltip's "show" event however it's recommended to add an event handler to the tooltip.
`protected void`	`onShown(Event evt)` Can be override by subclasses to handle Tooltip's "shown" event however it's recommended to add an event handler to the tooltip.
`protected String`	`prepareTemplate()`
`void`	`reconfigure()` Deprecated. will be removed after the next release.
`void`	`recreate()` Recreate the tooltip/popover with a default dealy of 300ms between the call to destroy and init.
`void`	`recreate(int delay)` Recreate the tooltip/popover.
`boolean`	`remove(Widget w)`
`void`	`setAlternateTemplate(String alternateTemplate)` Set the alternate template used to render the tooltip.
`void`	`setContainer(String container)` Sets the custom container that the hover's HTML will render in
`void`	`setHideDelayMs(int hideDelayMs)` Set the delay in MS that the hover component takes to hide
`void`	`setHtml(SafeHtml html)` Sets the tooltip's display string in HTML format
`void`	`setId(String id)` Sets the ID on the widget
`void`	`setInitialized(boolean initialized)`
`void`	`setIsAnimated(boolean isAnimated)` Set whether or not to animate the displaying of the hover widget
`void`	`setIsHtml(boolean isHTML)` Set to make the hover widget display HTML code
`void`	`setPlacement(Placement placement)` Sets the placement of the hover component
`void`	`setSelector(String selector)` Set the tooltip's selector
`void`	`setShowDelayMs(int showDelayMs)` Set the delay in MS that the hover component takes to display
`void`	`setText(String text)` Deprecated. use `setTitle(String)`.
`void`	`setTitle(String title)` Sets the tooltip's display string
`void`	`setTooltipArrowClassNames(String tooltipArrowClassNames)` Set the tooltip arrow div class names
`void`	`setTooltipClassNames(String tooltipClassNames)` Set the tooltip div class names
`void`	`setTooltipInnerClassNames(String tooltipInnerClassNames)` Set the tooltip inner div class names
`void`	`setTrigger(Trigger trigger)` Set what will trigger the showing of the hover component
`void`	`setViewportPadding(int viewportPadding)`
`void`	`setViewportSelector(String viewportSelector)`
`void`	`setWidget(IsWidget w)`
`void`	`setWidget(Widget w)`
`void`	`show()` Force show the Tooltip
`void`	`toggle()` Toggle the Tooltip to either show/hide
`String`	`toString()`
`protected abstract void`	`updateTitleWhenShowing()` Update the title.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Iterable
forEach, spliterator

- Constructor Detail
  - AbstractTooltip
```
public AbstractTooltip(String dataTarget)
```
    Creates the empty Tooltip
  - AbstractTooltip
```
public AbstractTooltip(String dataTarget,
                       String title)
```
    Creates the tooltip with given title. Remember to set the widget as well
    
    Parameters:
    
    title - title for the tooltip
  - AbstractTooltip
```
public AbstractTooltip(String dataTarget,
                       Widget w)
```
    Creates the tooltip around this widget
    
    Parameters:
    
    w - widget for the tooltip
  - AbstractTooltip
```
public AbstractTooltip(String dataTarget,
                       Widget w,
                       String title)
```
    Creates the tooltip around this widget with given title
    
    Parameters:
    
    w - widget for the tooltip
    
    title - title for the tooltip
- Method Detail
  - add
```
public void add(Widget child)
```
    Specified by:
    
    add in interface HasWidgets
  - addHiddenHandler
```
public HandlerRegistration addHiddenHandler(HiddenHandler hiddenHandler)
```
    Adds a hidden handler to the Tooltip that will be fired when the Tooltip's hidden event is fired
    
    Parameters:
    
    hiddenHandler - HiddenHandler to handle the hidden event
    
    Returns:
    
    HandlerRegistration of the handler
  - addHideHandler
```
public HandlerRegistration addHideHandler(HideHandler hideHandler)
```
    Adds a hide handler to the Tooltip that will be fired when the Tooltip's hide event is fired
    
    Parameters:
    
    hideHandler - HideHandler to handle the hide event
    
    Returns:
    
    HandlerRegistration of the handler
  - addShowHandler
```
public HandlerRegistration addShowHandler(ShowHandler showHandler)
```
    Adds a show handler to the Tooltip that will be fired when the Tooltip's show event is fired
    
    Parameters:
    
    showHandler - ShowHandler to handle the show event
    
    Returns:
    
    HandlerRegistration of the handler
  - addShownHandler
```
public HandlerRegistration addShownHandler(ShownHandler shownHandler)
```
    Adds a shown handler to the Tooltip that will be fired when the Tooltip's shown event is fired
    
    Parameters:
    
    shownHandler - ShownHandler to handle the shown event
    
    Returns:
    
    HandlerRegistration of the handler
  - addTooltipArrowClassName
```
public void addTooltipArrowClassName(String tooltipArrowClassName)
```
    Add a tooltip arrow div class name
    
    Parameters:
    
    tooltipArrowClassName - a tooltip arrow div class name
  - addTooltipClassName
```
public void addTooltipClassName(String tooltipClassName)
```
    Add a tooltip div class name
    
    Parameters:
    
    tooltipClassName - a tooltip div class name
  - addTooltipInnerClassName
```
public void addTooltipInnerClassName(String tooltipInnerClassName)
```
    Add a tooltip inner div class name
    
    Parameters:
    
    tooltipInnerClassName - a tooltip inner div class name
  - asWidget
```
public Widget asWidget()
```
    Specified by:
    
    asWidget in interface IsWidget
  - bindJavaScriptEvents
```
protected void bindJavaScriptEvents(Element e)
```
  - call
```
protected abstract void call(String arg)
```
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface HasWidgets
  - createOptions
```
protected JavaScriptObject createOptions(Element e,
                                         boolean animation,
                                         boolean html,
                                         String selector,
                                         String trigger,
                                         int showDelay,
                                         int hideDelay,
                                         String container,
                                         String template,
                                         String viewportSelector,
                                         int viewportPadding)
```
    Create the options for the tooltip.
  - destroy
```
public void destroy()
```
    Force the Tooltip to be destroyed
  - getAlternateTemplate
```
public String getAlternateTemplate()
```
    Get the alternate template used to render the tooltip. If null, the default template will be used.
    
    Returns:
    
    String the alternate template used to render the tooltip
  - getContainer
```
public String getContainer()
```
    Get where the hover will render it's HTML code
    
    Specified by:
    
    getContainer in interface HasHover
    
    Returns:
    
    String selector where the hover renders to
  - getHideDelayMs
```
public int getHideDelayMs()
```
    Get the delay in MS to hide the hover component
    
    Specified by:
    
    getHideDelayMs in interface HasHover
    
    Returns:
    
    int delay in MS
  - getId
```
public String getId()
```
    Gets the ID of the widget
    
    Specified by:
    
    getId in interface HasId
    
    Returns:
    
    String widget ID
  - getPlacement
```
public Placement getPlacement()
```
    Get the Placement of the hover component
    
    Specified by:
    
    getPlacement in interface HasHover
    
    Returns:
    
    Placement of the hover component
  - getSelector
```
public String getSelector()
```
    Get the tooltip's selector
    
    Returns:
    
    String the tooltip's selector
  - getShowDelayMs
```
public int getShowDelayMs()
```
    Get the delay in MS to show the hover component
    
    Specified by:
    
    getShowDelayMs in interface HasHover
    
    Returns:
    
    int delay in MS
  - getTitle
```
public String getTitle()
```
    Gets the tooltip's display string
    
    Returns:
    
    String tooltip display string
  - getTooltipArrowClassNames
```
public String getTooltipArrowClassNames()
```
    Get the tooltip arrow div class names
    
    Returns:
    
    String Get the tooltip arrow div class names
  - getTooltipClassNames
```
public String getTooltipClassNames()
```
    Get the tooltip div class names
    
    Returns:
    
    String the tooltip div class names
  - getTooltipInnerClassNames
```
public String getTooltipInnerClassNames()
```
    Get the tooltip inner div class names
    
    Returns:
    
    String the tooltip inner div class names
  - getTrigger
```
public Trigger getTrigger()
```
    Get the hover component's trigger
    
    Specified by:
    
    getTrigger in interface HasHover
    
    Returns:
    
    Trigger how the hover component will show
  - getViewportPadding
```
public int getViewportPadding()
```
    Returns:
    
    the viewportPadding
  - getViewportSelector
```
public String getViewportSelector()
```
    Returns:
    
    the viewportSelector
  - getWidget
```
public Widget getWidget()
```
    Specified by:
    
    getWidget in interface HasOneWidget
  - hide
```
public void hide()
```
    Force hide the Tooltip
  - init
```
public abstract void init()
```
    Initializes the tooltip for use.
  - isAnimated
```
public boolean isAnimated()
```
    Get whether or not the hover widget will be animated
    
    Specified by:
    
    isAnimated in interface HasHover
    
    Returns:
    
    boolean true = animated, false = not animated
  - isHtml
```
public boolean isHtml()
```
    Get whether or not the hover widget will render HTML
    
    Specified by:
    
    isHtml in interface HasHover
    
    Returns:
    
    boolean true = render HTML, false = don't render HTML
  - isInitialized
```
public boolean isInitialized()
```
    Returns:
    
    the initialized
  - iterator
```
public Iterator<Widget> iterator()
```
    Specified by:
    
    iterator in interface HasWidgets
    
    Specified by:
    
    iterator in interface Iterable<Widget>
  - onHidden
```
protected void onHidden(Event evt)
```
    Can be override by subclasses to handle Tooltip's "hidden" event however it's recommended to add an event handler to the tooltip.
    
    Parameters:
    
    evt - Event
    
    See Also:
    
    HiddenEvent
  - onHide
```
protected void onHide(Event evt)
```
    Can be override by subclasses to handle Tooltip's "hide" event however it's recommended to add an event handler to the tooltip.
    
    Parameters:
    
    evt - Event
    
    See Also:
    
    HideEvent
  - onInserted
```
protected void onInserted(Event evt)
```
    Can be override by subclasses to handle Tooltip's "inserted" event however it's recommended to add an event handler to the tooltip.
    
    Parameters:
    
    evt - Event
    
    See Also:
    
    InsertedEvent
  - onShow
```
protected void onShow(Event evt)
```
    Can be override by subclasses to handle Tooltip's "show" event however it's recommended to add an event handler to the tooltip.
    
    Parameters:
    
    evt - Event
    
    See Also:
    
    ShowEvent
  - onShown
```
protected void onShown(Event evt)
```
    Can be override by subclasses to handle Tooltip's "shown" event however it's recommended to add an event handler to the tooltip.
    
    Parameters:
    
    evt - Event
    
    See Also:
    
    ShownEvent
  - prepareTemplate
```
protected String prepareTemplate()
```
  - reconfigure
```
public void reconfigure()
```
    Deprecated. will be removed after the next release.
    
    Reconfigures the tooltip.
  - recreate
```
public void recreate()
```
    Recreate the tooltip/popover with a default dealy of 300ms between the call to destroy and init.
  - recreate
```
public void recreate(int delay)
```
    Recreate the tooltip/popover. The delay is necessary because the destroy of the tooltip needs to be complete prior to calling init.
    
    Parameters:
    
    delay - the delay in ms between the call to destroy and init.
  - remove
```
public boolean remove(Widget w)
```
    Specified by:
    
    remove in interface HasWidgets
  - setAlternateTemplate
```
public void setAlternateTemplate(String alternateTemplate)
```
    Set the alternate template used to render the tooltip. The template should contain divs with classes 'tooltip', 'tooltip-inner', and 'tooltip-arrow'. If an alternate template is configured, the 'tooltipClassNames', 'tooltipArrowClassNames', and 'tooltipInnerClassNames' properties are not used.
    
    Parameters:
    
    alternateTemplate - the alternate template used to render the tooltip
  - setContainer
```
public void setContainer(String container)
```
    Sets the custom container that the hover's HTML will render in
    
    Specified by:
    
    setContainer in interface HasHover
    
    Parameters:
    
    container - String selector of where to render the hover's HTML code
  - setHideDelayMs
```
public void setHideDelayMs(int hideDelayMs)
```
    Set the delay in MS that the hover component takes to hide
    
    Specified by:
    
    setHideDelayMs in interface HasHover
    
    Parameters:
    
    hideDelayMs - int number of MS to delay the hide
  - setHtml
```
public void setHtml(SafeHtml html)
```
    Sets the tooltip's display string in HTML format
    
    Parameters:
    
    text - String display string in HTML format
  - setId
```
public void setId(String id)
```
    Sets the ID on the widget
    
    Specified by:
    
    setId in interface HasId
    
    Parameters:
    
    id - String desired ID
  - setInitialized
```
public void setInitialized(boolean initialized)
```
    Parameters:
    
    initialized - the initialized to set
  - setIsAnimated
```
public void setIsAnimated(boolean isAnimated)
```
    Set whether or not to animate the displaying of the hover widget
    
    Specified by:
    
    setIsAnimated in interface HasHover
    
    Parameters:
    
    isAnimated - boolean to animate or not
  - setIsHtml
```
public void setIsHtml(boolean isHTML)
```
    Set to make the hover widget display HTML code
    
    Specified by:
    
    setIsHtml in interface HasHover
    
    Parameters:
    
    isHTML - boolean to render HTML code or not
  - setPlacement
```
public void setPlacement(Placement placement)
```
    Sets the placement of the hover component
    
    Specified by:
    
    setPlacement in interface HasHover
    
    Parameters:
    
    placement - Placement of the hover component
  - setSelector
```
public void setSelector(String selector)
```
    Set the tooltip's selector
    
    Parameters:
    
    selector - the tooltip's selector
  - setShowDelayMs
```
public void setShowDelayMs(int showDelayMs)
```
    Set the delay in MS that the hover component takes to display
    
    Specified by:
    
    setShowDelayMs in interface HasHover
    
    Parameters:
    
    showDelayMs - int number of MS to delay the display
  - setText
```
public void setText(String text)
```
    Deprecated. use setTitle(String).
    
    Convenience method. Sets the tooltop's display string.
    
    Parameters:
    
    text - String display string.
  - setTitle
```
public void setTitle(String title)
```
    Sets the tooltip's display string
    
    Parameters:
    
    title - String display string
  - setTooltipArrowClassNames
```
public void setTooltipArrowClassNames(String tooltipArrowClassNames)
```
    Set the tooltip arrow div class names
    
    Parameters:
    
    tooltipArrowClassNames - the tooltip arrow div class names
  - setTooltipClassNames
```
public void setTooltipClassNames(String tooltipClassNames)
```
    Set the tooltip div class names
    
    Parameters:
    
    tooltipClassNames - the tooltip div class names
  - setTooltipInnerClassNames
```
public void setTooltipInnerClassNames(String tooltipInnerClassNames)
```
    Set the tooltip inner div class names
    
    Parameters:
    
    tooltipInnerClassNames - the tooltip inner div class names
  - setTrigger
```
public void setTrigger(Trigger trigger)
```
    Set what will trigger the showing of the hover component
    
    Specified by:
    
    setTrigger in interface HasHover
    
    Parameters:
    
    trigger - Trigger how the hover component will show
  - setViewportPadding
```
public void setViewportPadding(int viewportPadding)
```
    Parameters:
    
    viewportPadding - the viewportPadding to set
  - setViewportSelector
```
public void setViewportSelector(String viewportSelector)
```
    Parameters:
    
    viewportSelector - the viewportSelector to set
  - setWidget
```
public void setWidget(IsWidget w)
```
    Specified by:
    
    setWidget in interface AcceptsOneWidget
  - setWidget
```
public void setWidget(Widget w)
```
    Specified by:
    
    setWidget in interface HasOneWidget
  - show
```
public void show()
```
    Force show the Tooltip
  - toggle
```
public void toggle()
```
    Toggle the Tooltip to either show/hide
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - updateTitleWhenShowing
```
protected abstract void updateTitleWhenShowing()
```
    Update the title. This should only be called when the title is already showing. It causes a small flicker but updates the title immediately.

Class AbstractTooltip

Nested Class Summary

Nested classes/interfaces inherited from interface HasWidgets

Constructor Summary

Method Summary

Methods inherited from class Object

Methods inherited from interface Iterable

Constructor Detail

AbstractTooltip

AbstractTooltip

AbstractTooltip

AbstractTooltip

Method Detail

add

addHiddenHandler

addHideHandler

addShowHandler

addShownHandler

addTooltipArrowClassName

addTooltipClassName

addTooltipInnerClassName

asWidget

bindJavaScriptEvents

call

clear

createOptions

destroy

getAlternateTemplate

getContainer

getHideDelayMs

getId

getPlacement

getSelector

getShowDelayMs

getTitle

getTooltipArrowClassNames

getTooltipClassNames

getTooltipInnerClassNames

getTrigger

getViewportPadding

getViewportSelector

getWidget

hide

init

isAnimated

isHtml

isInitialized

iterator

onHidden

onHide

onInserted

onShow

onShown

prepareTemplate

reconfigure

recreate

recreate

remove

setAlternateTemplate

setContainer

setHideDelayMs

setHtml

setId

setInitialized

setIsAnimated

setIsHtml

setPlacement

setSelector

setShowDelayMs

setText

setTitle

setTooltipArrowClassNames

setTooltipClassNames

setTooltipInnerClassNames

setTrigger

setViewportPadding

setViewportSelector

setWidget

setWidget

show