lc.procmgmt.events

# SwfDataEvent - AS3 ADEP Workspace

Package | lc.procmgmt.events
Class | public class SwfDataEvent
Inheritance | SwfDataEvent Event Object

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

A `SwfDataEvent` event is used to pass initial data from Workspace to the application built with Flex (Flex application). It also passes the associated Task object that provides context info and access to the Workspace Manager classes if the Flex application requires deeper integration with Workspace.

Communication between the Flex application you create and Workspace occurs when events are dispatched to the `sharedEvents.EventDispatcher` property on the `LoaderInfo` object of the Flex application you are creating. For example, to emit an event to Workspace, the Flex application does the following:

    	     systemManager.loaderInfo.sharedEvents.dispatchEvent(new Event(SwfAppEvent.SET_TASK));

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
|  | data : String The data contents for the task - usually XML that has been converted to a String. | SwfDataEvent
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | target : Object [read-only] The event target. | Event
|  | task : lc.procmgmt.domain:Task The Task object that is associated with the event. | SwfDataEvent
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SwfDataEvent(type:String, task:lc.procmgmt.domain:Task, data:String = null) Constructor. | SwfDataEvent
|  | 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
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | SET_WORKSPACE_DATA : String = "setWorkspaceData" [static] The type property for a SwfDataEvent event. | SwfDataEvent

Property Detail

### data

property

`public var data:String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The data contents for the task - usually XML that has been converted to a String.

### task

property

`public var task:lc.procmgmt.domain:Task`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The `Task` object that is associated with the event.

Constructor Detail

### SwfDataEvent

()
Constructor

`public function SwfDataEvent(type:String, task:lc.procmgmt.domain:Task, data:String = null)`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

Constructor.

Parameters

| `type:String` — Specifies the type of event.
| `task:lc.procmgmt.domain:Task` — Specifies the task that is associated with the event.
| `data:String` (default = `null`)`` — Specifies the data for the event.

Constant Detail

### SET_WORKSPACE_DATA

Constant

`public static const SET_WORKSPACE_DATA:String = "setWorkspaceData"`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The `type` property for a `SwfDataEvent` event. This event is set to always bubble.

The properties of the event object have the following values:

Property | Value
--- | ---
`data` | The data contents for the task.
`task` | The instance of the selected task.

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