mx.events

# SandboxMouseEvent - AS3 Flex

Package | mx.events
Class | public class SandboxMouseEvent
Inheritance | SandboxMouseEvent Event 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

Manually dispatching events

Learn more

About Flex events

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | altKey : Boolean Indicates whether the Alt key was pressed. | SandboxMouseEvent
|  | bubbles : 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
|  | cancelable : Boolean [read-only] 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 Ctrl key was pressed. | SandboxMouseEvent
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | shiftKey : Boolean Indicates whether the Shift key was pressed. | SandboxMouseEvent
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SandboxMouseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false) Constructor. | SandboxMouseEvent
|  | clone():Event Duplicates an instance of an Event subclass. | Event
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method 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
|  | marshal(event:Event):SandboxMouseEvent [static] Marshal a SWFBridgeRequest from a remote ApplicationDomain into the current ApplicationDomain. | SandboxMouseEvent
|  | 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
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns a string containing all the properties of the Event object. | Event
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined 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

flash.events.MouseEvent.altkey

### 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

flash.events.MouseEvent.buttonDown

### 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

flash.events.MouseEvent.ctrlKey

### 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

flash.events.MouseEvent.shiftKey
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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00