mx.events.ToolTipEvent

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

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.

See also

mx.managers.ToolTipManager
mx.core.UIComponent

Public Properties

	Property		Defined by
		toolTip : IToolTip The ToolTip object to which this event applies.	ToolTipEvent

Public Methods

	Method		Defined by
		ToolTipEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, toolTip:IToolTip = null) Constructor.	ToolTipEvent

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:IToolTip

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:IToolTip = null)

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: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"

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"

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"

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"

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"

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"

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.

(c) Copyright 2010 DWUser.com - http://www.dwuser.com/flashslideshow/