ToolTipConfig (GXT 3.1.4)

java.lang.Object
- com.sencha.gxt.widget.core.client.tips.ToolTipConfig

All Implemented Interfaces:

HasUiAttributes

Direct Known Subclasses:

AxisToolTipConfig, LegendToolTipConfig, SeriesToolTipConfig
```
public class ToolTipConfig
extends Object
implements HasUiAttributes
```
Configuration information for a tool tip.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ToolTipConfig.ToolTipRenderer<T>

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ToolTipConfig.ToolTipRenderer<T>`

Constructor Summary

Constructors
Constructor and Description
`ToolTipConfig()` Creates a new tool tip config.
`ToolTipConfig(SafeHtml title, SafeHtml html)` Creates a new tool tip config with the given title and text.
`ToolTipConfig(String text)` Creates a new tool tip config with the given text.
`ToolTipConfig(String title, String text)` Creates a new tool tip config with the given title and text.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Style.Side`	`getAnchor()` Returns the anchor position.
`int`	`getAnchorOffset()` Returns the distance in pixels of the tooltip and target element.
`String`	`getBodyHtml()` Returns the tool tip text.
`Object`	`getData()` Returns the data for the renderer.
`int`	`getDismissDelay()` Returns the dismiss delay.
`int`	`getHideDelay()` Returns the hide delay in milliseconds.
`int`	`getMaxWidth()` Returns the tooltip's maximum width.
`int`	`getMinWidth()` Returns the tooltip's minimum width.
`int`	`getMouseOffsetX()` Gets the X offset from the mouse position where the tooltip should be shown
`int`	`getMouseOffsetY()` Gets the Y offset from the mouse position where the tooltip should be shown
`ToolTipConfig.ToolTipRenderer<?>`	`getRenderer()` Returns the renderer.
`int`	`getShowDelay()` Returns the show delay in milliseconds.
`String`	`getTitleHtml()` Returns the tool tip title.
`boolean`	`isAnchorArrow()` Returns the anchor arrow enabled.
`boolean`	`isAnchorToTarget()` Returns true if the tooltip is anchored to the target.
`boolean`	`isAutoHide()` Returns true if auto hide is enabled.
`boolean`	`isCloseable()` Returns true if the tip is closable.
`boolean`	`isEnabled()` Returns true if the tool tip is enabled.
`boolean`	`isTrackMouse()` Returns true if mouse tracking is enabled.
`void`	`setAnchor(Style.Side anchor)` Sets the anchor position (defaults to "bottom").
`void`	`setAnchorArrow(boolean anchorArrowEnabled)` Turn on and off the anchor arrow.
`void`	`setAnchorOffset(int anchorOffset)` A numeric pixel value used to offset the default position of the anchor arrow (defaults to 0).
`void`	`setAnchorToTarget(boolean anchorToTarget)` True to anchor the tooltip to the target element, false to anchor it relative to the mouse coordinates (defaults to true).
`void`	`setAutoHide(boolean autoHide)` True to automatically hide the tooltip after the mouse exits the target element or after the `dismissDelay` has expired if set (defaults to true).
`void`	`setBodyHtml(SafeHtml bodyHtml)` The tool tip text or html.
`void`	`setBodyText(String bodyText)` The tool tip text.
`void`	`setCloseable(boolean closeable)` True to render a close tool button into the tooltip header (defaults to false).
`void`	`setData(Object data)` The parameters to be used when a custom a `renderer` is specified.
`void`	`setDismissDelay(int dismissDelay)` Delay in milliseconds before the tooltip automatically hides (defaults to 5000).
`void`	`setEnabled(boolean enabled)` Sets whether the tool tip is enabled (defaults to true).
`void`	`setHideDelay(int hideDelay)` Delay in milliseconds after the mouse exits the target element but before the tooltip actually hides (defaults to 200).
`void`	`setMaxWidth(int maxWidth)` Sets the tooltip's maximum width (defaults to 300).
`void`	`setMinWidth(int minWidth)` Sets the tooltip's minimum width (defaults to 40).
`void`	`setMouseOffsetX(int x)` Sets the X offset from the mouse position where the tooltip should be shown (defaults to 15)
`void`	`setMouseOffsetY(int y)` Sets the Y offset from the mouse position where the tooltip should be shown (defaults to 18)
`void`	`setRenderer(ToolTipConfig.ToolTipRenderer<?> renderer)` A optional renderer to be used to render the tool tip.
`void`	`setShowDelay(int showDelay)` Delay in milliseconds before the tooltip displays after the mouse enters the target element (defaults to 500).
`void`	`setTitleHtml(SafeHtml titleHtml)`
`void`	`setTitleText(String titleText)`
`void`	`setTrackMouse(boolean trackMouse)` True to have the tooltip follow the mouse as it moves over the target element (defaults to false).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ToolTipConfig
```
public ToolTipConfig()
```
    Creates a new tool tip config.
  - ToolTipConfig
```
public ToolTipConfig(String text)
```
    Creates a new tool tip config with the given text.
    
    Parameters:
    
    text - the tool tip text as text
  - ToolTipConfig
```
public ToolTipConfig(String title,
                     String text)
```
    Creates a new tool tip config with the given title and text.
    
    Parameters:
    
    title - the tool tip title as text
    
    text - the tool tip text as text
  - ToolTipConfig
```
public ToolTipConfig(SafeHtml title,
                     SafeHtml html)
```
    Creates a new tool tip config with the given title and text.
    
    Parameters:
    
    title - the tool tip title as html
    
    html - the tool tip text as html
- Method Detail
  - getAnchor
```
public Style.Side getAnchor()
```
    Returns the anchor position.
    
    Returns:
    
    the anchor position
  - getAnchorOffset
```
public int getAnchorOffset()
```
    Returns the distance in pixels of the tooltip and target element.
    
    Returns:
    
    the offset
  - getBodyHtml
```
public String getBodyHtml()
```
    Returns the tool tip text.
    
    Returns:
    
    the text
  - getData
```
public Object getData()
```
    Returns the data for the renderer.
    
    Returns:
    
    the data
  - getDismissDelay
```
public int getDismissDelay()
```
    Returns the dismiss delay.
    
    Returns:
    
    the dismiss delay
  - getHideDelay
```
public int getHideDelay()
```
    Returns the hide delay in milliseconds.
    
    Returns:
    
    the delay
  - getMaxWidth
```
public int getMaxWidth()
```
    Returns the tooltip's maximum width.
    
    Returns:
    
    the maximum width
  - getMinWidth
```
public int getMinWidth()
```
    Returns the tooltip's minimum width.
    
    Returns:
    
    the minimum width
  - getMouseOffsetX
```
public int getMouseOffsetX()
```
    Gets the X offset from the mouse position where the tooltip should be shown
    
    Returns:
    
    the X offset from the mouse position from the tooltip
  - getMouseOffsetY
```
public int getMouseOffsetY()
```
    Gets the Y offset from the mouse position where the tooltip should be shown
    
    Returns:
    
    the Y offset from the mouse position from the tooltip
  - getRenderer
```
public ToolTipConfig.ToolTipRenderer<?> getRenderer()
```
    Returns the renderer.
    
    Returns:
    
    the template
  - getShowDelay
```
public int getShowDelay()
```
    Returns the show delay in milliseconds.
    
    Returns:
    
    the delay
  - getTitleHtml
```
public String getTitleHtml()
```
    Returns the tool tip title.
    
    Returns:
    
    the title
  - isAnchorArrow
```
public boolean isAnchorArrow()
```
    Returns the anchor arrow enabled.
    
    Returns:
    
    enabled true or false
  - isAnchorToTarget
```
public boolean isAnchorToTarget()
```
    Returns true if the tooltip is anchored to the target.
    
    Returns:
    
    true if anchored
  - isAutoHide
```
public boolean isAutoHide()
```
    Returns true if auto hide is enabled.
    
    Returns:
    
    the auto hide state
  - isCloseable
```
public boolean isCloseable()
```
    Returns true if the tip is closable.
    
    Returns:
    
    the closable state
  - isEnabled
```
public boolean isEnabled()
```
    Returns true if the tool tip is enabled.
    
    Returns:
    
    true for enabled
  - isTrackMouse
```
public boolean isTrackMouse()
```
    Returns true if mouse tracking is enabled.
    
    Returns:
    
    the mouse track state
  - setAnchor
```
public void setAnchor(Style.Side anchor)
```
    Sets the anchor position (defaults to "bottom").
    
    Parameters:
    
    anchor - the anchor position (top, bottom, left, right)
  - setAnchorArrow
```
public void setAnchorArrow(boolean anchorArrowEnabled)
```
    Turn on and off the anchor arrow. The arrow points from the tip to the target. Default is enabled true.
    
    Parameters:
    
    anchorArrowEnabled - enables the arrow
  - setAnchorOffset
```
public void setAnchorOffset(int anchorOffset)
```
    A numeric pixel value used to offset the default position of the anchor arrow (defaults to 0). When the anchor position is on the top or bottom of the tooltip, anchorOffset will be used as a horizontal offset. Likewise, when the anchor position is on the left or right side, anchorOffset will be used as a vertical offset.
    
    Parameters:
    
    anchorOffset - the offset in pixels
  - setAnchorToTarget
