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, IconSupport, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget

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

protected boolean	constrainPosition
protected int	quickShowInterval

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

bbarStyle, bodStyle, body, bwrap, bwrapStyle, collapseStyle, fbar, footerStyle, frame, head, headerStyle, headerTextStyle, tbarStyle

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

attachChildren, enableLayout, layoutExecuted, layoutNeeded, layoutOnAttach, layoutOnChange

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

adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width

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

afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask

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

DEBUG_ID_PREFIX

Constructor Summary

Tip()
Creates a new tip instance.

Method Summary

protected void	doAutoWidth()
int	getMaxWidth() Returns the maximum width.
int	getMinWidth() Returns the minimum width.
void	hide() Hide this component.
boolean	isClosable() Returns true if the tip is closable.
protected void	onDisable()
protected void	onRender(com.google.gwt.user.client.Element parent, int pos) Subclasses must override and ensure setElement is called for lazy rendered components.
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	showAt(int x, int y) Shows this tip at the specified position.
void	showAt(Point point) Shows this tip at the specified position.
protected void	updateContent()

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

addButton, adjustBodySize, afterCollapse, afterExpand, collapse, createStyles, doAttachChildren, doDetachChildren, expand, getAnimCollapse, getBody, getBodyBorder, getBodyStyle, getBottomComponent, getButtonAlign, getButtonBar, getCollapseBtn, getCollapsible, getElement, getFrame, getFrameHeight, getFrameSize, getFrameWidth, getHeader, getHeadingHtml, getIcon, getInnerHeight, getInnerWidth, getLayoutTarget, getMinButtonWidth, getTitleCollapse, getTopComponent, initTools, isCollapsed, isExpanded, isFooter, isHeaderVisible, isHideCollapseTool, layoutBars, notifyHide, notifyShow, onClick, onCollapse, onComponentEvent, onEnable, onExpand, onResize, remove, setAnimCollapse, setBodyBorder, setBodyStyle, setBodyStyleName, setBottomComponent, setButtonAlign, setCollapsible, setExpanded, setFooter, setFrame, setHeaderVisible, setHeadingHtml, setHeadingText, setHideCollapseTool, setIcon, setIconStyle, 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, onBlur, onFocus, remove, removeAll, setLayout, setLayoutData, setLayoutOnChange, setMonitorWindowResize, setWindowResizeDelay

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

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

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

add, adjustIndex, adopt, createContainerEvent, disable, doLayout, doLayout, enable, findItem, getItem, getItemByItemId, getItemCount, getItems, getWidget, indexOf, insert, isLayoutNeeded, iterator, onAfterLayout, onAttach, onBeforeLayoutExcecuted, onInsert, onLayoutExcecuted, onRemove, orphan, remove, removeAll, scrollIntoView, setLayoutNeeded, wrapWidget

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

adjustPosition, adjustSize, createComponentEvent, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onHide, onPosition, onShow, onUnload, 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

addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, disableContextMenu, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, hasListeners, hasListeners, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, onBrowserEvent, onDetach, onDetachHelper, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData, unsinkEvents

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

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, resolvePotentialElement, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent

Methods inherited from class java.lang.Object

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

Field Detail

quickShowInterval

protected int quickShowInterval

constrainPosition

protected boolean constrainPosition

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

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 Component

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

showAt

public void showAt(int x,
                   int y)

Shows this tip at the specified position.

Parameters:

x - the x coordinate

y - the y coordinate

showAt

public void showAt(Point point)

Shows this tip at the specified position.

Parameters:

point - the position

doAutoWidth

protected void doAutoWidth()

onDisable

protected void onDisable()

Overrides:

onDisable in class ContentPanel

onRender

protected void onRender(com.google.gwt.user.client.Element parent,
                        int pos)

Description copied from class: Component

Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:

onRender in class ContentPanel

Parameters:

parent - the target element

pos - the insert location

updateContent

protected void updateContent()