ToolTipEvent

Package	mx.events
Class	public class ToolTipEvent
Inheritance	ToolTipEvent Event Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The ToolTipEvent class represents ToolTip events, which are generated by the ToolTipManager class. The ToolTipManager class calls the dispatchEvent() method of the object to which the tip applies to dispatch the event.

More examples

Manually dispatching events
Using ToolTip events

Learn more

About Flex events

Related API Elements

mx.managers.ToolTipManager
mx.core.UIComponent

Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		target : Object [read-only] The event target.	Event
		toolTip : mx.core:IToolTip The ToolTip object to which this event applies.	ToolTipEvent
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		ToolTipEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, toolTip:mx.core:IToolTip = null) Constructor.	ToolTipEvent
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		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
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		TOOL_TIP_CREATE : String = "toolTipCreate" [static] The ToolTipEvent.TOOL_TIP_CREATE constant defines the value of the type property of the event object for a toolTipCreate event.	ToolTipEvent
		TOOL_TIP_END : String = "toolTipEnd" [static] The ToolTipEvent.TOOL_TIP_END constant defines the value of the type property of the event object for a toolTipEnd event.	ToolTipEvent
		TOOL_TIP_HIDE : String = "toolTipHide" [static] The ToolTipEvent.TOOL_TIP_HIDE constant defines the value of the type property of the event object for a toolTipHide event.	ToolTipEvent
		TOOL_TIP_SHOW : String = "toolTipShow" [static] The ToolTipEvent.TOOL_TIP_SHOW constant defines the value of the type property of the event object for a toolTipShow event.	ToolTipEvent
		TOOL_TIP_SHOWN : String = "toolTipShown" [static] The ToolTipEvent.TOOL_TIP_SHOWN constant defines the value of the type property of the event object for a toolTipShown event.	ToolTipEvent
		TOOL_TIP_START : String = "toolTipStart" [static] The ToolTipEvent.TOOL_TIP_START constant defines the value of the type property of the event object for a toolTipStart event.	ToolTipEvent

Property Detail

toolTip

property

public var toolTip:mx.core:IToolTip

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The ToolTip object to which this event applies. This object is normally an instance of ToolTip object, but can be any UIComponent object.

Constructor Detail

ToolTipEvent

()

Constructor

public function ToolTipEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, toolTip:mx.core:IToolTip = null)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Parameters

	`type:String` — The event type; indicates the action that caused the event.

	`bubbles:Boolean` (default = `false`) — Specifies whether the event can bubble up the display list hierarchy.

	`cancelable:Boolean` (default = `false`) — Specifies whether the behavior associated with the event can be prevented.

	`toolTip:mx.core:IToolTip` (default = `null`) — The ToolTip object to which this event applies.

Constant Detail

TOOL_TIP_CREATE

Constant

public static const TOOL_TIP_CREATE:String = "toolTipCreate"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The ToolTipEvent.TOOL_TIP_CREATE constant defines the value of the type property of the event object for a toolTipCreate event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`tooltip`	The ToolTip object to which this event applies.

TOOL_TIP_END

Constant

public static const TOOL_TIP_END:String = "toolTipEnd"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The ToolTipEvent.TOOL_TIP_END constant defines the value of the type property of the event object for a toolTipEnd event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`tooltip`	The ToolTip object to which this event applies.

TOOL_TIP_HIDE

Constant

public static const TOOL_TIP_HIDE:String = "toolTipHide"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The ToolTipEvent.TOOL_TIP_HIDE constant defines the value of the type property of the event object for a toolTipHide event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`tooltip`	The ToolTip object to which this event applies.

TOOL_TIP_SHOW

Constant

public static const TOOL_TIP_SHOW:String = "toolTipShow"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The ToolTipEvent.TOOL_TIP_SHOW constant defines the value of the type property of the event object for a toolTipShow event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`tooltip`	The ToolTip object to which this event applies.

TOOL_TIP_SHOWN

Constant

public static const TOOL_TIP_SHOWN:String = "toolTipShown"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The ToolTipEvent.TOOL_TIP_SHOWN constant defines the value of the type property of the event object for a toolTipShown event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`tooltip`	The ToolTip object to which this event applies.

TOOL_TIP_START

Constant

public static const TOOL_TIP_START:String = "toolTipStart"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The ToolTipEvent.TOOL_TIP_START constant defines the value of the type property of the event object for a toolTipStart event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`tooltip`	The ToolTip object to which this event applies.

Legal Notices | Online Privacy Policy

ToolTipEvent - AS3 Flex

Classes x

toolTip

ToolTipEvent

TOOL_TIP_CREATE

TOOL_TIP_END

TOOL_TIP_HIDE

TOOL_TIP_SHOW

TOOL_TIP_SHOWN

TOOL_TIP_START