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

Class Tip

java.lang.Object

Widget

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

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

All Implemented Interfaces:

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:

ToolTip

public class Tip
extends Component

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

Modifier and Type	Class and Description
static interface	Tip.TipAppearance

Field Summary

Fields

Modifier and Type	Field and Description
protected ToolButton	close
protected boolean	constrainPosition
protected int	quickShowInterval
protected boolean	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
Tip() Creates a new tip instance.
Tip(Tip.TipAppearance appearance)

Method Summary

Modifier and Type	Method and Description
protected void	doAttachChildren()
protected void	doAutoWidth()
protected void	doDetachChildren()
Tip.TipAppearance	getAppearance() Returns the tip's appearance.
int	getMaxWidth() Returns the maximum width.
int	getMinWidth() Returns the minimum width.
void	hide() Hide this widget.
boolean	isClosable() Returns true if the tip is closable.
protected void	onDisable()
void	setClosable(boolean closable) True to render a close tool button into the tooltip header (defaults to false).
void	setMaxWidth(int maxWidth) Sets the 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.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, 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, 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, onAfterFirstAttach, onAttach, onBlur, onBrowserEvent, onDetach, onEnable, onFocus, onHide, onHideContextMenu, onLoad, onPosition, onResize, onRightClick, onShow, onShowContextMenu, onUnload, onWindowResize, 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, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

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

Field Detail

quickShowInterval

protected int quickShowInterval

constrainPosition

protected boolean constrainPosition

close

protected ToolButton close

showing

protected boolean showing

Constructor Detail

Tip

public Tip()

Creates a new tip instance.

Tip

public Tip(Tip.TipAppearance appearance)

Method Detail

getAppearance

public Tip.TipAppearance getAppearance()

Returns the tip's appearance.

Returns:

the appearance

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 widget.

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 the 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 minimum 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

doAttachChildren

protected void doAttachChildren()

doAutoWidth

protected void doAutoWidth()

doDetachChildren

protected void doDetachChildren()

onDisable

protected void onDisable()

Overrides:

onDisable in class Component

updateContent

protected void updateContent()