FormEvents - Adobe ActionScript® 3 (AS3 ADEP Workspace) API Reference

Package	lc.procmgmt.events
Class	public class FormEvents
Inheritance	FormEvents 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

The FormEvents class contains the constants for the event types used to communicate between an application built with Flex (Flex application) and Workspace. Unless otherwise indicated, the event class for the event is flash.event.Event.

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, your Flex application would do the following:

	     systemManager.loaderInfo.sharedEvents.dispatchEvent(new Event(FormEvents.FORM_DATA_INVALID));

The FormConnector class can also be used to simplify event handling between a Flex application and Workspace.

The following numbered list is the general sequence of events that occurs between the Flex application you create and Workspace:

The Flex application you create is loaded by Workspace. A setReady event is dispatched after the Flex application application is finished loading.
Workspace dispatches a formInitialData event to the Flex application with the initial data. If there is no initial data, the event will be a value of null or an empty space for the data property.
The Flex application must either dispatch events of type formDataValid and formDataInvalid as the data changes from one state to the other or emit a single formDataValid event. Workspace may not allow the user to click the Complete button to submit data after a formDataValid event is received. If validation cannot be peformed as the Flex application runs due to performance reasons, a formDataValid event may be emitted in response to the formInitialData event. After a Flex application receives a formSubmitDataRequest event from Workspace, the Flex application must validate the data and then dispatch a formSubmitData event or a formSubmitDataInvalid event
The Flex form can dispatch formClean and formDirty events if the Flex application tracks the status of the data. Workspace will use the events to determine whether the user should be prompted to save their data.
Workspace dispatches a formSaveDataRequest event when the user chooses to save their draft (incomplete) data.
In response to the formSaveDataRequest event, the Flex application must dispatch a formSaveData event with the data as XML.
Workspace dispatches a formSubmitDataRequest event when the user chooses to submit their (completed) data.
In response to the formSubmitDataRequest event, the Flex application must dispatch either a formSubmitData event with the valid form data or a formSubmitDataInvalid event, which indicates that validation failed and the data is not in a valid state to be submitted.
After Workspace receives a formSubmitData event in response to the formSubmitDataRequest event, it will unload the Flex application.

The following events must be supported by the Flex application for it to function within Workspace:

FormDataEvent.INITIAL_FORM_DATA
FormDataEvent.SAVE_FORM_DATA
FormDataEvent.SUBMIT_FORM_DATA

The following events must be sent by the Flex application to Workspace:

FormDataEvent.FORM_READY
FormDataEvent.FORM_DATA_VALID
FormDataEvent.FORM_DATA_INVALID
FormDataEvent.FORM_CLEAN
FormDataEvent.FORM_DIRTY

Related API Elements

lc.procmgmt.formbridge.FormConnector

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		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
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		FORM_CLEAN : String = "formClean" [static] A special value that specifies that the data in the Flex application has not changed since the Flex application was initialized or the data was last saved.	FormEvents
		FORM_DATA_INVALID : String = "formDataInvalid" [static] A special value that specifies that the data is not valid.	FormEvents
		FORM_DATA_VALID : String = "formDataValid" [static] A special value that specifies that the data is valid.	FormEvents
		FORM_DIRTY : String = "formDirty" [static] A special value that specifies that changes have occurred to the data.	FormEvents
		FORM_INITIAL_DATA : String = "formInitialData" [static] A special value that specifies that initial data is sent to the Flex application.	FormEvents
		FORM_READY : String = "formReady" [static] A special value that specifies that the Flex application is ready to communicate with Workspace.	FormEvents
		FORM_SAVE_DATA : String = "formSaveData" [static] A special value that specifies that the data was saved by Workspace.	FormEvents
		FORM_SAVE_DATA_REQUEST : String = "formSaveDataRequest" [static] A special value that specifies that the Save Form button was clicked within Workspace.	FormEvents
		FORM_SUBMIT_DATA : String = "formSubmitData" [static] A special value that specifies that the data was successfully submitted by Workspace to the server.	FormEvents
		FORM_SUBMIT_DATA_INVALID : String = "formSubmitDataInvalid" [static] A special value that specifies that invalid data that was submitted.	FormEvents
		FORM_SUBMIT_DATA_REQUEST : String = "formSubmitDataRequest" [static] A special value that specifies that the Complete button was clicked within Workspace.	FormEvents

Constant Detail

FORM_CLEAN

Constant

