Packagefeathers.core
Classpublic class ToolTipManager
InheritanceToolTipManager Inheritance Object

Product Version : Feathers 3.0.0

Manages tool tips. Should not be enabled on touch screens, since TouchPhase.HOVER is not dispatched for touches.

See also

Tool tips in Feathers
feathers.core.FeathersControl.toolTip


Public Properties
 PropertyDefined By
  toolTipManagerFactory : Function
[static] A function that creates a tool tip manager.
ToolTipManager
Public Methods
 MethodDefined By
  
defaultToolTipManagerFactory(root:DisplayObjectContainer):IToolTipManager
[static] The default factory that creates a tool tip manager.
ToolTipManager
  
disableAll():void
Disables tool tip management on all stages where it has previously been enabled.
ToolTipManager
  
[static] Returns the active tool tip manager for the specified Starling stage.
ToolTipManager
  
isEnabledForStage(stage:Stage):Boolean
[static] Determines if the tool tip manager is enabled or disabled for the specified Starling stage.
ToolTipManager
  
setEnabledForStage(stage:Stage, isEnabled:Boolean):void
[static] Enables or disables toll tip management on the specified Starling stage.
ToolTipManager
Property Detail
toolTipManagerFactoryproperty
public static var toolTipManagerFactory:Function

A function that creates a tool tip manager.

This function is expected to have the following signature:

function():IToolTipManager

In the following example, the tool tip manager factory is modified:

ToolTipManager.toolTipManagerFactory = function(root:DisplayObjectContainer):IToolTipManager
{
    return new CustomToolTipManager(); //a custom class that implements IToolTipManager
};

See also

Method Detail
defaultToolTipManagerFactory()method
public static function defaultToolTipManagerFactory(root:DisplayObjectContainer):IToolTipManager

The default factory that creates a tool tip manager.

Parameters

root:DisplayObjectContainer

Returns
IToolTipManager

See also

disableAll()method 
public function disableAll():void

Disables tool tip management on all stages where it has previously been enabled.

getToolTipManagerForStage()method 
public static function getToolTipManagerForStage(stage:Stage):IToolTipManager

Returns the active tool tip manager for the specified Starling stage. May return null if tool tip management has not been enabled for the specified stage.

Parameters

stage:Stage

Returns
IToolTipManager

See also

isEnabledForStage()method 
public static function isEnabledForStage(stage:Stage):Boolean

Determines if the tool tip manager is enabled or disabled for the specified Starling stage.

Parameters

stage:Stage

Returns
Boolean

See also

setEnabledForStage()method 
public static function setEnabledForStage(stage:Stage, isEnabled:Boolean):void

Enables or disables toll tip management on the specified Starling stage. For mobile apps, the tool tip manager should generally remain disabled. For desktop apps, it is recommended to enable the tool tip manager.

In the following example, tool tip management is enabled:

ToolTipManager.setEnabledForStage(stage, true);

Parameters

stage:Stage
 
isEnabled:Boolean

See also