qx.ui.popup
Class ToolTip

java.lang.Object
  qx.core.Object
      qx.core.Target
          qx.ui.core.Widget
              qx.ui.core.Parent
                  qx.ui.layout.CanvasLayout
                      qx.ui.popup.Popup
                          qx.ui.popup.PopupAtom
                              qx.ui.popup.ToolTip

public class ToolTip
extends PopupAtom

Field Summary

Fields inherited from class qx.ui.core.Widget

AUTO

Constructor Summary

ToolTip()

ToolTip(java.lang.Object vLabel)

ToolTip(java.lang.Object vLabel, java.lang.Object vIcon)

Method Summary

void	_afterAppear() Callback method for the “afterAppear” event.
void	_applyBoundToWidget(java.lang.Object value, java.lang.Object old)
void	_applyHideInterval(java.lang.Object value, java.lang.Object old)
void	_applyShowInterval(java.lang.Object value, java.lang.Object old)
void	_beforeAppear() Callback method for the “beforeAppear” event.
void	_beforeDisappear() Callback method for the “beforeDisappear” event.
java.lang.Object	_onhidetimer(Event e) Callback method for the “interval” event of the hide timer.
void	_onmouseover(MouseEvent e) Callback method for the “mouseOver” event.
void	_onshowtimer(Event e) Callback method for the “interval” event of the show timer.
void	_startHideTimer() Utility method to start the timer for the hide interval (if the timer is disabled)
void	_startShowTimer() Utility method to start the timer for the show interval (if the timer is disabled)
void	_stopHideTimer() Utility method to stop the timer for the hide interval (if the timer is enabled)
void	_stopShowTimer() Utility method to stop the timer for the show interval (if the timer is enabled)
Widget	getBoundToWidget() Returns the (computed) value of the property boundToWidget.
java.lang.Integer	getHideInterval() Returns the (computed) value of the property hideInterval.
boolean	getHideOnHover() Returns the (computed) value of the property hideOnHover.
java.lang.Integer	getMousePointerOffsetX() Returns the (computed) value of the property mousePointerOffsetX.
java.lang.Integer	getMousePointerOffsetY() Returns the (computed) value of the property mousePointerOffsetY.
java.lang.Integer	getShowInterval() Returns the (computed) value of the property showInterval.
void	initBoundToWidget(Widget arg) Calls the apply method and dispatches the change event of the property boundToWidget with the default value defined by the class developer.
void	initHideInterval(java.lang.Integer arg) Calls the apply method and dispatches the change event of the property hideInterval with the default value defined by the class developer.
void	initHideOnHover(boolean arg) Calls the apply method and dispatches the change event of the property hideOnHover with the default value defined by the class developer.
void	initMousePointerOffsetX(java.lang.Integer arg) Calls the apply method and dispatches the change event of the property mousePointerOffsetX with the default value defined by the class developer.
void	initMousePointerOffsetY(java.lang.Integer arg) Calls the apply method and dispatches the change event of the property mousePointerOffsetY with the default value defined by the class developer.
void	initShowInterval(java.lang.Integer arg) Calls the apply method and dispatches the change event of the property showInterval with the default value defined by the class developer.
boolean	isHideOnHover() Check whether the (computed) value of the boolean property hideOnHover equals true.
void	resetBoundToWidget() Resets the user value of the property boundToWidget.
void	resetHideInterval() Resets the user value of the property hideInterval.
void	resetHideOnHover() Resets the user value of the property hideOnHover.
void	resetMousePointerOffsetX() Resets the user value of the property mousePointerOffsetX.
void	resetMousePointerOffsetY() Resets the user value of the property mousePointerOffsetY.
void	resetShowInterval() Resets the user value of the property showInterval.
void	setBoundToWidget(Widget arg) Sets the user value of the property boundToWidget.
void	setHideInterval(java.lang.Integer arg) Sets the user value of the property hideInterval.
void	setHideOnHover(boolean arg) Sets the user value of the property hideOnHover.
void	setMousePointerOffsetX(java.lang.Integer arg) Sets the user value of the property mousePointerOffsetX.
void	setMousePointerOffsetY(java.lang.Integer arg) Sets the user value of the property mousePointerOffsetY.
void	setShowInterval(java.lang.Integer arg) Sets the user value of the property showInterval.
boolean	toggleHideOnHover() Toggles the (computed) value of the boolean property hideOnHover.

Methods inherited from class qx.ui.popup.PopupAtom

getAtom

Methods inherited from class qx.ui.popup.Popup