public static const FORM_CLEAN:String = "formClean"

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 special value that specifies that the data in the Flex application has not changed since the Flex application was initialized or the data was last saved. If a Flex application does not dispatch this event, Workspace assumes that the formDirty event will not be dispatched and the data is considered always changed. This results in the user always being prompted to save the form regardless of whether changes have been made to the data in the Flex application.

The properties of the event object have the following values:

Property	Value
`bubbles`	true
`cancelable`	false; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object that dispatched the event; use the `currentTarget` property to always access the Object listening for the event.

FORM_DATA_INVALID

Constant

public static const FORM_DATA_INVALID:String = "formDataInvalid"

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 special value that specifies that the data is not valid.

The properties of the event object have the following values:

Property	Value
`bubbles`	true
`cancelable`	false; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object that dispatched the event; use the `currentTarget` property to always access the Object listening for the event.

FORM_DATA_VALID

Constant

public static const FORM_DATA_VALID:String = "formDataValid"

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 special value that specifies that the data is valid.

The properties of the event object have the following values:

Property	Value
`bubbles`	true
`cancelable`	false; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object that dispatched the event; use the `currentTarget` property to always access the Object listening for the event.

FORM_DIRTY

Constant

public static const FORM_DIRTY:String = "formDirty"

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 special value that specifies that changes have occurred to the data. Flex application becomes "dirty" when the user has made changes to the data since the Flex application was initialized or the last time form data was sent.

The properties of the event object have the following values:

Property	Value
`bubbles`	true
`cancelable`	false; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object that dispatched the event; use the `currentTarget` property to always access the Object listening for the event.

FORM_INITIAL_DATA

Constant

public static const FORM_INITIAL_DATA:String = "formInitialData"

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 special value that specifies that initial data is sent to the Flex application.

The properties of the event object have the following values:

Property	Value
`bubbles`	true
`cancelable`	false; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object that dispatched the event; use the `currentTarget` property to always access the Object listening for the event.

FORM_READY

Constant

public static const FORM_READY:String = "formReady"

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 special value that specifies that the Flex application is ready to communicate with Workspace.

The properties of the event object have the following values:

Property	Value
`bubbles`	true
`cancelable`	false; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object that dispatched the event; use the `currentTarget` property to always access the Object listening for the event.

FORM_SAVE_DATA

Constant

public static const FORM_SAVE_DATA:String = "formSaveData"

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 special value that specifies that the data was saved by Workspace.

The properties of the event object have the following values:

Property	Value
`bubbles`	true
`cancelable`	false; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object that dispatched the event; use the `currentTarget` property to always access the Object listening for the event.

FORM_SAVE_DATA_REQUEST

Constant

public static const FORM_SAVE_DATA_REQUEST:String = "formSaveDataRequest"

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 special value that specifies that the Save Form button was clicked within Workspace.

The properties of the event object have the following values:

Property	Value
`bubbles`	true
`cancelable`	false; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object that dispatched the event; use the `currentTarget` property to always access the Object listening for the event.

FORM_SUBMIT_DATA

Constant

public static const FORM_SUBMIT_DATA:String = "formSubmitData"

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 special value that specifies that the data was successfully submitted by Workspace to the server.

The properties of the event object have the following values:

Property	Value
`bubbles`	true
`cancelable`	false; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object that dispatched the event; use the `currentTarget` property to always access the Object listening for the event.

FORM_SUBMIT_DATA_INVALID

Constant

public static const FORM_SUBMIT_DATA_INVALID:String = "formSubmitDataInvalid"

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 special value that specifies that invalid data that was submitted.

The properties of the event object have the following values:

Property	Value
`bubbles`	true
`cancelable`	false; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object that dispatched the event; use the `currentTarget` property to always access the Object listening for the event.

FORM_SUBMIT_DATA_REQUEST

Constant

public static const FORM_SUBMIT_DATA_REQUEST:String = "formSubmitDataRequest"

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 special value that specifies that the Complete button was clicked within Workspace.

The properties of the event object have the following values:

Property	Value
`bubbles`	true
`cancelable`	false; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object that dispatched the event; use the `currentTarget` property to always access the Object listening for the event.

FormEvents - AS3 ADEP Workspace

Classes x

FORM_CLEAN

FORM_DATA_INVALID

FORM_DATA_VALID

FORM_DIRTY

FORM_INITIAL_DATA

FORM_READY

FORM_SAVE_DATA

FORM_SAVE_DATA_REQUEST

FORM_SUBMIT_DATA

FORM_SUBMIT_DATA_INVALID

FORM_SUBMIT_DATA_REQUEST

lc.procmgmt.events FormEvents - AS3 ADEP Workspace		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples