ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.events 

SandboxMouseEvent  - AS3 Flex

Packagemx.events
Classpublic class SandboxMouseEvent
InheritanceSandboxMouseEvent Inheritance Event Inheritance Object

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

This is an event sent between applications in different security sandboxes to notify listeners about mouse activity in another security sandbox. For security reasons, some fields of a MouseEvent are not sent in a SandboxMouseEvent.

More examples

Learn more



Public Properties
 PropertyDefined By
  altKey : Boolean
Indicates whether the Alt key was pressed.
SandboxMouseEvent
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
  buttonDown : Boolean
Indicates whether the primary mouse button is pressed (true) or not (false).
SandboxMouseEvent
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  ctrlKey : Boolean
Indicates whether the Ctrl key was pressed.
SandboxMouseEvent
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  shiftKey : Boolean
Indicates whether the Shift key was pressed.
SandboxMouseEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
SandboxMouseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false)
Constructor.
SandboxMouseEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 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
  
[static] Marshal a SWFBridgeRequest from a remote ApplicationDomain into the current ApplicationDomain.
SandboxMouseEvent
 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
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  CLICK_SOMEWHERE : String = "clickSomewhere"
[static] Mouse was clicked somewhere outside your sandbox.
SandboxMouseEvent
  DOUBLE_CLICK_SOMEWHERE : String = "doubleClickSomewhere"
[static] Mouse was double-clicked somewhere outside your sandbox.
SandboxMouseEvent
  MOUSE_DOWN_SOMEWHERE : String = "mouseDownSomewhere"
[static] Mouse button was pressed down somewhere outside your sandbox.
SandboxMouseEvent
  MOUSE_MOVE_SOMEWHERE : String = "mouseMoveSomewhere"
[static] Mouse was moved somewhere outside your sandbox.
SandboxMouseEvent
  MOUSE_UP_SOMEWHERE : String = "mouseUpSomewhere"
[static] Mouse button was released somewhere outside your sandbox.
SandboxMouseEvent
  MOUSE_WHEEL_SOMEWHERE : String = "mouseWheelSomewhere"
[static] Mouse wheel was spun somewhere outside your sandbox.
SandboxMouseEvent
Property Detail

altKey

property
public var altKey:Boolean

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

Indicates whether the Alt key was pressed.

Related API Elements

buttonDown

property 
public var buttonDown:Boolean

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

Indicates whether the primary mouse button is pressed (true) or not (false).

Related API Elements

ctrlKey

property 
public var ctrlKey:Boolean

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

Indicates whether the Ctrl key was pressed.

Related API Elements

shiftKey

property 
public var shiftKey:Boolean

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

Indicates whether the Shift key was pressed.

Related API Elements

Constructor Detail

SandboxMouseEvent

()Constructor
public function SandboxMouseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false)

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.
 
ctrlKey:Boolean (default = false) — Indicates whether the Ctrl key was pressed.
 
altKey:Boolean (default = false) — Indicates whether the Alt key was pressed.
 
shiftKey:Boolean (default = false) — Indicates whether the Shift key was pressed.
 
buttonDown:Boolean (default = false) — Indicates whether the primary mouse button is pressed (true) or not (false).
Method Detail

marshal

()method
public static function marshal(event:Event):SandboxMouseEvent

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

Marshal a SWFBridgeRequest from a remote ApplicationDomain into the current ApplicationDomain.

Parameters

event:Event — A SWFBridgeRequest that might have been created in a different ApplicationDomain.

Returns
SandboxMouseEvent — A SandboxMouseEvent created in the caller's ApplicationDomain.
Constant Detail

CLICK_SOMEWHERE

Constant
public static const CLICK_SOMEWHERE:String = "clickSomewhere"

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

Mouse was clicked somewhere outside your sandbox.

DOUBLE_CLICK_SOMEWHERE

Constant 
public static const DOUBLE_CLICK_SOMEWHERE:String = "doubleClickSomewhere"

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

Mouse was double-clicked somewhere outside your sandbox.

MOUSE_DOWN_SOMEWHERE

Constant 
public static const MOUSE_DOWN_SOMEWHERE:String = "mouseDownSomewhere"

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

Mouse button was pressed down somewhere outside your sandbox.

MOUSE_MOVE_SOMEWHERE

Constant 
public static const MOUSE_MOVE_SOMEWHERE:String = "mouseMoveSomewhere"

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

Mouse was moved somewhere outside your sandbox.

MOUSE_UP_SOMEWHERE

Constant 
public static const MOUSE_UP_SOMEWHERE:String = "mouseUpSomewhere"

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

Mouse button was released somewhere outside your sandbox.

MOUSE_WHEEL_SOMEWHERE

Constant 
public static const MOUSE_WHEEL_SOMEWHERE:String = "mouseWheelSomewhere"

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

Mouse wheel was spun somewhere outside your sandbox.