mx.events.FlexMouseEvent (Flex™ 2 Language Reference)

	Property	Defined by
		altKey : Boolean Reserved for future use.	MouseEvent
		bubbles : Boolean Indicates whether an event is a bubbling event.	Event
		buttonDown : Boolean Indicates whether the primary mouse button is pressed (`true`) or not (`false`).	MouseEvent
		cancelable : Boolean 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
		ctrlKey : Boolean Indicates whether the Control key is active (`true`) or inactive (`false`).	MouseEvent
		currentTarget : Object The object that is actively processing the Event object with an event listener.	Event
		delta : int Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel.	MouseEvent
		eventPhase : uint The current phase in the event flow.	Event
		localX : Number The horizontal coordinate at which the event occurred relative to the containing sprite.	MouseEvent
		localY : Number The vertical coordinate at which the event occurred relative to the containing sprite.	MouseEvent
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		relatedObject : InteractiveObject A reference to a display list object that is related to the event.	MouseEvent
		shiftKey : Boolean Indicates whether the Shift key is active (`true`) or inactive (`false`).	MouseEvent
		stageX : Number The horizontal coordinate at which the event occurred in global Stage coordinates.	MouseEvent
		stageY : Number The vertical coordinate at which the event occurred in global Stage coordinates.	MouseEvent
		target : Object The event target.	Event
		type : String The type of event.	Event

	Method	Defined by
		FlexMouseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, localX:Number = 0, localY:Number = 0, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0) Constructor.	FlexMouseEvent
		clone():Event Creates a copy of the MouseEvent object and sets the value of each property to match that of the original.	MouseEvent
		formatToString(className:String, ... arguments):String A utility function for implementing the `toString()` method in your custom Event class.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether `preventDefault()` 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
		toString():String Returns a string that contains all the properties of the MouseEvent object.	MouseEvent
		updateAfterEvent():void Instructs Flash Player to render after processing of this event completes, if the display list has been modified.	MouseEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined by
		ACTIVATE : String = "activate" [static] Defines the value of the `type` property of an `activate` event object.	Event
		ADDED : String = "added" [static] Defines the value of the `type` property of an `added` event object.	Event
		CANCEL : String = "cancel" [static] Defines the value of the `type` property of a `cancel` event object.	Event
		CHANGE : String = "change" [static] Defines the value of the `type` property of a `change` event object.	Event
		CLICK : String = "click" [static] Defines the value of the `type` property of a `click` event object.	MouseEvent
		CLOSE : String = "close" [static] Defines the value of the `type` property of a `close` event object.	Event
		COMPLETE : String = "complete" [static] Defines the value of the `type` property of a `complete` event object.	Event
		CONNECT : String = "connect" [static] Defines the value of the `type` property of a `connect` event object.	Event
		DEACTIVATE : String = "deactivate" [static] Defines the value of the `type` property of a `deactivate` event object.	Event
		DOUBLE_CLICK : String = "doubleClick" [static] Defines the value of the `type` property of a `doubleClick` event object.	MouseEvent
		ENTER_FRAME : String = "enterFrame" [static] Defines the value of the `type` property of an `enterFrame` event object.	Event
		ID3 : String = "id3" [static] Defines the value of the `type` property of an `id3` event object.	Event
		INIT : String = "init" [static] Defines the value of the `type` property of an `init` event object.	Event
		MOUSE_DOWN : String = "mouseDown" [static] Defines the value of the `type` property of a `mouseDown` event object.	MouseEvent
		MOUSE_DOWN_OUTSIDE : String = "mouseDownOutside" [static] The `FlexMouseEvent.MOUSE_DOWN_OUTSIDE` constant defines the value of the `type` property of the event object for a `mouseDownOutside` event.	FlexMouseEvent
		MOUSE_LEAVE : String = "mouseLeave" [static] Defines the value of the `type` property of a `mouseLeave` event object.	Event
		MOUSE_MOVE : String = "mouseMove" [static] Defines the value of the `type` property of a `mouseMove` event object.	MouseEvent
		MOUSE_OUT : String = "mouseOut" [static] Defines the value of the `type` property of a `mouseOut` event object.	MouseEvent
		MOUSE_OVER : String = "mouseOver" [static] Defines the value of the `type` property of a `mouseOver` event object.	MouseEvent
		MOUSE_UP : String = "mouseUp" [static] Defines the value of the `type` property of a `mouseUp` event object.	MouseEvent
		MOUSE_WHEEL : String = "mouseWheel" [static] Defines the value of the `type` property of a `mouseWheel` event object.	MouseEvent
		MOUSE_WHEEL_OUTSIDE : String = "mouseWheelOutside" [static] The `FlexMouseEvent.MOUSE_WHEEL_OUTSIDE` constant defines the value of the `type` property of the event object for a `mouseWheelOutside` event.	FlexMouseEvent
		OPEN : String = "open" [static] Defines the value of the `type` property of an `open` event object.	Event
		REMOVED : String = "removed" [static] Defines the value of the `type` property of a `removed` event object.	Event
		RENDER : String = "render" [static] Defines the value of the `type` property of a `render` event object.	Event
		RESIZE : String = "resize" [static] Defines the value of the `type` property of a `resize` event object.	Event
		ROLL_OUT : String = "rollOut" [static] Defines the value of the `type` property of a `rollOut` event object.	MouseEvent
		ROLL_OVER : String = "rollOver" [static] Defines the value of the `type` property of a `rollOver` event object.	MouseEvent
		SCROLL : String = "scroll" [static] Defines the value of the `type` property of a `scroll` event object.	Event
		SELECT : String = "select" [static] Defines the value of the `type` property of a `select` event object.	Event
		SOUND_COMPLETE : String = "soundComplete" [static] Defines the value of the `type` property of a `soundComplete` event object.	Event
		TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] Defines the value of the `type` property of a `tabChildrenChange` event object.	Event
		TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] Defines the value of the `type` property of a `tabEnabledChange` event object.	Event
		TAB_INDEX_CHANGE : String = "tabIndexChange" [static] Defines the value of the `type` property of a `tabIndexChange` event object.	Event
		UNLOAD : String = "unload" [static] Defines the value of the `type` property of an `unload` event object.	Event

Constructor detail

FlexMouseEvent

()

constructor

public function FlexMouseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, localX:Number = 0, localY:Number = 0, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0)

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.

	`localX:Number` (default = `0`) — The horizontal position at which the event occurred.

	`localY:Number` (default = `0`) — The vertical position at which the event occurred.

	`relatedObject:InteractiveObject` (default = `null`) — The display list object that is related to the event.

	`ctrlKey:Boolean` (default = `false`) — Whether the Control key is down.

	`altKey:Boolean` (default = `false`) — Whether the Alt key is down.

	`shiftKey:Boolean` (default = `false`) — Whether the Shift key is down.

	`buttonDown:Boolean` (default = `false`) — Whether the Control key is down.

	`delta:int` (default = `0`) — How many lines should be scrolled for each notch the user scrolls the mouse wheel.

Constant detail

MOUSE_DOWN_OUTSIDE

constant

public static const MOUSE_DOWN_OUTSIDE:String = "mouseDownOutside"

The FlexMouseEvent.MOUSE_DOWN_OUTSIDE constant defines the value of the type property of the event object for a mouseDownOutside event.

The properties of the event object have the following values:

Property	Value
`altKey`	Indicates whether the Alt key is down (`true`) or not (`false`).
`bubbles`	false
`buttonDown`	Indicates whether the main mouse button is down (`true`) or not (`false`).
`cancelable`	false
`ctrlKey`	Indicates whether the Control key is down (`true`) or not (`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`. For PopUpManager events, the object is the pop-up window.
`delta`	Indicates how many lines should be scrolled for each notch the user scrolls the mouse wheel. For PopUpManager events this value is 0.
`localX`	The horizontal position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control.
`localY`	The vertical position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control.
`relatedObject`	A reference to a display list object that is related to the event. For PopUpManager events, the object is the container over which the mouse pointer is located.
`shiftKey`	Indicates whether the Shift key is down (`true`) or not (`false`).
`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. For PopUpManager events, the object is the pop-up window.

MOUSE_WHEEL_OUTSIDE

constant

public static const MOUSE_WHEEL_OUTSIDE:String = "mouseWheelOutside"

The FlexMouseEvent.MOUSE_WHEEL_OUTSIDE constant defines the value of the type property of the event object for a mouseWheelOutside event.

The properties of the event object have the following values:

Property	Value
`altKey`	Indicates whether the Alt key is down (`true`) or not (`false`).
`bubbles`	false
`buttonDown`	Indicates whether the main mouse button is down (`true`) or not (`false`).
`cancelable`	false
`ctrlKey`	Indicates whether the Control key is down (`true`) or not (`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`. For PopUpManager events, the object is the pop-up window.
`delta`	Indicates how many lines should be scrolled for each notch the user scrolls the mouse wheel. For PopUpManager events this value is 0.
`localX`	The horizontal position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control.
`localY`	The vertical position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control.
`relatedObject`	A reference to a display list object that is related to the event. For PopUpManager events, the object is the container over which the mouse pointer is located.
`shiftKey`	Indicates whether the Shift key is down (`true`) or not (`false`).
`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. For PopUpManager events, the object is the pop-up window.

Current page: http://livedocs.adobe.com/flex/2/langref/mx/events/FlexMouseEvent.html

Adobe^® Flex™ 2 Language Reference		All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
Class FlexMouseEvent	Properties \| Methods \| Constants

Package	mx.events
Class	public class FlexMouseEvent
Inheritance	FlexMouseEvent MouseEvent Event Object