Main Page | Packages | Class Tree | Index | Help

xp.system

class ToolTipService

Object
  |
  +--xp.system.IdleTimer
        |
        +--xp.system.ToolTipService


class ToolTipService
extends IdleTimer

Provides a system implementation for displaying a ToolTip

Controls the display of a system Tooltip over controls when the mouse is idle
A ToolTip represents a small rectangular pop-up window that displays a brief description of a control's purpose when the mouse hovers over the control. The ToolTipService class provides properties that enable you to modify how long and how quickly a ToolTip window is displayed. The AutoPopDelay determines how long a ToolTip window is displayed; the InitialDelay and ReshowDelay properties determine the delay before a ToolTip window is displayed.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public
autoPopDelay: Number
Gets or sets the period of time the ToolTip remains visible if the mouse pointer is stationary within a control with specified ToolTip text.

public
initialDelay: Number
Gets or sets the time that passes before the ToolTip appears.

public
reshowDelay: Number
Gets or sets the length of time that must transpire before subsequent ToolTip windows appear as the mouse pointer moves from one control to another.

public
tooltip: ToolTip
The tooltip associated with this service

Fields inherited from class xp.system.IdleTimer

idleHandler, interval

Properties inherited from class xp.system.IdleTimer

isActive

Constructor

public
ToolTipService ( )
Construtcor *

Method Summary

public static
getService ( )


public
getTooltip ( ): ToolTip
Returns a reference to the system tooltip

public
idleHandler ( e: StateEvent ): Void
Event handler for the idle event.



Field Documentation

autoPopDelay

public var autoPopDelay: Number
Gets or sets the period of time the ToolTip remains visible if the mouse pointer is stationary within a control with specified ToolTip text.

The period of time (in milliseconds) that the ToolTip remains visible when the mouse pointer is stationary within a control. The default value is 5000

initialDelay

public var initialDelay: Number
Gets or sets the time that passes before the ToolTip appears.

reshowDelay

public var reshowDelay: Number
Gets or sets the length of time that must transpire before subsequent ToolTip windows appear as the mouse pointer moves from one control to another.

This property enables you to shorten or lengthen the time that the ToolTip waits before displaying a ToolTip window after a previous ToolTip window is displayed. The first time a ToolTip window is displayed the value of the InitialDelay property is used to determine the delay to apply before initially showing the ToolTip window. When a ToolTip window is currently being displayed and the user moves the cursor to another control that displays a ToolTip window, the value of the ReshowDelay property is used before showing the ToolTip for the new control. The ToolTip window from the previous control must still be displayed in order for the delay specified in the ReshowDelay property to be used; otherwise the InitialDelay property value is used.

tooltip

public var tooltip: ToolTip
The tooltip associated with this service


Constructor Documentation

ToolTipService

public function ToolTipService()
Construtcor *


Method Documentation

getService

public static function getService()

getTooltip

public function getTooltip(): ToolTip
Returns a reference to the system tooltip

Returns:
The system tooltip

idleHandler

public function idleHandler(e: StateEvent): Void
Event handler for the idle event.

Called when the idle state changes, controls the display of the tooltip

Overrides:

Parameters:
e
The event object

The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc