impression.events.CanvasElementEvent

	Property	Defined By
		action : String [read-only] The value of the action property of canvasElement.	CanvasElementEvent
		canvas : CanvasPlayer [read-only] The CanvasPlayer object associated with the canvasElement property.	CanvasElementEvent
		canvasElement : CanvasElement [read-only] The CanvasElement object associated with the event.	CanvasElementEvent
		childElement : ChildElement [read-only] The ChildElement object associated with the event.	CanvasElementEvent
		storyboard : Storyboard [read-only] The Storyboard object assigned to canvas.	CanvasElementEvent

	Method	Defined By
		CanvasElementEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, canvasElement:CanvasElement = null, action:String = null) Creates a new instance of a CanvasElementEvent object.	CanvasElementEvent
		clone():Event [override] Duplicates an instance of the event object.	CanvasElementEvent
		toString():String [override] Returns a string containing all the properties of the CanvasElementEvent object.	CanvasElementEvent

	Constant	Defined By
		ELEMENT_ACTIVE : String = elementActive [static] The CanvasElementEvent.ELEMENT_ACTIVE constant defines the value of the type property of a element active event object.	CanvasElementEvent
		ELEMENT_COMPLETE : String = elementComplete [static] The CanvasElementEvent.ELEMENT_COMPLETE constant defines the value of the type property of a element complete event object.	CanvasElementEvent
		ELEMENT_GRAPHIC_LOAD_COMPLETE : String = elementGraphicLoadComplete [static] The CanvasElementEvent.ELEMENT_GRAPHIC_LOAD_COMPLETE constant defines the value of the type property of a element graphic load complete event object.	CanvasElementEvent
		ELEMENT_GRAPHIC_LOAD_INIT : String = elementGraphicLoadInit [static] The CanvasElementEvent.ELEMENT_GRAPHIC_LOAD_INIT constant defines the value of the type property of a element graphic load init event object.	CanvasElementEvent
		ELEMENT_INITIALIZE : String = elementInitialize [static] The CanvasElementEvent.ELEMENT_INITIALIZE constant defines the value of the type property of a element initialized event object.	CanvasElementEvent
		ELEMENT_REDRAW : String = elementRedraw [static] The CanvasElementEvent.ELEMENT_REDRAW constant defines the value of the type property of a element redraw event object.	CanvasElementEvent

Property Detail

action

property

action:String [read-only]

The value of the action property of canvasElement.

Implementation
public function get action():String

canvas

property

canvas:CanvasPlayer [read-only]

The CanvasPlayer object associated with the canvasElement property.

Implementation
public function get canvas():CanvasPlayer

canvasElement

property

canvasElement:CanvasElement [read-only]

The CanvasElement object associated with the event.

Implementation
public function get canvasElement():CanvasElement

childElement

property

childElement:ChildElement [read-only]

The ChildElement object associated with the event.

Implementation
public function get childElement():ChildElement

storyboard

property

storyboard:Storyboard [read-only]

The Storyboard object assigned to canvas.

Implementation
public function get storyboard():Storyboard

Constructor Detail

CanvasElementEvent

()

Constructor

public function CanvasElementEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, canvasElement:CanvasElement = null, action:String = null)

Creates a new instance of a CanvasElementEvent object.

Parameters

	`type:String` — The type of event. Event listeners can access this information through the inherited `type` property.

	`bubbles:Boolean` (default = `false`) — Determines whether the event object participates in the bubbling phase of the event flow. Event listeners can access this information through the inherited `bubbles` property.

	`cancelable:Boolean` (default = `false`) — Determines whether the event object can be canceled. Event listeners can access this information through the inherited `cancelable` property.

	`canvasElement:CanvasElement` (default = `null`) — The CanvasElement object associated with the event. Event listeners can access this information through the `canvasElement` property.

	`action:String` (default = `null`) — The value of the `action` property of `canvasElement`. Event listeners can access this information through the `action` property.

Method Detail

clone

()

method

override public function clone():Event

Duplicates an instance of the event object.

Returns a new CanvasElementEvent object that is a copy of the original instance of the CanvasElementEvent object. You do not normally call clone(); the EventDispatcher class calls it automatically when you redispatch an event--that is, when you call dispatchEvent(event) from a handler that is handling event.

