Packagemx.events
Classpublic class FlexMouseEvent
InheritanceFlexMouseEvent Inheritance flash.events.MouseEvent

The FlexMouseEvent class represents the event object passed to the event listener for Flex-specific mouse activity.


Public Methods
 MethodDefined 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
Public Constants
 ConstantDefined by
  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_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
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_OUTSIDEconstant
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:

PropertyValue
altKey Indicates whether the Alt key is down (true) or not (false).
bubblesfalse
buttonDown Indicates whether the main mouse button is down (true) or not (false).
cancelablefalse
ctrlKey Indicates whether the Control key is down (true) or not (false).
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. 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).
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. For PopUpManager events, the object is the pop-up window.
MOUSE_WHEEL_OUTSIDEconstant 
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:

PropertyValue
altKey Indicates whether the Alt key is down (true) or not (false).
bubblesfalse
buttonDown Indicates whether the main mouse button is down (true) or not (false).
cancelablefalse
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).
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. For PopUpManager events, the object is the pop-up window.



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