```
public void setAnchorToTarget(boolean anchorToTarget)
```
    True to anchor the tooltip to the target element, false to anchor it relative to the mouse coordinates (defaults to true).
    
    Parameters:
    
    anchorToTarget - true to anchor the tooltip to the target element
  - setAutoHide
```
public void setAutoHide(boolean autoHide)
```
    True to automatically hide the tooltip after the mouse exits the target element or after the dismissDelay has expired if set (defaults to true).
    
    Parameters:
    
    autoHide - the auto hide state
  - setBodyHtml
```
public void setBodyHtml(SafeHtml bodyHtml)
```
    The tool tip text or html.
    
    Parameters:
    
    bodyHtml - the tip text or html
  - setBodyText
```
public void setBodyText(String bodyText)
```
    The tool tip text.
    
    Parameters:
    
    bodyText - the tip text
  - setCloseable
```
public void setCloseable(boolean closeable)
```
    True to render a close tool button into the tooltip header (defaults to false).
    
    Parameters:
    
    closeable - the closable state
  - setData
```
public void setData(Object data)
```
    The parameters to be used when a custom a renderer is specified.
    
    Parameters:
    
    data - the data
  - setDismissDelay
```
public void setDismissDelay(int dismissDelay)
```
    Delay in milliseconds before the tooltip automatically hides (defaults to 5000). To disable automatic hiding, set dismissDelay = 0.
    
    Parameters:
    
    dismissDelay - the dismiss delay
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets whether the tool tip is enabled (defaults to true).
    
    Parameters:
    
    enabled - true to enable
  - setHideDelay
```
public void setHideDelay(int hideDelay)
```
    Delay in milliseconds after the mouse exits the target element but before the tooltip actually hides (defaults to 200). Set to 0 for the tooltip to hide immediately.
    
    Parameters:
    
    hideDelay - the hide delay
  - setMaxWidth
```
public void setMaxWidth(int maxWidth)
```
    Sets the tooltip's maximum width (defaults to 300).
    
    Parameters:
    
    maxWidth - the maximum width in pixels
  - setMinWidth
```
public void setMinWidth(int minWidth)
```
    Sets the tooltip's minimum width (defaults to 40).
    
    Parameters:
    
    minWidth - the minimum width
  - setMouseOffsetX
```
public void setMouseOffsetX(int x)
```
    Sets the X offset from the mouse position where the tooltip should be shown (defaults to 15)
    
    Parameters:
    
    x - the x axis offset
  - setMouseOffsetY
```
public void setMouseOffsetY(int y)
```
    Sets the Y offset from the mouse position where the tooltip should be shown (defaults to 18)
    
    Parameters:
    
    y - the y axis offset
  - setRenderer
```
public void setRenderer(ToolTipConfig.ToolTipRenderer<?> renderer)
```
    A optional renderer to be used to render the tool tip. The setData(Object) will be applied to the template.
    
    Parameters:
    
    renderer - the renderer
  - setShowDelay
```
public void setShowDelay(int showDelay)
```
    Delay in milliseconds before the tooltip displays after the mouse enters the target element (defaults to 500).
    
    Parameters:
    
    showDelay - the show delay
  - setTitleHtml
```
public void setTitleHtml(SafeHtml titleHtml)
```
  - setTitleText
```
public void setTitleText(String titleText)
```
  - setTrackMouse
```
public void setTrackMouse(boolean trackMouse)
```
    True to have the tooltip follow the mouse as it moves over the target element (defaults to false).
    
    Parameters:
    
    trackMouse - the track mouse state

Class ToolTipConfig

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ToolTipConfig

ToolTipConfig

ToolTipConfig

ToolTipConfig

Method Detail

getAnchor

getAnchorOffset

getBodyHtml

getData

getDismissDelay

getHideDelay

getMaxWidth

getMinWidth

getMouseOffsetX

getMouseOffsetY

getRenderer

getShowDelay

getTitleHtml

isAnchorArrow

isAnchorToTarget

isAutoHide

isCloseable

isEnabled

isTrackMouse

setAnchor

setAnchorArrow

setAnchorOffset

setAnchorToTarget

setAutoHide

setBodyHtml

setBodyText

setCloseable

setData

setDismissDelay

setEnabled

setHideDelay

setMaxWidth

setMinWidth

setMouseOffsetX

setMouseOffsetY

setRenderer

setShowDelay

setTitleHtml

setTitleText

setTrackMouse