Packagelc.core.events
Classpublic class WorkspaceEvent
InheritanceWorkspaceEvent Inheritance Event Inheritance Object
Subclasses CollectionResultEvent, ObjectResultEvent, QueueSharingActionCompleteEvent, TaskActionCompleteEvent

The WorkspaceEvent event is the base event class for the LiveCycle Workspace ES API.

Extend this class to create custom events for Workspace ES.

See also

lc.core.events.CollectionResultEvent
lc.core.events.ObjectResultEvent
lc.core.events.QueueSharingActionCompleteEvent
lc.core.events.TaskActionCompleteEvent

Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 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
 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
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedtarget : Object
[read-only] The event target.
Event
  token : Token
[read-only] The token that represents the call to the method.
WorkspaceEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
WorkspaceEvent(type:String, bubbles:Boolean, cancelable:Boolean, token:Token)
Constructor.
WorkspaceEvent
  
clone():Event
Creates a copy of a WorkspaceEvent object and sets the value of each property to match that of the original.
WorkspaceEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in your custom Event class.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether preventDefault() has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] Defines the value of the type property of an addedToStage event object.
Event
  ATTACHMENT_FILL_COMPLETE : String = "attachmentFillComplete"
[static] The attachmentFillComplete event type.
WorkspaceEvent
  AUTHENTICATION_COMPLETE : String = "authenticationComplete"
[static] The authenticationComplete event type.
WorkspaceEvent
 InheritedCANCEL : String = "cancel"
[static] Defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] Defines the value of the type property of a change event object.
Event
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
  COMMIT_COMPLETE : String = "commitComplete"
[static] The commitComplete event type.
WorkspaceEvent
 InheritedCOMPLETE : String = "complete"
[static] Defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] Defines the value of the type property of a fullScreen event object.
Event
  GET_EXTENDED_NOTE_COMPLETE : String = "getExtendedNoteComplete"
[static] The getExtendedNoteComplete event type.
WorkspaceEvent
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
  INIT_COMPLETE : String = "initComplete"
[static] The initComplete event type.
WorkspaceEvent
  LOGIN : String = "login"
[static] The login event type.
WorkspaceEvent
  LOGOUT : String = "logout"
[static] The logout event type.
WorkspaceEvent
  LOGOUT_COMPLETE : String = "logoutComplete"
[static] The logoutComplete event type.
WorkspaceEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open event object.
Event
  PREFERENCES_COMMIT_COMPLETE : String = "preferencesCommitComplete"
[static] The preferencesCommitComplete event type.
WorkspaceEvent
  RELEASE_COMPLETE : String = "releaseComplete"
[static] The releaseComplete event type.
WorkspaceEvent
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] Defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
  UNLOAD : String = "unload"
[static] The unload event type.
WorkspaceEvent
Property Detail
tokenproperty
token:Token  [read-only]

The token that represents the call to the method. Used in the asynchronous completion token pattern.


Implementation
    public function get token():Token
Constructor Detail
WorkspaceEvent()Constructor
public function WorkspaceEvent(type:String, bubbles:Boolean, cancelable:Boolean, token:Token)

Constructor.

Parameters
type: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:Token — Specifies a request token.
Method Detail
clone()method
public override function clone():Event

Creates a copy of a WorkspaceEvent object and sets the value of each property to match that of the original.

Returns
Event
Constant Detail
ATTACHMENT_FILL_COMPLETEConstant
public static const ATTACHMENT_FILL_COMPLETE:String = "attachmentFillComplete"

The attachmentFillComplete event type.

AUTHENTICATION_COMPLETEConstant 
public static const AUTHENTICATION_COMPLETE:String = "authenticationComplete"

The authenticationComplete event type.

COMMIT_COMPLETEConstant 
public static const COMMIT_COMPLETE:String = "commitComplete"

The commitComplete event type.

GET_EXTENDED_NOTE_COMPLETEConstant 
public static const GET_EXTENDED_NOTE_COMPLETE:String = "getExtendedNoteComplete"

The getExtendedNoteComplete event type.

INIT_COMPLETEConstant 
public static const INIT_COMPLETE:String = "initComplete"

The initComplete event type.

LOGINConstant 
public static const LOGIN:String = "login"

The login event type.

LOGOUTConstant 
public static const LOGOUT:String = "logout"

The logout event type.

LOGOUT_COMPLETEConstant 
public static const LOGOUT_COMPLETE:String = "logoutComplete"

The logoutComplete event type.

PREFERENCES_COMMIT_COMPLETEConstant 
public static const PREFERENCES_COMMIT_COMPLETE:String = "preferencesCommitComplete"

The preferencesCommitComplete event type.

RELEASE_COMPLETEConstant 
public static const RELEASE_COMPLETE:String = "releaseComplete"

The releaseComplete event type.

UNLOADConstant 
public static const UNLOAD:String = "unload"

The unload event type.




© 2004-2007 Adobe Systems Incorporated. All rights reserved.
Sun Sep 23 2007, 10:15 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/core/events/WorkspaceEvent.html