Packagecom.ghostwire.ui.managers
Classpublic class uiToolTips

The uiToolTips manager manages the use of tool tips. This class works hand-in-hand with the toolTip property of the uiComponent class to implement this feature.

uiToolTips cannot be instantiated via the new operator. To access the singleton instance, use uiToolTips.manager.

To enable tool tips in your application, you must call the initialize() method (once) at the beginning of your application:

  uiToolTips.initialize(stage);

The uiToolTips manager works by monitoring mouse movement and checking if the topmost display object under the mouse cursor has a toolTip property defined. If the toolTip property exists and returns a value, the uiToolTips manager shows a tool tip based on that value. The tool tip is dismissed when the mouse cursor moves out of the bounds of the control or the mouse is pressed down.

The tool tip is rendered within a uiFrame container. The skin property of this container is set to "ToolTip". You may therefore set preferences such as background and padding values via "rules.xml".

~ This class is available in Aspire UI Components Standard Edition ~



Public Properties
 PropertyDefined by
  manager : uiToolTips
[static][read-only] Indicates the shared instance of the uiToolTips singleton class.
uiToolTips
  showDelay : int
Indicates the time, in milliseconds, that the mouse cursor must stay stationary over an interactive object before its tool tip (if any) is shown.
uiToolTips
Public Methods
 MethodDefined by
  
hide():void
Dismisses the currently displayed tooltip.
uiToolTips
  
initialize(stage:Stage):void
[static] Initializes the uiToolTips class.
uiToolTips
Property detail
managerproperty
manager:uiToolTips  [read-only]

Indicates the shared instance of the uiToolTips singleton class.

Implementation
    public static function get manager():uiToolTips
showDelayproperty 
showDelay:int  [read-write]

Indicates the time, in milliseconds, that the mouse cursor must stay stationary over an interactive object before its tool tip (if any) is shown.

This value does not affect "scrubbing", which occurs when a tool tip is already shown and the mouse cursor is moved to an adjacent tool tip enabled interactive object. During scrubbing, the change in tool tip happens almost instantly instead of waiting for the mouse cursor to stay stationary again.

The default value is 750.

Implementation
    public function get showDelay():int
    public function set showDelay(value:int):void
Method detail
hide()method
public function hide():void

Dismisses the currently displayed tooltip.

initialize()method 
public static function initialize(stage:Stage):void

Initializes the uiToolTips class. Your application code must call this once.

Parameters
stage:Stage — A reference to the document Stage. Each Flash application has only one Stage object - the stage property of every display object on the display list refers to the same Stage object.