_makeActive, _makeInactive, _sendTo, bringToFront, centerToBrowser, getAutoHide, getCentered, getHideTimeStamp, getRestrictToPageBottom, getRestrictToPageLeft, getRestrictToPageOnOpen, getRestrictToPageRight, getRestrictToPageTop, getShowTimeStamp, initAutoHide, initCentered, initRestrictToPageBottom, initRestrictToPageLeft, initRestrictToPageOnOpen, initRestrictToPageRight, initRestrictToPageTop, isAutoHide, isCentered, isRestrictToPageOnOpen, positionRelativeTo, resetAutoHide, resetCentered, resetRestrictToPageBottom, resetRestrictToPageLeft, resetRestrictToPageOnOpen, resetRestrictToPageRight, resetRestrictToPageTop, sendToBack, setAutoHide, setCentered, setRestrictToPageBottom, setRestrictToPageLeft, setRestrictToPageOnOpen, setRestrictToPageRight, setRestrictToPageTop, toggleAutoHide, toggleCentered, toggleRestrictToPageOnOpen

Methods inherited from class qx.ui.layout.CanvasLayout

_createLayoutImpl

Methods inherited from class qx.ui.core.Parent

_addChildrenToLayoutQueue, _addChildrenToStateQueue, _addChildToChildrenQueue, _afterDisappear, _afterInsertDom, _afterRemoveDom, _applyActiveChild, _applyFocusedChild, _applyFocusHandler, _beforeInsertDom, _beforeRemoveDom, _changeInnerHeight, _changeInnerWidth, _computePreferredInnerHeight, _computePreferredInnerWidth, _computeVisibleChildren, _flushChildrenQueue, _handleDisplayableCustom, _layoutChild, _layoutPost, _onfocuskeyevent, _recursiveAppearanceThemeUpdate, _removeChildFromChildrenQueue, activateFocusRoot, add, addAfter, addAt, addAtBegin, addAtEnd, addBefore, contains, forEachChild, forEachVisibleChild, getActiveChild, getChildren, getChildrenLength, getFirstActiveChild, getFirstChild, getFirstVisibleChild, getFocusedChild, getFocusHandler, getFocusRoot, getInnerHeightForChild, getInnerWidthForChild, getLastActiveChild, getLastChild, getLastVisibleChild, getLayoutImpl, getVisibleChildrenLength, hasChildren, hasVisibleChildren, indexOf, initActiveChild, initFocusedChild, initFocusHandler, isEmpty, isFocusRoot, isVisibleEmpty, recursiveAddToStateQueue, remapChildrenHandlingTo, remove, removeAll, removeAt, resetActiveChild, resetFocusedChild, resetFocusHandler, setActiveChild, setFocusedChild, setFocusHandler

Methods inherited from class qx.ui.core.Widget

_applyAppearance, _applyBackgroundColor, _applyBackgroundImage, _applyBackgroundRepeat, _applyBorder, _applyBottom, _applyCapture, _applyClip, _applyCommand, _applyCursor, _applyDisplay, _applyElement, _applyElementData, _applyEnabled, _applyFocused, _applyFont, _applyHeight, _applyHideFocus, _applyHtmlAttributes, _applyHtmlProperties, _applyLeft, _applyMarginBottom, _applyMarginLeft, _applyMarginRight, _applyMarginTop, _applyMaxHeight, _applyMaxWidth, _applyMinHeight, _applyMinWidth, _applyOpacity, _applyOverflow, _applyPaddingBottom, _applyPaddingLeft, _applyPaddingRight, _applyPaddingTop, _applyParent, _applyRight, _applySelectable, _applyStateStyleFocus, _applyStyleProperties, _applyTabIndex, _applyTextColor, _applyTop, _applyVisibility, _applyWidth, _applyZIndex, _checkParent, _compileClipString, _computeBoxHeight, _computeBoxHeightFallback, _computeBoxWidth, _computeBoxWidthFallback, _computeDisplayable, _computeFrameHeight, _computeFrameWidth, _computeHasAutoX, _computeHasAutoY, _computeHasFlexX, _computeHasFlexY, _computeHasPercentX, _computeHasPercentY, _computeInnerHeight, _computeInnerWidth, _computeOuterHeight, _computeOuterWidth, _computePreferredBoxHeight, _computePreferredBoxWidth, _computeValuePercentX, _computeValuePercentXLimit, _computeValuePercentY, _computeValuePercentYLimit, _computeValuePixel, _computeValuePixelLimit, _createElementImpl, _evalUnitsPixelPercent, _evalUnitsPixelPercentAuto, _evalUnitsPixelPercentAutoFlex, _flushJobQueue, _generateHtmlId, _getTargetNode, _handleDisplayable, _invalidateFrameDimensions, _invalidatePreferredInnerDimensions, _queueBorder, _recomputeFlexX, _recomputeFlexY, _recomputePercentX, _recomputePercentY, _recomputeRangeX, _recomputeRangeY, _recomputeStretchingX, _recomputeStretchingY, _renderAppearance, _renderOverflow, _resetAppearanceThemeWrapper, _styleBackgroundColor, _styleBackgroundImage, _styleFromMap, _unitDetectionPixelPercent, _unitDetectionPixelPercentAuto, _unitDetectionPixelPercentAutoFlex, _unstyleFromArray, _visualizeBlur, _visualizeFocus, _visualPropertyCheck, addState, addToDocument, addToJobQueue, addToLayoutChanges, addToQueue, addToQueueRuntime, addToStateQueue, auto, blur, connect, contains, disconnect, execute, focus, getAllowStretchX, getAllowStretchY, getAnonymous, getAppearance, getBackgroundColor, getBackgroundImage, getBackgroundRepeat, getBorder, getBottom, getBottomValue, getCapture, getClientHeight, getClientWidth, getClipHeight, getClipLeft, getClipTop, getClipWidth, getCommand, getContextMenu, getCursor, getDisplay, getDropDataTypes, getElement, getEnabled, getEnableElementFocus, getFocused, getFont, getHeight, getHeightValue, getHideFocus, getHorizontalAlign, getHtmlAttribute, getHtmlProperty, getLeft, getLeftValue, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxHeightValue, getMaxWidth, getMaxWidthValue, getMinHeight, getMinHeightValue, getMinWidth, getMinWidthValue, getNeededHeight, getNeededWidth, getNextActiveSibling, getNextSibling, getNextVisibleSibling, getOffsetHeight, getOffsetLeft, getOffsetTop, getOffsetWidth, getOpacity, getOverflow, getOverflowX, getOverflowY, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getParent, getPreviousActiveSibling, getPreviousSibling, getPreviousVisibleSibling, getRight, getRightValue, getScrollHeight, getScrollLeft, getScrollTop, getScrollWidth, getSelectable, getStyleProperty, getSupportsDropMethod, getTabIndex, getTextColor, getToolTip, getTop, getTopLevelWidget, getTopValue, getVerticalAlign, getVisibility, getVisibleChildren, getWidth, getWidthValue, getZIndex, hasState, hide, indexOf, initAllowStretchX, initAllowStretchY, initAnonymous, initAppearance, initBackgroundColor, initBackgroundImage, initBackgroundRepeat, initBorder, initBottom, initCapture, initClipHeight, initClipLeft, initClipTop, initClipWidth, initCommand, initContextMenu, initCursor, initDisplay, initDropDataTypes, initElement, initEnabled, initEnableElementFocus, initFocused, initFont, initHeight, initHideFocus, initHorizontalAlign, initLeft, initMarginBottom, initMarginLeft, initMarginRight, initMarginTop, initMaxHeight, initMaxWidth, initMinHeight, initMinWidth, initOpacity, initOverflow, initPaddingBottom, initPaddingLeft, initPaddingRight, initPaddingTop, initParent, initRight, initSelectable, initSupportsDropMethod, initTabIndex, initTextColor, initToolTip, initTop, initVerticalAlign, initVisibility, initWidth, initZIndex, isAllowStretchX, isAllowStretchY, isAnonymous, isAppearRelevant, isCapture, isCreated, isDisplay, isDisplayable, isEnabled, isEnableElementFocus, isFirstChild, isFirstVisibleChild, isFocusable, isFocused, isHideFocus, isLastChild, isLastVisibleChild, isMaterialized, isSeeable, isSelectable, isVisibility, moveSelfAfter, moveSelfBefore, moveSelfToBegin, moveSelfToEnd, pack, removeHtmlAttribute, removeHtmlProperty, removeState, removeStyleProperty, renderPadding, resetAlign, resetAllowStretchX, resetAllowStretchY, resetAnonymous, resetAppearance, resetBackgroundColor, resetBackgroundImage, resetBackgroundRepeat, resetBorder, resetBottom, resetCapture, resetClip, resetClipDimension, resetClipHeight, resetClipLeft, resetClipLocation, resetClipTop, resetClipWidth, resetCommand, resetContextMenu, resetCursor, resetDimension, resetDisplay, resetDropDataTypes, resetEdge, resetElement, resetEnabled, resetEnableElementFocus, resetFocused, resetFont, resetHeight, resetHeights, resetHideFocus, resetHorizontalAlign, resetLeft, resetLocation, resetMargin, resetMarginBottom, resetMarginLeft, resetMarginRight, resetMarginTop, resetMaxHeight, resetMaxWidth, resetMinHeight, resetMinWidth, resetOpacity, resetOverflow, resetPadding, resetPaddingBottom, resetPaddingLeft, resetPaddingRight, resetPaddingTop, resetParent, resetRight, resetSelectable, resetSpace, resetSupportsDropMethod, resetTabIndex, resetTextColor, resetToolTip, resetTop, resetVerticalAlign, resetVisibility, resetWidth, resetWidths, resetZIndex, scrollIntoView, scrollIntoViewX, scrollIntoViewY, setAlign, setAllowStretchX, setAllowStretchY, setAnonymous, setAppearance, setBackgroundColor, setBackgroundImage, setBackgroundRepeat, setBorder, setBottom, setCapture, setClip, setClipDimension, setClipHeight, setClipLeft, setClipLocation, setClipTop, setClipWidth, setCommand, setContextMenu, setCursor, setDimension, setDisplay, setDropDataTypes, setEdge, setElement, setEnabled, setEnableElementFocus, setFocused, setFont, setHeight, setHeights, setHideFocus, setHorizontalAlign, setHtmlAttribute, setHtmlProperty, setLeft, setLocation, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOpacity, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setParent, setRight, setScrollLeft, setScrollTop, setSelectable, setSpace, setStyleProperty, setSupportsDropMethod, setTabIndex, setTextColor, setToolTip, setTop, setVerticalAlign, setVisibility, setWidth, setWidths, setZIndex, show, supportsDrop, toggleAllowStretchX, toggleAllowStretchY, toggleAnonymous, toggleCapture, toggleDisplay, toggleEnabled, toggleEnableElementFocus, toggleFocused, toggleHideFocus, toggleSelectable, toggleVisibility

