mx.managers.ToolTipManager - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.managers
Class	public class ToolTipManager
Inheritance	ToolTipManager EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The ToolTipManager lets you set basic ToolTip and error tip functionality, such as display delay and the disabling of ToolTips.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : DisplayObject [static] The UIComponent that is currently displaying a ToolTip, or null if none is.	ToolTipManager
		currentToolTip : mx.core:IToolTip [static] The ToolTip object that is currently visible, or null if none is shown.	ToolTipManager
		enabled : Boolean [static] If true, the ToolTipManager will automatically show ToolTips when the user moves the mouse pointer over components.	ToolTipManager
		hideDelay : Number [static] The amount of time, in milliseconds, that Flex waits to hide the ToolTip after it appears.	ToolTipManager
		hideEffect : IAbstractEffect [static] The effect that plays when a ToolTip is hidden, or null if the ToolTip should disappear with no effect.	ToolTipManager
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		scrubDelay : Number [static] The amount of time, in milliseconds, that a user can take when moving the mouse between controls before Flex again waits for the duration of showDelay to display a ToolTip.	ToolTipManager
		showDelay : Number [static] The amount of time, in milliseconds, that Flex waits before displaying the ToolTip box once a user moves the mouse over a component that has a ToolTip.	ToolTipManager
		showEffect : IAbstractEffect [static] The effect that plays when a ToolTip is shown, or null if the ToolTip should appear with no effect.	ToolTipManager
		toolTipClass : Class [static] The class to use for creating ToolTips.	ToolTipManager

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):mx.core:IToolTip [static] Creates an instance of the ToolTip class with the specified text and displays it at the specified location in stage coordinates.	ToolTipManager
		destroyToolTip(toolTip:mx.core:IToolTip):void [static] Destroys a specified ToolTip that was created by the createToolTip() method.	ToolTipManager
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

currentTarget

property

currentTarget:DisplayObject

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The UIComponent that is currently displaying a ToolTip, or null if none is.

Implementation
public static function get currentTarget():DisplayObject
public static function set currentTarget(value:DisplayObject):void

currentToolTip

property

currentToolTip:mx.core:IToolTip

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The ToolTip object that is currently visible, or null if none is shown.

Implementation
public static function get currentToolTip():mx.core:IToolTip
public static function set currentToolTip(value:mx.core:IToolTip):void

enabled

property

enabled:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

If true, the ToolTipManager will automatically show ToolTips when the user moves the mouse pointer over components. If false, no ToolTips will be shown.

The default value is true.

Implementation
public static function get enabled():Boolean
public static function set enabled(value:Boolean):void

hideDelay

property

hideDelay:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The amount of time, in milliseconds, that Flex waits to hide the ToolTip after it appears. Once Flex hides a ToolTip, the user must move the mouse off the component and then back onto it to see the ToolTip again. If you set hideDelay to Infinity, Flex does not hide the ToolTip until the user triggers an event, such as moving the mouse off of the component.

The default value is 10000.

Implementation
public static function get hideDelay():Number
public static function set hideDelay(value:Number):void

hideEffect

property

hideEffect:IAbstractEffect

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The effect that plays when a ToolTip is hidden, or null if the ToolTip should disappear with no effect.

The default value is null.

Implementation
public static function get hideEffect():IAbstractEffect
public static function set hideEffect(value:IAbstractEffect):void

scrubDelay

property

scrubDelay:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The amount of time, in milliseconds, that a user can take when moving the mouse between controls before Flex again waits for the duration of showDelay to display a ToolTip.

This setting is useful if the user moves quickly from one control to another; after displaying the first ToolTip, Flex will display the others immediately rather than waiting. The shorter the setting for scrubDelay, the more likely that the user must wait for an amount of time specified by showDelay in order to see the next ToolTip. A good use of this property is if you have several buttons on a toolbar, and the user will quickly scan across them to see brief descriptions of their functionality.

The default value is 100.

Implementation
public static function get scrubDelay():Number
public static function set scrubDelay(value:Number):void

showDelay

property

showDelay:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The amount of time, in milliseconds, that Flex waits before displaying the ToolTip box once a user moves the mouse over a component that has a ToolTip. To make the ToolTip appear instantly, set showDelay to 0.

The default value is 500.

Implementation
public static function get showDelay():Number
public static function set showDelay(value:Number):void

showEffect

property

showEffect:IAbstractEffect

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The effect that plays when a ToolTip is shown, or null if the ToolTip should appear with no effect.

The default value is null.

Implementation
public static function get showEffect():IAbstractEffect
public static function set showEffect(value:IAbstractEffect):void

toolTipClass

property

toolTipClass:Class

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The class to use for creating ToolTips.

The default value is mx.controls.ToolTip.

Implementation
public static function get toolTipClass():Class
public static function set toolTipClass(value:Class):void

Method Detail

createToolTip

()

method

 public static function createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):mx.core:IToolTip

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Creates an instance of the ToolTip class with the specified text and displays it at the specified location in stage coordinates.

ToolTips appear in their own layer, on top of everything except cursors.

The standard way of using ToolTips is to let the ToolTipManager automatically show and hide them as the user moves the mouse over the objects that have the toolTip property set. You can turn off this automatic ToolTip management by setting the ToolTipManager's enabled property to false.

By contrast, this method—along with destroyToolTip()—gives you programmatic control over ToolTips. You can show them when and where you choose, and you can even show more than one at once if you need to. (The ToolTipManager never does this, because it is generally confusing to the user).

This method first creates a new instance of ToolTip and calls the addChild() method to put it into the SystemManager's toolTips layer. If you are showing an error tip, it sets the appropriate styles. Then it sets the text for the ToolTip, sizes the ToolTip based on its text, and positions it where you specified.

You must save the reference to the ToolTip that this method returns so that you can pass it to the destroyToolTip() method.

Parameters

	`text:String` — The text to display in the ToolTip instance.

	`x:Number` — The horizontal coordinate of the ToolTip in stage coordinates. In case of multiple stages, the relevant stage is determined from the `context` argument.

	`y:Number` — The vertical coordinate of the ToolTip in stage coordinates. In case of multiple stages, the relevant stage is determined from the `context` argument.

	`errorTipBorderStyle:String` (default = `null`) — The border style of an error tip. This method argument can be null, "errorTipRight", "errorTipAbove", or "errorTipBelow". If it is null, then the `createToolTip()` method creates a normal ToolTip. If it is "errorTipRight", "errorTipAbove", or "errorTipBelow", then the `createToolTip()` method creates an error tip, and this parameter determines where the arrow of the error tip points to (the error's target). For example, if you pass "errorTipRight", Flex positions the error tip (via the x and y arguments) to the right of the error target; the arrow is on the left edge of the error tip.

	`context:IUIComponent` (default = `null`) — Determines which StyleManager is used. Typically, you pass the object on which the ToolTip appears, so that the ToolTip's StyleManager is the same one that is used by that object.

Returns

mx.core:IToolTip — The newly created ToolTip.

destroyToolTip

()

method

public static function destroyToolTip(toolTip:mx.core:IToolTip):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Destroys a specified ToolTip that was created by the createToolTip() method.

This method calls the removeChild() method to remove the specified ToolTip from the SystemManager's ToolTips layer. It will then be garbage-collected unless you keep a reference to it.

You should not call this method on the ToolTipManager's currentToolTip.

Parameters

toolTip:mx.core:IToolTip — The ToolTip instance to destroy.