Packagelc.core
Classpublic class FormConnector
InheritanceFormConnector Inheritance EventDispatcher Inheritance Object
Implements IMXMLObject

The FormConnector class is used in Flex applications to simplify communication with Workspace ES. This class must be used in a Flex application that you want to function within Workspace ES.

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)"/>

See also

lc.core.events.FormEvents

Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
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 ES.
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 ES that the Flex application is ready to start communicating.
FormConnector
  
setSaveData(data:XML):void
Sends the data to Workspace ES to save.
FormConnector
  
setSubmitData(data:XML):void
Sends the data to Workspace ES 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
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
 Event Summary Defined By
 Inherited
activate
Dispatched when Flash Player gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
Dispatched when Flash Player loses operating 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 LiveCycle Workspace ES.FormConnector
  
formSubmitDataRequest
The event is dispatched when a user clicks the Complete button within Workspace ES.FormConnector
Method Detail
creationComplete()method
public function creationComplete(event:Event):void

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

Initializes communication with Workspace ES.

Parameters

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

setClean()method 
public function setClean():void

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

setDataInvalid()method 
public function setDataInvalid():void

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

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

Specifies that changes have been made in the Flex application.

setReady()method 
public function setReady():void

Notifies Workspace ES 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

Sends the data to Workspace ES 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

Sends the data to Workspace ES 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

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
DataEvent.type property = flash.events.DataEvent.FORM_INITIAL_DATA

The event is dispatched after the Flex application has completed loading.

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

The event is dispatched when a user clicks the Save Form Data button within LiveCycle Workspace ES.

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

The event is dispatched when a user clicks the Complete button within Workspace ES.




© 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/FormConnector.html