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

Class QuickTip

java.lang.Object

Widget

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

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

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

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

All Implemented Interfaces:

HasGestureRecognizers, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

public class QuickTip
extends ToolTip

A specialized tooltip class for tooltips that can be specified in markup.

Quicktips can be configured via tag attributes directly in markup. Below is the summary of the configuration properties which can be used.

• text (required)
• title
• width

To register a quick tip in markup, you simply add one or more of the valid QuickTip attributes. The HTML element itself is automatically set as the quick tip target.

Tag attribute options:

• qtip (required): The quick tip text (equivalent to the 'text' target element config).
• qtitle: The quick tip title (equivalent to the 'title' target element config).
• qwidth: The quick tip width (equivalent to the 'width' target element config).

Example using QuickTip tag attributes:

 private void exampleQuickTip() {
   HTML html = new HTML("<span qtitle='Title for Tip' qtip='Display this tip.' qwidth='50px'>Some text.</span>");
   new QuickTip(html);
   RootPanel.get().add(html);
 }
 

Nested Class Summary

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.tips.Tip

Tip.TipAppearance

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.tips.ToolTip

anchorEl, body, dismissTimer, hideTimer, showTimer, target, targetXY, title

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

close, constrainPosition, quickShowInterval, 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
QuickTip(Widget component) Creates a new quick tip instance.
QuickTip(Widget component, Tip.TipAppearance appearance) Creates a new quick tip instance.

Method Summary

Modifier and Type	Method and Description
boolean	isInterceptTitles() Returns true if intercept titles is enabled.
protected void	onHide()
protected void	onTargetMouseMove(MouseMoveEvent event)
protected void	onTargetMouseOut(MouseOutEvent event)
protected void	onTargetMouseOver(MouseOverEvent event)
protected void	onTargetOut(Event ce)
protected void	onTargetOver(Event ce)
void	setInterceptTitles(boolean interceptTitles) True to automatically use the element's DOM title value if available (defaults to false).

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

clearTimer, clearTimers, delayHide, delayShow, getAnchorAlign, getOffsets, getQuickShowInterval, getTargetXY, getToolTipConfig, hide, init, initTarget, onAfterFirstAttach, onMouseMove, onTargetTouchMove, onWindowResize, setQuickShowInterval, show, showAt, syncAnchor, update, updateContent

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

doAttachChildren, doDetachChildren, getAppearance, getMaxWidth, getMinWidth, isClosable, onDisable, setClosable, setMaxWidth, setMinWidth, showAt

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

QuickTip

public QuickTip(Widget component)

Creates a new quick tip instance.

Parameters:

component - the source component

QuickTip

public QuickTip(Widget component,
                Tip.TipAppearance appearance)

Creates a new quick tip instance.

Parameters:

component - the source component

appearance - the appearance

Method Detail

isInterceptTitles

public boolean isInterceptTitles()

Returns true if intercept titles is enabled.

Returns:

the intercept title state

setInterceptTitles

public void setInterceptTitles(boolean interceptTitles)

True to automatically use the element's DOM title value if available (defaults to false).

Parameters:

interceptTitles - true to to intercept titles

onHide

protected void onHide()

Overrides:

onHide in class Component

onTargetMouseMove

protected void onTargetMouseMove(MouseMoveEvent event)

Overrides:

onTargetMouseMove in class ToolTip

onTargetMouseOut

protected void onTargetMouseOut(MouseOutEvent event)

Overrides:

onTargetMouseOut in class ToolTip

onTargetMouseOver

protected void onTargetMouseOver(MouseOverEvent event)

Overrides:

onTargetMouseOver in class ToolTip

onTargetOut

protected void onTargetOut(Event ce)

Overrides:

onTargetOut in class ToolTip

onTargetOver

protected void onTargetOver(Event ce)

Overrides:

onTargetOver in class ToolTip