Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.charts.events 
LegendMouseEvent 
Packagemx.charts.events
Classpublic class LegendMouseEvent
InheritanceLegendMouseEvent Inheritance MouseEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The LegendMouseEvent class represents event objects that are specific to the chart legend components. such as when a legend item is clicked on.

See also



Public Properties
 PropertyDefined By
 InheritedaltKey : Boolean
Indicates whether the Alt key is active (true) or inactive (false).
MouseEvent
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 InheritedbuttonDown : Boolean
Indicates whether the primary mouse button is pressed (true) or not (false).
MouseEvent
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 InheritedAIR-only clickCount : int
[read-only] Indicates whether or not the mouse down event is part of a multi-click sequence.
MouseEvent
 InheritedAIR-only commandKey : Boolean
Indicates whether the command key is activated (Mac only.) The value of property commandKey will have the same value as property ctrlKey on the Mac.
MouseEvent
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedAIR-only controlKey : Boolean
Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
MouseEvent
 InheritedctrlKey : Boolean
On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).
MouseEvent
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 Inheriteddelta : int
Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel.
MouseEvent
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 InheritedisRelatedObjectInaccessible : Boolean
If true, the relatedObject property is set to null for reasons related to security sandboxes.
MouseEvent
  item : LegendItem
The item in the Legend on which this event was triggered.
LegendMouseEvent
 InheritedlocalX : Number
The horizontal coordinate at which the event occurred relative to the containing sprite.
MouseEvent
 InheritedlocalY : Number
The vertical coordinate at which the event occurred relative to the containing sprite.
MouseEvent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrelatedObject : InteractiveObject
A reference to a display list object that is related to the event.
MouseEvent
 InheritedshiftKey : Boolean
Indicates whether the Shift key is active (true) or inactive (false).
MouseEvent
 InheritedstageX : Number
[read-only] The horizontal coordinate at which the event occurred in global Stage coordinates.
MouseEvent
 InheritedstageY : Number
[read-only] The vertical coordinate at which the event occurred in global Stage coordinates.
MouseEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
LegendMouseEvent(type:String, triggerEvent:MouseEvent = null, item:LegendItem = null)
Constructor.
LegendMouseEvent
 Inherited
[override] Creates a copy of the MouseEvent object and sets the value of each property to match that of the original.
MouseEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns a string that contains all the properties of the MouseEvent object.
MouseEvent
 Inherited
Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.
MouseEvent
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
 InheritedACTIVATE : String = "activate"
[static] The ACTIVATE constant defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] The Event.ADDED constant defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.
Event
 InheritedCANCEL : String = "cancel"
[static] The Event.CANCEL constant defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] The Event.CHANGE constant defines the value of the type property of a change event object.
Event
 InheritedCLEAR : String = "clear"
[static] The Event.CLEAR constant efines the value of the type property of a clear event object.
Event
 InheritedCLICK : String = "click"
[static] Defines the value of the type property of a click event object.
MouseEvent
 InheritedCLOSE : String = "close"
[static] The Event.CLOSE constant defines the value of the type property of a close event object.
Event
 InheritedAIR-only CLOSING : String = "closing"
[static] The Event.CLOSING constant defines the value of the type property of a closing event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] The Event.COMPLETE constant defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] The Event.CONNECT constant defines the value of the type property of a connect event object.
Event
 InheritedAIR-only CONTEXT_MENU : String = "contextMenu"
[static] The MouseEvent.CONTEXT_MENU constant defines the value of the type property of a contextMenu event object.
MouseEvent
 InheritedCOPY : String = "copy"
[static] Defines the value of the type property of a copy event object.
Event
 InheritedCUT : String = "cut"
[static] Defines the value of the type property of a cut event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
Event
 InheritedAIR-only DISPLAYING : String = "displaying"
