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

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

All Implemented Interfaces:

Observable, com.google.gwt.user.client.EventListener

Direct Known Subclasses:

ToolTip

public class Tip
extends ContentPanel

This is the base class for ToolTip that provides the basic layout and positioning that all tip-based classes require. This class can be used directly for simple, statically-positioned tips that are displayed programmatically, or it can be extended to provide custom tip implementations.

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

Tip()
Creates a new tip instance.

Method Summary

int	getMaxWidth() Returns the maximum width.
int	getMinWidth() Returns the minimum width.
Shadow.ShadowPosition	getShadowPosition() Returns the shadow position.
boolean	isClosable() Returns true if the tip is closable.
void	setClosable(boolean closable) True to render a close tool button into the tooltip header (defaults to false).
void	setMaxWidth(int maxWidth) Sets he maximum width of the tip in pixels (defaults to 300).
void	setMinWidth(int minWidth) Sets the minimum width of the tip in pixels (defaults to 40).
void	setShadowPosition(Shadow.ShadowPosition shadowPosition) Sets the shadow position (defauts to SIDES).
void	showAt(int x, int y) Shows this tip at the specified position.
void	showAt(Point point) Shows this tip at the specified position.

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

addButton, collapse, expand, getAnimCollapse, getBodyBorder, getBodyStyle, getBottomComponent, getButtonAlign, getButtonBar, getCollapsible, getElement, getFooter, getFrame, getFrameHeight, getFrameWidth, getHeader, getInnerHeight, getInnerWidth, getLayoutTarget, getTitleCollapse, getTitleText, getTopComponent, getWidget, isExpanded, isHeaderVisible, isHideCollapseTool, onComponentEvent, setAnimCollapse, setBodyBorder, setBodyStyle, setBodyStyleName, setBottomComponent, setButtonAlign, setButtonBar, setCollapsible, setExpanded, setFooter, setFrame, setHeaderVisible, setHeading, setHideCollapseTool, setIconStyle, setInsetBorder, setTitleCollapse, setTopComponent, setUrl

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

add, add, addText, findComponent, getLayout, getLayoutOnChange, insert, insert, isMonitorResize, isMonitorWindowResize, layout, remove, removeAll, setLayout, setLayoutData, setLayoutOnChange, setMonitorWindowResize

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

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, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShim, setSize, setSize, setWidth, setWidth

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

addListener, addStyleName, addWidgetListener, disable, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getData, getData, getElement, getId, getItemId, getModel, getState, getToolTip, hide, hideToolTip, isEnabled, isRendered, isVisible, onBrowserEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeWidgetListener, render, render, saveState, setBorders, setData, setData, setElement, setEnabled, setEnableState, setId, setIntStyleAttribute, setItemId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, show, toString

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

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, sinkEvents, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

Tip

public Tip()

Creates a new tip instance.

Method Detail

getMaxWidth

public int getMaxWidth()

Returns the maximum width.

Returns:

the max width

getMinWidth

public int getMinWidth()

Returns the minimum width.

Returns:

the minimum width

getShadowPosition

public Shadow.ShadowPosition getShadowPosition()

Returns the shadow position.

Returns:

the shadow position

isClosable

public boolean isClosable()

Returns true if the tip is closable.

Returns:

the closable state

setClosable

public void setClosable(boolean closable)

True to render a close tool button into the tooltip header (defaults to false).

Parameters:

closable - the closable state

setMaxWidth

public void setMaxWidth(int maxWidth)

Sets he maximum width of the tip in pixels (defaults to 300). The maximum supported value is 500.

Parameters:

maxWidth - the max width

setMinWidth

public void setMinWidth(int minWidth)

Sets the minimum width of the tip in pixels (defaults to 40).

Parameters:

minWidth - the min width

setShadowPosition

public void setShadowPosition(Shadow.ShadowPosition shadowPosition)

Sets the shadow position (defauts to SIDES).

Parameters:

shadowPosition - the shadow position

showAt

public void showAt(int x,
                   int y)

Shows this tip at the specified position.

Parameters:

x - the x coordinate

y - the y coordiate

showAt

public void showAt(Point point)

Shows this tip at the specified position.

Parameters:

point - the position