Methods inherited from class qx.core.Target

_dispatchEvent, addChangeSelectionListener, addChangeValueListener, addEventListener, addExecuteListener, addJavaEventListener, createDispatchChangeEvent, createDispatchDataEvent, createDispatchEvent, dispatchEvent, hasEventListeners, removeEventListener

Methods inherited from class qx.core.Object

_disposeFields, _disposeObjectDeep, _disposeObjects, base, dispose, get, getDisposed, isDisposed, reset, self, set, toHashCode, toString_

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolTip

public ToolTip()

ToolTip

public ToolTip(java.lang.Object vLabel)

ToolTip

public ToolTip(java.lang.Object vLabel,
               java.lang.Object vIcon)

Method Detail

_afterAppear

public void _afterAppear()

Callback method for the “afterAppear” event.

If the property Popup.restrictToPageOnOpen is set to true the tooltip gets repositioned to ensure it is displayed within the boundaries of the ClientDocument.

Overrides:

_afterAppear in class Popup

_applyBoundToWidget

public void _applyBoundToWidget(java.lang.Object value,
                                java.lang.Object old)

_applyHideInterval

public void _applyHideInterval(java.lang.Object value,
                               java.lang.Object old)

_applyShowInterval

public void _applyShowInterval(java.lang.Object value,
                               java.lang.Object old)

_beforeAppear

public void _beforeAppear()

Callback method for the “beforeAppear” event.

Does two things: stops the timer for the show interval and starts the timer for the hide interval.

Overrides:

_beforeAppear in class Popup

_beforeDisappear

public void _beforeDisappear()

Callback method for the “beforeDisappear” event.

Stops the timer for the hide interval.

Overrides:

_beforeDisappear in class Popup

_onhidetimer

public java.lang.Object _onhidetimer(Event e)

Callback method for the “interval” event of the hide timer.

Hides the tooltip by calling the corresponding Widget.hide() method.

_onmouseover

public void _onmouseover(MouseEvent e)

Callback method for the “mouseOver” event.

If property #hideOnOver is enabled the tooltip gets hidden

_onshowtimer

public void _onshowtimer(Event e)

Callback method for the “interval” event of the show timer.

Positions the tooltip (sets left and top) and calls the Widget.show() method.

_startHideTimer

public void _startHideTimer()

Utility method to start the timer for the hide interval (if the timer is disabled)

_startShowTimer

public void _startShowTimer()