Returns

Event — A new CanvasElementEvent object that is identical to the original.

toString

()

method

override public function toString():String

Returns a string containing all the properties of the CanvasElementEvent object. The string is in the following format:

[CanvasElementEvent type=value bubbles=value cancelable=value eventPhase=value sb=value action=value]

Returns

String — A string containing all the properties of the CanvasElementEvent object.

Constant Detail

ELEMENT_ACTIVE

Constant

public static const ELEMENT_ACTIVE:String = elementActive

The CanvasElementEvent.ELEMENT_ACTIVE constant defines the value of the type property of a element active event object. This event has the following properties:

Property	Value
bubbles	`true`
cancelable	`true`; canceling this event object suppresses redraw of the element.
currentTarget	The object that is actively processing the Event object with an event listener.
target	The object that raised the event.
canvasElement	The CanvasElement object assigned to the target.
action	The value of the `action` property of `canvasElement`.

ELEMENT_COMPLETE

Constant

public static const ELEMENT_COMPLETE:String = elementComplete

The CanvasElementEvent.ELEMENT_COMPLETE constant defines the value of the type property of a element complete event object. This event has the following properties:

Property	Value
bubbles	`true`
cancelable	`true`; canceling this event object suppresses redraw of the element.
currentTarget	The object that is actively processing the Event object with an event listener.
target	The object that raised the event.
canvasElement	The CanvasElement object assigned to the target.
action	The value of the `action` property of `canvasElement`.

ELEMENT_GRAPHIC_LOAD_COMPLETE

Constant

public static const ELEMENT_GRAPHIC_LOAD_COMPLETE:String = elementGraphicLoadComplete

The CanvasElementEvent.ELEMENT_GRAPHIC_LOAD_COMPLETE constant defines the value of the type property of a element graphic load complete event object. This event has the following properties:

Property	Value
bubbles	`true`
cancelable	`false`; there is no default behavior to cancel.
currentTarget	The object that is actively processing the Event object with an event listener.
target	The object that raised the event.
canvasElement	The CanvasElement object assigned to the target.
action	The value of the `action` property of `canvasElement`.

ELEMENT_GRAPHIC_LOAD_INIT

Constant

public static const ELEMENT_GRAPHIC_LOAD_INIT:String = elementGraphicLoadInit

The CanvasElementEvent.ELEMENT_GRAPHIC_LOAD_INIT constant defines the value of the type property of a element graphic load init event object. This event has the following properties:

Property	Value
bubbles	`true`
cancelable	`false`; there is no default behavior to cancel.
currentTarget	The object that is actively processing the Event object with an event listener.
target	The object that raised the event.
canvasElement	The CanvasElement object assigned to the target.
action	The value of the `action` property of `canvasElement`.

ELEMENT_INITIALIZE

Constant

public static const ELEMENT_INITIALIZE:String = elementInitialize

The CanvasElementEvent.ELEMENT_INITIALIZE constant defines the value of the type property of a element initialized event object. This event has the following properties:

Property	Value
bubbles	`true`
cancelable	`false`; there is no default behavior to cancel.
currentTarget	The object that is actively processing the Event object with an event listener.
target	The object that raised the event.
canvasElement	The CanvasElement object assigned to the target.
action	The value of the `action` property of `canvasElement`.

ELEMENT_REDRAW

Constant

public static const ELEMENT_REDRAW:String = elementRedraw

The CanvasElementEvent.ELEMENT_REDRAW constant defines the value of the type property of a element redraw event object. This event has the following properties:

Property	Value
bubbles	`true`
cancelable	`false`; there is no default behavior to cancel.
currentTarget	The object that is actively processing the Event object with an event listener.
target	The object that raised the event.
canvasElement	The CanvasElement object assigned to the target.
action	The value of the `action` property of `canvasElement`.

Thu Feb 26 2015, 10:26 AM -05:00

Impression AS3 BCF Documentation	All Packages \| All Classes \| Index \| Frames No Frames
CanvasElementEvent	Properties \| Methods \| Constants

Package	impression.events
Class	public class CanvasElementEvent
Inheritance	CanvasElementEvent flash.events.Event