(Beta)
| Package | lc.foundation.events |
| Class | public class LiveCycleEvent |
| Inheritance | LiveCycleEvent  Event Object |
| Subclasses | CollectionResultEvent, NavigationEvent, ObjectResultEvent, QueueSharingActionCompleteEvent, TaskActionCompleteEvent |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
LiveCycleEvent event is the base event class for the LiveCycle ES API.
Extend this class to create custom events.
Related API Elements
lc.foundation.events.CollectionResultEvent
lc.foundation.events.ObjectResultEvent
lc.procmgmt.events.QueueSharingActionCompleteEvent
lc.procmgmt.events.TaskActionCompleteEvent
lc.foundation.events.ObjectResultEvent
lc.procmgmt.events.QueueSharingActionCompleteEvent
lc.procmgmt.events.TaskActionCompleteEvent
Public Properties
Hide Inherited Public Properties
Show Inherited 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 | |
| target : Object [read-only]
The event target. | Event | |
| token : lc.foundation.util:Token [read-only]
The token that represents the call to the method. | LiveCycleEvent | ||
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | LiveCycleEvent | ||
[override]
Creates a copy of a LiveCycleEvent object
and sets the value of each property to match that of the original. | LiveCycleEvent | ||
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| ATTACHMENT_FILL_COMPLETE : String = "attachmentFillComplete" [static]
The attachmentFillComplete event type. | LiveCycleEvent | ||
| AUTHENTICATION_COMPLETE : String = "authenticationComplete" [static]
The authenticationComplete event type. | LiveCycleEvent | ||
| COMMIT_COMPLETE : String = "commitComplete" [static]
The commitComplete event type. | LiveCycleEvent | ||
| GET_EXTENDED_NOTE_COMPLETE : String = "getExtendedNoteComplete" [static]
The getExtendedNoteComplete event type. | LiveCycleEvent | ||
| INIT_COMPLETE : String = "initComplete" [static]
The initComplete event type. | LiveCycleEvent | ||
| LOGIN : String = "login" [static]
The login event type. | LiveCycleEvent | ||
| LOGOUT : String = "logout" [static]
The logout event type. | LiveCycleEvent | ||
| LOGOUT_COMPLETE : String = "logoutComplete" [static]
The logoutComplete event type. | LiveCycleEvent | ||
| PREFERENCES_COMMIT_COMPLETE : String = "preferencesCommitComplete" [static]
The preferencesCommitComplete event type. | LiveCycleEvent | ||
| PREFERENCES_LOAD_COMPLETE : String = "preferencesLoadComplete" [static]
The preferencesCommitComplete event type. | LiveCycleEvent | ||
| RELEASE_COMPLETE : String = "releaseComplete" [static]
The releaseComplete event type. | LiveCycleEvent | ||
| UNLOAD : String = "unload" [static]
The unload event type. | LiveCycleEvent | ||
Property Detail
token | property |
token:lc.foundation.util:Token [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The token that represents the call to the method. Used in the asynchronous completion token pattern.
Implementation
public function get token():lc.foundation.util:TokenConstructor Detail
LiveCycleEvent | () | Constructor |
public function LiveCycleEvent(type:String, bubbles:Boolean, cancelable:Boolean, token:lc.foundation.util:Token)| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Constructor.
Parameterstype:String — Specifies the type of the event.
| |
bubbles:Boolean — Specifies whether the event object participates in the bubbling stage of
the event flow.
| |
cancelable:Boolean — Specifies whether the event object can be canceled.
| |
token:lc.foundation.util:Token — Specifies a request token.
|
Method Detail
clone | () | method |
override public function clone():Event| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Creates a copy of a LiveCycleEvent object
and sets the value of each property to match that of the original.
Event — A copy of the LiveCycleEvent object.
|
Constant Detail
ATTACHMENT_FILL_COMPLETE | Constant |
public static const ATTACHMENT_FILL_COMPLETE:String = "attachmentFillComplete"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The attachmentFillComplete event type.
AUTHENTICATION_COMPLETE | Constant |
public static const AUTHENTICATION_COMPLETE:String = "authenticationComplete"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The authenticationComplete event type.
COMMIT_COMPLETE | Constant |
public static const COMMIT_COMPLETE:String = "commitComplete"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The commitComplete event type.
GET_EXTENDED_NOTE_COMPLETE | Constant |
public static const GET_EXTENDED_NOTE_COMPLETE:String = "getExtendedNoteComplete"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The getExtendedNoteComplete event type.
INIT_COMPLETE | Constant |
public static const INIT_COMPLETE:String = "initComplete"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The initComplete event type.
LOGIN | Constant |
public static const LOGIN:String = "login"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The login event type.
LOGOUT | Constant |
public static const LOGOUT:String = "logout"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The logout event type.
LOGOUT_COMPLETE | Constant |
public static const LOGOUT_COMPLETE:String = "logoutComplete"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The logoutComplete event type.
PREFERENCES_COMMIT_COMPLETE | Constant |
public static const PREFERENCES_COMMIT_COMPLETE:String = "preferencesCommitComplete"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The preferencesCommitComplete event type.
PREFERENCES_LOAD_COMPLETE | Constant |
public static const PREFERENCES_LOAD_COMPLETE:String = "preferencesLoadComplete"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The preferencesCommitComplete event type.
RELEASE_COMPLETE | Constant |
public static const RELEASE_COMPLETE:String = "releaseComplete"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The releaseComplete event type.
UNLOAD | Constant |
public static const UNLOAD:String = "unload"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The unload event type.
Wed Nov 21 2018, 06:34 AM -08:00