com.extjs.gxt.ui.client.widget.tips
Class ToolTip

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.BoxComponent
                  com.extjs.gxt.ui.client.widget.Container<T>
                      com.extjs.gxt.ui.client.widget.ScrollContainer<Component>
                          com.extjs.gxt.ui.client.widget.LayoutContainer
                              com.extjs.gxt.ui.client.widget.ContentPanel
                                  com.extjs.gxt.ui.client.widget.tips.Tip
                                      com.extjs.gxt.ui.client.widget.tips.ToolTip

All Implemented Interfaces:

Observable, IconSupport, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener

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

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

ToolTip()
Creates a new tool tip.

ToolTip(Component target)
Creates a new tool tip.

ToolTip(Component target, ToolTipConfig config)
Creates a new tool tip for the given target.

Method Summary

int	getQuickShowInterval() Returns the quick show interval.
ToolTipConfig	getToolTipConfig() Returns the current tool tip config.
void	hide() Hide this component.
void	initTarget(Component target)
void	setQuickShowInterval(int quickShowInterval) Sets the quick show interval (defaults to 250).
void	show() Show this component.
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.extjs.gxt.ui.client.widget.tips.Tip

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

Methods inherited from class com.extjs.gxt.ui.client.widget.ContentPanel

addButton, collapse, expand, getAnimCollapse, getBody, getBodyBorder, getBodyStyle, getBottomComponent, getButtonAlign, getButtonBar, getCollapseBtn, getCollapsible, getElement, getFrame, getFrameHeight, getFrameWidth, getHeader, getHeading, getIcon, getInnerHeight, getInnerWidth, getLayoutTarget, getMinButtonWidth, getTitleCollapse, getTitleText, getTopComponent, isCollapsed, isExpanded, isFooter, isHeaderVisible, isHideCollapseTool, onComponentEvent, setAnimCollapse, setBodyBorder, setBodyStyle, setBodyStyleName, setBottomComponent, setButtonAlign, setCollapsible, setExpanded, setFooter, setFrame, setHeaderVisible, setHeading, setHideCollapseTool, setIcon, setIconStyle, setInsetBorder, setMinButtonWidth, setTitleCollapse, setTopComponent, setUrl

Methods inherited from class com.extjs.gxt.ui.client.widget.LayoutContainer

add, add, addText, findComponent, getLayout, getWindowResizeDelay, insert, insert, isLayoutOnChange, isMonitorWindowResize, layout, layout, remove, removeAll, setLayout, setLayoutData, setLayoutOnChange, setMonitorWindowResize, setWindowResizeDelay

Methods inherited from class com.extjs.gxt.ui.client.widget.ScrollContainer

addScrollListener, getHScrollPosition, getScrollMode, getVScrollPosition, removeScrollListener, scrollIntoView, setHScrollPosition, setScrollMode, setVScrollPosition

Methods inherited from class com.extjs.gxt.ui.client.widget.Container

disable, enable, findItem, getItem, getItemByItemId, getItemCount, getItems, getWidget, indexOf, iterator, scrollIntoView

Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

getBounds, getHeight, getHeight, getPosition, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize

Methods inherited from class com.extjs.gxt.ui.client.widget.Component

addListener, addPlugin, addStyleName, addWidgetListener, clearState, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getContextMenu, getData, getElement, getHideMode, getId, getItemId, getListeners, getModel, getState, getStateId, getToolTip, hasListeners, hasListeners, hideToolTip, isDisabledEvents, isEnabled, isRendered, isStateful, isVisible, mask, mask, mask, onBrowserEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setBorders, setContextMenu, setData, setElement, setEnabled, setHideMode, setId, setIntStyleAttribute, setItemId, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setZIndex, sinkEvents, swallowEvent, swallowEvent, toString, unmask

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

fireEvent, getParent, isAttached

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

addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolTip

public ToolTip()

Creates a new tool tip.

ToolTip

public ToolTip(Component target)

Creates a new tool tip.

Parameters:

target - the target widget

ToolTip

public ToolTip(Component target,
               ToolTipConfig config)

Creates a new tool tip for the given target.

Parameters:

target - the target widget

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 component. Fires the BeforeHide event before the component is hidden, the fires the Hide event after the component is hidden.

Overrides:

hide in class Tip

initTarget

public void initTarget(Component target)

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 component. Fires the BeforeShow event before the component is made visible, then fires the Show event after the component is visible.

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