ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
lc.procmgmt.formbridge 

FormConnector  - AS3 ADEP Workspace
Packagelc.procmgmt.formbridge
Classpublic class FormConnector
InheritanceFormConnector Inheritance EventDispatcher Inheritance Object
Implements IMXMLObject

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

Deprecated Since LiveCycle ES2 (9.0): Please use SwfConnector class.

In earlier releases, the FormConnector class is used in application built with Flex (Flex applications) to simplify communication with Workspace. This class was used to enable the Flex application to function within Workspace. You can use Flex applications in Workspace, but it is recommended that you use use the SwfConnector class instead.

For information on using this component to customize Workspace, see Creating Flex Applications Enabled for Workspace .

MXML SyntaxexpandedHide MXML Syntax
The <lc:FormConnector> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes: 
 	  <lc:FormConnector
 	    Properties
        id="lcConnector"
 	 
 	    Events
 	    formInitialData="formInitListener(event)"
 	 	  formSaveDataRequest="formSaveDataRequestListener(event)"
 	    formSubmitDataRequest="formSubmitDataRequestListener(event)"/>

Related API Elements

lc.procmgmt.formbridge.SwfConnector
lc.procmgmt.events.FormEvents

Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
  
creationComplete(event:Event):void
Specifies that the Flex application has completed creation and binds the required event listeners to events.
FormConnector
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
  
initialized(document:Object, id:String):void
Initializes communication with Workspace.
FormConnector
 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
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
  
setClean():void
Specifies that changes in the data have not been made in the Flex application.
FormConnector
  
setDataInvalid():void
Specifies that data store is not valid.
FormConnector
  
setDataValid():void
Specifies that the data stored is valid.
FormConnector
  
setDirty():void
Specifies that changes have been made in the Flex application.
FormConnector
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
  
setReady():void
Notifies Workspace that the Flex application is ready to start communicating.
FormConnector
  
setSaveData(data:XML):void
Sends the data to Workspace to save.
FormConnector
  
setSubmitData(data:XML):void
Sends the data to Workspace to submit to a process.
FormConnector
  
setSubmitDataInvalid():void
Specifies that the Flex application has completed creation and binds the required event listeners to events.
FormConnector
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  
formInitialData
The event is dispatched after the Flex application has completed loading.FormConnector
  
formSaveDataRequest
The event is dispatched when a user clicks the Save Form Data button within Workspace.FormConnector
  
formSubmitDataRequest
The event is dispatched when a user clicks the Complete button within Workspace.FormConnector
Method Detail

creationComplete

()method
public function creationComplete(event:Event):void

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

Specifies that the Flex application has completed creation and binds the required event listeners to events.

Parameters

event:Event — Specifies that event the intialization of the object has completed.

initialized

()method 
public function initialized(document:Object, id:String):void

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

Initializes communication with Workspace.

Parameters

document:Object — Specifies the application, built with Flex, to initialize.
 
id:String — Reserved for future use.

setClean

()method 
public function setClean():void

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

Specifies that changes in the data have not been made in the Flex application.

setDataInvalid

()method 
public function setDataInvalid():void

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

Specifies that data store is not valid. Use this method when at least one portion of the data to be submitted is not correct or is not formatted correctly.

setDataValid

()method 
public function setDataValid():void

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

Specifies that the data stored is valid. Use this method when all the pieces of data to be submitted is correct.

setDirty

()method 
public function setDirty():void

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

Specifies that changes have been made in the Flex application.

setReady

()method 
public function setReady():void

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

Notifies Workspace that the Flex application is ready to start communicating. To use it, associate it with the mx:Application container's creationComplete event.

setSaveData

()method 
public function setSaveData(data:XML):void

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

Sends the data to Workspace to save. Data does not need to be validated before being saved.

Parameters

data:XML — Specifies data to save that is formatted as XML.

setSubmitData

()method 
public function setSubmitData(data:XML):void

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

Sends the data to Workspace to submit to a process. The data must be validated before it is submitted to a process.

Parameters

data:XML — Specifies the data to submit to a process that is formatted as XML.

setSubmitDataInvalid

()method 
public function setSubmitDataInvalid():void

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

Specifies that the Flex application has completed creation and binds the required event listeners to events.

Event Detail

formInitialData

 Event
Event Object Type: flash.events.DataEvent
property DataEvent.type = flash.events.DataEvent.FORM_INITIAL_DATA

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 event is dispatched after the Flex application has completed loading.

formSaveDataRequest

 Event  
Event Object Type: flash.events.Event
property Event.type = flash.events.Event.FORM_SAVE_DATA_REQUEST

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 event is dispatched when a user clicks the Save Form Data button within Workspace.

formSubmitDataRequest

 Event  
Event Object Type: flash.events.Event
property Event.type = flash.events.Event.FORM_SUBMIT_DATA_REQUEST

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 event is dispatched when a user clicks the Complete button within Workspace.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy