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

Class ToolTip

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.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:

HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, HasEnabled, HasVisibility, IsWidget, 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

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
ToolTip(Tip.TipAppearance appearance) Creates a new tool tip.
ToolTip(ToolTipConfig config) Creates a new tool tip.
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

Methods

Modifier and Type	Method and Description
int	getQuickShowInterval() Returns the quick show interval.
ToolTipConfig	getToolTipConfig() Returns the current tool tip config.
void	hide() Hide this widget.
void	initTarget(Widget widget) Binds the tool tip to the target widget.
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.
void	update(ToolTipConfig config) Updates the tool tip with the given config.

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

getAppearance, getMaxWidth, getMinWidth, isClosable, setClosable, setMaxWidth, setMinWidth, showAt

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

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, onBrowserEvent, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, sync, syncSize, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ToolTip

public ToolTip(Widget target)

Creates a new tool tip.

Parameters:

target - the target widget

ToolTip

public ToolTip(Tip.TipAppearance appearance)

Creates a new tool tip.

Parameters:

appearance - the appearance

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

ToolTip

public ToolTip(ToolTipConfig config)

Creates a new tool tip.

Parameters:

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