Utility method to start the timer for the show interval (if the timer is disabled)

_stopHideTimer

public void _stopHideTimer()

Utility method to stop the timer for the hide interval (if the timer is enabled)

_stopShowTimer

public void _stopShowTimer()

Utility method to stop the timer for the show interval (if the timer is enabled)

getBoundToWidget

public Widget getBoundToWidget()

Returns the (computed) value of the property boundToWidget.

For further details take a look at the property definition: boundToWidget.

getHideInterval

public java.lang.Integer getHideInterval()

Returns the (computed) value of the property hideInterval.

For further details take a look at the property definition: hideInterval.

getHideOnHover

public boolean getHideOnHover()

Returns the (computed) value of the property hideOnHover.

For further details take a look at the property definition: hideOnHover.

getMousePointerOffsetX

public java.lang.Integer getMousePointerOffsetX()

Returns the (computed) value of the property mousePointerOffsetX.

For further details take a look at the property definition: mousePointerOffsetX.

getMousePointerOffsetY

public java.lang.Integer getMousePointerOffsetY()

Returns the (computed) value of the property mousePointerOffsetY.

For further details take a look at the property definition: mousePointerOffsetY.

getShowInterval

public java.lang.Integer getShowInterval()

Returns the (computed) value of the property showInterval.

For further details take a look at the property definition: showInterval.

initBoundToWidget

public void initBoundToWidget(Widget arg)

Calls the apply method and dispatches the change event of the property boundToWidget with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: boundToWidget.

initHideInterval

public void initHideInterval(java.lang.Integer arg)

Calls the apply method and dispatches the change event of the property hideInterval with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: hideInterval.

initHideOnHover

public void initHideOnHover(boolean arg)

Calls the apply method and dispatches the change event of the property hideOnHover with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: hideOnHover.

initMousePointerOffsetX

public void initMousePointerOffsetX(java.lang.Integer arg)

Calls the apply method and dispatches the change event of the property mousePointerOffsetX with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: mousePointerOffsetX.

initMousePointerOffsetY

public void initMousePointerOffsetY(java.lang.Integer arg)

Calls the apply method and dispatches the change event of the property mousePointerOffsetY with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: mousePointerOffsetY.

initShowInterval

public void initShowInterval(java.lang.Integer arg)

Calls the apply method and dispatches the change event of the property showInterval with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: showInterval.

isHideOnHover

public boolean isHideOnHover()

Check whether the (computed) value of the boolean property hideOnHover equals true.

For further details take a look at the property definition: hideOnHover.

resetBoundToWidget

public void resetBoundToWidget()

Resets the user value of the property boundToWidget.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: boundToWidget.

resetHideInterval

public void resetHideInterval()

Resets the user value of the property hideInterval.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: hideInterval.

resetHideOnHover

public void resetHideOnHover()

Resets the user value of the property hideOnHover.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: hideOnHover.

resetMousePointerOffsetX

public void resetMousePointerOffsetX()

Resets the user value of the property mousePointerOffsetX.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: mousePointerOffsetX.

resetMousePointerOffsetY

public void resetMousePointerOffsetY()

Resets the user value of the property mousePointerOffsetY.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: mousePointerOffsetY.

resetShowInterval

public void resetShowInterval()

Resets the user value of the property showInterval.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: showInterval.

setBoundToWidget

public void setBoundToWidget(Widget arg)

Sets the user value of the property boundToWidget.

For further details take a look at the property definition: boundToWidget.

setHideInterval

public void setHideInterval(java.lang.Integer arg)

Sets the user value of the property hideInterval.

For further details take a look at the property definition: hideInterval.

setHideOnHover

public void setHideOnHover(boolean arg)

Sets the user value of the property hideOnHover.

For further details take a look at the property definition: hideOnHover.

setMousePointerOffsetX

public void setMousePointerOffsetX(java.lang.Integer arg)

Sets the user value of the property mousePointerOffsetX.

For further details take a look at the property definition: mousePointerOffsetX.

setMousePointerOffsetY

public void setMousePointerOffsetY(java.lang.Integer arg)

Sets the user value of the property mousePointerOffsetY.

For further details take a look at the property definition: mousePointerOffsetY.

setShowInterval

public void setShowInterval(java.lang.Integer arg)

Sets the user value of the property showInterval.

For further details take a look at the property definition: showInterval.

toggleHideOnHover

public boolean toggleHideOnHover()

Toggles the (computed) value of the boolean property hideOnHover.

For further details take a look at the property definition: hideOnHover.