[static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
Event
 InheritedDOUBLE_CLICK : String = "doubleClick"
[static] Defines the value of the type property of a doubleClick event object.
MouseEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
Event
 InheritedAIR-only EXITING : String = "exiting"
[static] The Event.EXITING constant defines the value of the type property of an exiting event object.
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
Event
 InheritedAIR-only HTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
Event
 InheritedAIR-only HTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.
Event
 InheritedAIR-only HTML_RENDER : String = "htmlRender"
[static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
Event
 InheritedID3 : String = "id3"
[static] The Event.ID3 constant defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] The Event.INIT constant defines the value of the type property of an init event object.
Event
  ITEM_CLICK : String = "itemClick"
[static] Event type constant; indicates that the user clicked the mouse button over a legend item.
LegendMouseEvent
  ITEM_MOUSE_DOWN : String = "itemMouseDown"
[static] Event type constant; indicates that the user clicked the mouse button over a legend item.
LegendMouseEvent
  ITEM_MOUSE_OUT : String = "itemMouseOut"
[static] Event type constant; indicates that the user rolled the mouse pointer away from a legend item.
LegendMouseEvent
  ITEM_MOUSE_OVER : String = "itemMouseOver"
[static] Event type constant; indicates that the user rolled the mouse pointer over a legend item.
LegendMouseEvent
  ITEM_MOUSE_UP : String = "itemMouseUp"
[static] Event type constant; indicates that the user released the mouse button while over a legend item.
LegendMouseEvent
 InheritedAIR-only LOCATION_CHANGE : String = "locationChange"
[static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
Event
 InheritedAIR-only MIDDLE_CLICK : String = "middleClick"
[static] Defines the value of the type property of a middleClick event object.
MouseEvent
 InheritedAIR-only MIDDLE_MOUSE_DOWN : String = "middleMouseDown"
[static] Defines the value of the type property of a middleMouseDown event object.
MouseEvent
 InheritedAIR-only MIDDLE_MOUSE_UP : String = "middleMouseUp"
[static] Defines the value of the type property of a middleMouseUp event object.
MouseEvent
 InheritedMOUSE_DOWN : String = "mouseDown"
[static] Defines the value of the type property of a mouseDown event object.
MouseEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
Event
 InheritedMOUSE_MOVE : String = "mouseMove"
[static] Defines the value of the type property of a mouseMove event object.
MouseEvent
 InheritedMOUSE_OUT : String = "mouseOut"
[static] Defines the value of the type property of a mouseOut event object.
MouseEvent
 InheritedMOUSE_OVER : String = "mouseOver"
[static] Defines the value of the type property of a mouseOver event object.
MouseEvent
 InheritedMOUSE_UP : String = "mouseUp"
[static] Defines the value of the type property of a mouseUp event object.
MouseEvent
 InheritedMOUSE_WHEEL : String = "mouseWheel"
[static] Defines the value of the type property of a mouseWheel event object.
MouseEvent
 InheritedAIR-only NETWORK_CHANGE : String = "networkChange"
[static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
Event
 InheritedOPEN : String = "open"
[static] The Event.OPEN constant defines the value of the type property of an open event object.
Event
 InheritedPASTE : String = "paste"
[static] The Event.PASTE constant defines the value of the type property of a paste event object.
Event
 InheritedREMOVED : String = "removed"
[static] The Event.REMOVED constant defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] The Event.RENDER constant defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] The Event.RESIZE constant defines the value of the type property of a resize event object.
Event
 InheritedAIR-only RIGHT_CLICK : String = "rightClick"
[static] Defines the value of the type property of a rightClick event object.
MouseEvent
 InheritedAIR-only RIGHT_MOUSE_DOWN : String = "rightMouseDown"
[static] Defines the value of the type property of a rightMouseDown event object.
MouseEvent
 InheritedAIR-only RIGHT_MOUSE_UP : String = "rightMouseUp"
[static] Defines the value of the type property of a rightMouseUp event object.
MouseEvent
 InheritedROLL_OUT : String = "rollOut"
[static] Defines the value of the type property of a rollOut event object.
MouseEvent
 InheritedROLL_OVER : String = "rollOver"
[static] Defines the value of the type property of a rollOver event object.
MouseEvent
 InheritedSCROLL : String = "scroll"
[static] The Event.SCROLL constant defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] The Event.SELECT constant defines the value of the type property of a select event object.
Event
 InheritedSELECT_ALL : String = "selectAll"
[static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
Event
 InheritedAIR-only STANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
Event
 InheritedAIR-only STANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
Event
 InheritedAIR-only STANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] The Event.UNLOAD constant defines the value of the type property of an unload event object.
Event
 InheritedAIR-only USER_IDLE : String = "userIdle"
[static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
Event
 InheritedAIR-only USER_PRESENT : String = "userPresent"
[static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
Event
Property Detail

item

property
public var item:LegendItem

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The item in the Legend on which this event was triggered.

Constructor Detail

LegendMouseEvent

()Constructor
public function LegendMouseEvent(type:String, triggerEvent:MouseEvent = null, item:LegendItem = null)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Parameters
type:String — The type of Mouse event. If a mouse event type is given it would be converted into a LegendMouseEvent type.
 
triggerEvent:MouseEvent (default = null) — The MouseEvent that triggered this LegentMouseEvent.
 
item:LegendItem (default = null) — The item in the Legend on which this event was triggered.
Constant Detail

ITEM_CLICK

Constant
public static const ITEM_CLICK:String = "itemClick"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Event type constant; indicates that the user clicked the mouse button over a legend item.

ITEM_MOUSE_DOWN

Constant 
public static const ITEM_MOUSE_DOWN:String = "itemMouseDown"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Event type constant; indicates that the user clicked the mouse button over a legend item.

ITEM_MOUSE_OUT

Constant 
public static const ITEM_MOUSE_OUT:String = "itemMouseOut"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Event type constant; indicates that the user rolled the mouse pointer away from a legend item.

ITEM_MOUSE_OVER

Constant 
public static const ITEM_MOUSE_OVER:String = "itemMouseOver"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Event type constant; indicates that the user rolled the mouse pointer over a legend item.

ITEM_MOUSE_UP

Constant 
public static const ITEM_MOUSE_UP:String = "itemMouseUp"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Event type constant; indicates that the user released the mouse button while over a legend item.