Packagemx.events
Classpublic class ToolTipEvent
InheritanceToolTipEvent Inheritance flash.events.Event

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.

See also

mx.managers.ToolTipManager
mx.core.UIComponent

Public Properties
 PropertyDefined By
  toolTip : IToolTip
The ToolTip object to which this event applies.
ToolTipEvent
Public Methods
 MethodDefined By
  
ToolTipEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, toolTip:IToolTip = null)
Constructor.
ToolTipEvent
Public Constants
 ConstantDefined 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
toolTipproperty
public var toolTip: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: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:IToolTip (default = null) — The ToolTip object to which this event applies.
Constant Detail
TOOL_TIP_CREATEConstant
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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
targetThe 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.
tooltipThe ToolTip object to which this event applies.

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

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
targetThe 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.
tooltipThe ToolTip object to which this event applies.

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

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
targetThe 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.
tooltipThe ToolTip object to which this event applies.

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

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
targetThe 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.
tooltipThe ToolTip object to which this event applies.

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

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
targetThe 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.
tooltipThe ToolTip object to which this event applies.

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

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
targetThe 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.
tooltipThe ToolTip object to which this event applies.





Mon Dec 24 2012, 01:18 PM +11:00