(Beta)
Package | lc.procmgmt.events |
Class | public class FormEvents |
Inheritance | FormEvents ![]() |
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
FormEvents
class contains the constants for the event
types used to communicate between an application built with Flex (Flex application) and
LiveCycle Workspace ES2. Unless otherwise indicated, the event class for the event is flash.event.Event.
Communication between the Flex application you create and Workspace ES2 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 ES2, 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 ES2.
The following numbered list is the general sequence of events that occurs between the Flex application you create and Workspace ES:
- The Flex application you create is loaded by Workspace ES2. A
setReady
event is dispatched after the Flex application application is finished loading. - Workspace ES2 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
andformDataInvalid
as the data changes from one state to the other or emit a singleformDataValid
event. Workspace ES2 may not allow the user to click the Complete button to submit data after aformDataValid
event is received. If validation cannot be peformed as the Flex application runs due to performance reasons, aformDataValid
event may be emitted in response to theformInitialData
event. After a Flex application receives aformSubmitDataRequest
event from Workspace ES, the Flex application must validate the data and then dispatch aformSubmitData
event or aformSubmitDataInvalid
event - The Flex form can dispatch
formClean
andformDirty
events if the Flex application tracks the status of the data. Workspace ES2 will use the events to determine whether the user should be prompted to save their data. - Workspace ES2 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 aformSaveData
event with the data as XML. - Workspace ES2 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 aformSubmitData
event with the valid form data or aformSubmitDataInvalid
event, which indicates that validation failed and the data is not in a valid state to be submitted. - After Workspace ES2 receives a
formSubmitData
event in response to theformSubmitDataRequest
event, it will unload the Flex application.
The following events must be supported by the Flex application for it to function within Workspace ES:
-
FormDataEvent.INITIAL_FORM_DATA
-
FormDataEvent.SAVE_FORM_DATA
-
FormDataEvent.SUBMIT_FORM_DATA
-
FormDataEvent.FORM_READY
-
FormDataEvent.FORM_DATA_VALID
-
FormDataEvent.FORM_DATA_INVALID
-
FormDataEvent.FORM_CLEAN
-
FormDataEvent.FORM_DIRTY
Related API Elements
Public Properties
Public Methods
Public Constants
Constant | Defined By |
---|
Constant Detail
Wed Nov 21 2018, 06:34 AM -08:00