Paket | lc.procmgmt.events |
Klasse | public class FormEvents |
Vererbung | FormEvents Object |
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
Laufzeitversionen: | AIR (unsupported), 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
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
andformDataInvalid
as the data changes from one state to the other or emit a singleformDataValid
event. Workspace 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, 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 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 aformSaveData
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 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 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:
-
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
Verwandte API-Elemente
Konstante | Definiert von | ||
---|---|---|---|
FORM_CLEAN : String = "formClean" [statisch]
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" [statisch]
A special value that specifies that the data is not valid. | FormEvents | ||
FORM_DATA_VALID : String = "formDataValid" [statisch]
A special value that specifies that the data is valid. | FormEvents | ||
FORM_DIRTY : String = "formDirty" [statisch]
A special value that specifies that changes have occurred to the data. | FormEvents | ||
FORM_INITIAL_DATA : String = "formInitialData" [statisch]
A special value that specifies that initial data is sent to the Flex application. | FormEvents | ||
FORM_READY : String = "formReady" [statisch]
A special value that specifies that the Flex application is ready to communicate with
Workspace. | FormEvents | ||
FORM_SAVE_DATA : String = "formSaveData" [statisch]
A special value that specifies that the data was saved by
Workspace. | FormEvents | ||
FORM_SAVE_DATA_REQUEST : String = "formSaveDataRequest" [statisch]
A special value that specifies that the Save Form button was clicked within
Workspace. | FormEvents | ||
FORM_SUBMIT_DATA : String = "formSubmitData" [statisch]
A special value that specifies that the data was successfully submitted by
Workspace to the server. | FormEvents | ||
FORM_SUBMIT_DATA_INVALID : String = "formSubmitDataInvalid" [statisch]
A special value that specifies that invalid data that was submitted. | FormEvents | ||
FORM_SUBMIT_DATA_REQUEST : String = "formSubmitDataRequest" [statisch]
A special value that specifies that the Complete button was clicked within
Workspace. | FormEvents |
FORM_CLEAN | Konstante |
public static const FORM_CLEAN:String = "formClean"
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
Laufzeitversionen: | 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 | Konstante |
public static const FORM_DATA_INVALID:String = "formDataInvalid"
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
Laufzeitversionen: | 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 | Konstante |
public static const FORM_DATA_VALID:String = "formDataValid"
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
Laufzeitversionen: | 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 | Konstante |
public static const FORM_DIRTY:String = "formDirty"
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
Laufzeitversionen: | 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 | Konstante |
public static const FORM_INITIAL_DATA:String = "formInitialData"
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
Laufzeitversionen: | 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 | Konstante |
public static const FORM_READY:String = "formReady"
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
Laufzeitversionen: | 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 | Konstante |
public static const FORM_SAVE_DATA:String = "formSaveData"
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
Laufzeitversionen: | 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 | Konstante |
public static const FORM_SAVE_DATA_REQUEST:String = "formSaveDataRequest"
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
Laufzeitversionen: | 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 | Konstante |
public static const FORM_SUBMIT_DATA:String = "formSubmitData"
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
Laufzeitversionen: | 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 | Konstante |
public static const FORM_SUBMIT_DATA_INVALID:String = "formSubmitDataInvalid"
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
Laufzeitversionen: | 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 | Konstante |
public static const FORM_SUBMIT_DATA_REQUEST:String = "formSubmitDataRequest"
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
Laufzeitversionen: | 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. |
Tue Jun 12 2018, 10:04 AM Z