com.sencha.gxt.widget.core.client.tips

Class ToolTip

java.lang.Object

Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.tips.Tip

com.sencha.gxt.widget.core.client.tips.ToolTip

All Implemented Interfaces:

HasGestureRecognizers, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

Direct Known Subclasses:

QuickTip

public class ToolTip
extends Tip

A standard tooltip implementation for providing additional information when hovering over a target element.

Nested Class Summary

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.tips.Tip

Tip.TipAppearance

Field Summary

Fields

Modifier and Type	Field and Description
protected XElement	anchorEl
protected SafeHtml	body
protected Timer	dismissTimer
protected Timer	hideTimer
protected Timer	showTimer
protected Element	target
protected Point	targetXY
protected SafeHtml	title

Fields inherited from class com.sencha.gxt.widget.core.client.tips.Tip

close, constrainPosition, quickShowInterval, showing

Fields inherited from class com.sencha.gxt.widget.core.client.Component

adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
ToolTip(Widget target) Creates a new tool tip.
ToolTip(Widget target, Tip.TipAppearance appearance) Creates a new tool tip.
ToolTip(Widget target, ToolTipConfig config) Creates a new tool tip for the given target.

Method Summary

Modifier and Type	Method and Description
protected void	clearTimer(String timer)
protected void	clearTimers()
void	delayHide()
protected void	delayShow()
protected Style.AnchorAlignment	getAnchorAlign()
protected int[]	getOffsets()
int	getQuickShowInterval() Returns the quick show interval.
protected Point	getTargetXY(int targetCounter)
ToolTipConfig	getToolTipConfig() Returns the current tool tip config.
void	hide() Hide this widget.
protected void	init() Creates a new tool tip.
void	initTarget(Widget widget) Binds the tool tip to the target widget.
protected void	onAfterFirstAttach() Called immediately after the first time the widget becomes attached to the browser's document only the first time.
protected void	onMouseMove(Event event)
protected void	onTargetMouseMove(MouseMoveEvent event)
protected void	onTargetMouseOut(MouseOutEvent event)
protected void	onTargetMouseOver(MouseOverEvent event)
protected void	onTargetOut(Event ce)
protected void	onTargetOver(Event ce)
protected void	onTargetTouchMove(TouchMoveEvent event)
protected void	onWindowResize(int width, int height)
void	setQuickShowInterval(int quickShowInterval) Sets the quick show interval (defaults to 250).
void	show() Show this widget.
void	showAt(int x, int y) Shows this tip at the specified position.
protected void	syncAnchor()
void	update(ToolTipConfig config) Updates the tool tip with the given config.
protected void	updateContent()

Methods inherited from class com.sencha.gxt.widget.core.client.tips.Tip

doAttachChildren, doDetachChildren, getAppearance, getMaxWidth, getMinWidth, isClosable, onDisable, setClosable, setMaxWidth, setMinWidth, showAt

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getElement, getFocusEl, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAttach, onBlur, onBrowserEvent, onDetach, onEnable, onFocus, onHide, onHideContextMenu, onLoad, onPosition, onResize, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, sync, syncSize, unmask

Methods inherited from class java.lang.Object

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

Field Detail

anchorEl

protected XElement anchorEl

dismissTimer

protected Timer dismissTimer

hideTimer

protected Timer hideTimer

showTimer

protected Timer showTimer

target

protected Element target

targetXY

protected Point targetXY

title

protected SafeHtml title

body

protected SafeHtml body

Constructor Detail

ToolTip

public ToolTip(Widget target)

Creates a new tool tip.

Parameters:

target - the target widget

ToolTip

public ToolTip(Widget target,
               Tip.TipAppearance appearance)

Creates a new tool tip.

Parameters:

target - the target widget

appearance - the appearance

ToolTip

public ToolTip(Widget target,
               ToolTipConfig config)

Creates a new tool tip for the given target.

Parameters:

target - the target widget

config - the tool tip config

Method Detail

getQuickShowInterval

public int getQuickShowInterval()

Returns the quick show interval.

Returns:

the quick show interval

getToolTipConfig

public ToolTipConfig getToolTipConfig()

Returns the current tool tip config.

Returns:

the tool tip config

hide

public void hide()

Description copied from class: Component

Hide this widget.

Overrides:

hide in class Tip

initTarget

public void initTarget(Widget widget)

Binds the tool tip to the target widget. Allows a tool tip to switch the target widget.

Parameters:

widget - the target widget

setQuickShowInterval

public void setQuickShowInterval(int quickShowInterval)

Sets the quick show interval (defaults to 250).

Parameters:

quickShowInterval - the quick show interval

show

public void show()

Description copied from class: Component

Show this widget.

Overrides:

show in class Component

showAt

public void showAt(int x,
                   int y)

Description copied from class: Tip

Shows this tip at the specified position.

Overrides:

showAt in class Tip

Parameters:

x - the x coordinate

y - the y coordinate

update

public void update(ToolTipConfig config)

Updates the tool tip with the given config.

Parameters:

config - the tool tip config

clearTimer

protected void clearTimer(String timer)

clearTimers

protected void clearTimers()

delayHide

public void delayHide()

delayShow

protected void delayShow()

getAnchorAlign

protected Style.AnchorAlignment getAnchorAlign()

getOffsets

protected int[] getOffsets()

init

protected void init()

Creates a new tool tip.

onAfterFirstAttach

protected void onAfterFirstAttach()

Description copied from class: Component

Called immediately after the first time the widget becomes attached to the browser's document only the first time.

Overrides:

onAfterFirstAttach in class Component

onMouseMove

protected void onMouseMove(Event event)

onTargetMouseMove

protected void onTargetMouseMove(MouseMoveEvent event)

onTargetMouseOut

protected void onTargetMouseOut(MouseOutEvent event)

onTargetMouseOver

protected void onTargetMouseOver(MouseOverEvent event)

onTargetOut

protected void onTargetOut(Event ce)

onTargetOver

protected void onTargetOver(Event ce)

onTargetTouchMove

protected void onTargetTouchMove(TouchMoveEvent event)

onWindowResize

protected void onWindowResize(int width,
                              int height)

Overrides:

onWindowResize in class Component

syncAnchor

protected void syncAnchor()

updateContent

protected void updateContent()

Overrides:

updateContent in class Tip

getTargetXY

protected Point getTargetXY(int targetCounter)