GAEvent

Package	ga.model
Class	public class GAEvent
Inheritance	GAEvent Event Object

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions:

AIR 1.0, Flash Player 10.2

The GAEvent class represents the event object passed to the event listener for Guide events.

Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		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
		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
		page : Page The associated page when a page specific event is dispatched.	GAEvent
		section : Section The associated section when a page or section specific event is dispatched.	GAEvent
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		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
		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

	Constant		Defined By
		ERROR_STRING_CHANGED : String = "errorStringChanged" [static] Dispatched by a page, panel, or section whenever the error string for a Guide field changes.	GAEvent
		INITIALIZED : String = "initialized" [static] Dispatched when a Guide initializes.	GAEvent
		PAGE_ADD : String = "pageAdd" [static] Dispatched when a repeating panel is added to a Guide.	GAEvent
		PAGE_REMOVE : String = "pageRemove" [static] Dispatched when a repeating panel is removed from a Guide.	GAEvent
		PAGE_SELECTION_CHANGE : String = "pageSelectionChange" [static] Dispatched when a panel is selected.	GAEvent
		SECTION_ADD : String = "sectionAdd" [static] Dispatched when a repeating section is added to a Guide.	GAEvent
		SECTION_REMOVE : String = "sectionRemove" [static] Dispatched when a repeating section is removed from a Guide.	GAEvent

Property Detail

page

property

public var page:Page

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions:

AIR 1.0, Flash Player 10.2

The associated page when a page specific event is dispatched.

section

property

public var section:Section

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions:

AIR 1.0, Flash Player 10.2

The associated section when a page or section specific event is dispatched.

Constant Detail

ERROR_STRING_CHANGED

Constant

public static const ERROR_STRING_CHANGED:String = "errorStringChanged"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions:

AIR 1.0, Flash Player 10.2

Dispatched by a page, panel, or section whenever the error string for a Guide field changes.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	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`.
`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.

INITIALIZED

Constant

public static const INITIALIZED:String = "initialized"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions:

AIR 1.0, Flash Player 10.2

Dispatched when a Guide initializes.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	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`.
`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.

PAGE_ADD

Constant

public static const PAGE_ADD:String = "pageAdd"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions:

AIR 1.0, Flash Player 10.2

Dispatched when a repeating panel is added to a Guide.

The properties of the event object have the following values:

Property	Value
`page`	The page that was added.
`section`	The section that contains the added page.
`bubbles`	false
`cancelable`	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`.
`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.

PAGE_REMOVE

Constant

public static const PAGE_REMOVE:String = "pageRemove"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions:

AIR 1.0, Flash Player 10.2

Dispatched when a repeating panel is removed from a Guide.

The properties of the event object have the following values:

Property	Value
`page`	The page that was removed.
`section`	The section that contained the removed page.
`bubbles`	false
`cancelable`	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`.
`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.

PAGE_SELECTION_CHANGE

Constant

public static const PAGE_SELECTION_CHANGE:String = "pageSelectionChange"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions:

AIR 1.0, Flash Player 10.2

Dispatched when a panel is selected.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	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`.
`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.

SECTION_ADD

Constant

public static const SECTION_ADD:String = "sectionAdd"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions:

AIR 1.0, Flash Player 10.2

Dispatched when a repeating section is added to a Guide.

The properties of the event object have the following values:

Property	Value
`section`	The section that contained the removed page.
`bubbles`	false
`cancelable`	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`.
`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.

SECTION_REMOVE

Constant

public static const SECTION_REMOVE:String = "sectionRemove"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions:

AIR 1.0, Flash Player 10.2

Dispatched when a repeating section is removed from a Guide.

The properties of the event object have the following values:

Property	Value
`section`	The section that contained the removed page.
`bubbles`	false
`cancelable`	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`.
`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.

Legal Notices | Online Privacy Policy

GAEvent - AS3 ADEP Guides

Classes x

page

section

ERROR_STRING_CHANGED

INITIALIZED

PAGE_ADD

PAGE_REMOVE

PAGE_SELECTION_CHANGE

SECTION_ADD

SECTION_REMOVE