Referencia de ActionScript® 3.0 para la plataforma de Adobe® Flash®
Inicio  |  Ocultar lista de paquetes y clases |  Paquetes  |  Clases  |  Novedades  |  Índice  |  Apéndices  |  ¿Por qué hay texto en inglés?
Filtros: Recuperando datos del servidor...
Recuperando datos del servidor...
lc.procmgmt.events 

FormEvents  - AS3 ADEP Workspace

Paquetelc.procmgmt.events
Clasepublic class FormEvents
HerenciaFormEvents Inheritance Object

Versión del lenguaje: ActionScript 3.0
Versión de producto: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versiones de motor de ejecución: 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:

  1. The Flex application you create is loaded by Workspace. A setReady event is dispatched after the Flex application application is finished loading.
  2. 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.
  3. 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
  4. 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.
  5. Workspace dispatches a formSaveDataRequest event when the user chooses to save their draft (incomplete) data.
  6. In response to the formSaveDataRequest event, the Flex application must dispatch a formSaveData event with the data as XML.
  7. Workspace dispatches a formSubmitDataRequest event when the user chooses to submit their (completed) data.
  8. 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.
  9. 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

Elementos de API relacionados



Propiedades públicas
 PropiedadDefinido por
 Inheritedconstructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada.
Object
Métodos públicos
 MétodoDefinido por
 Inherited
Indica si un objeto tiene definida una propiedad especificada.
Object
 Inherited
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro.
Object
 Inherited
Indica si existe la propiedad especificada y si es enumerable.
Object
 Inherited
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle.
Object
 Inherited
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional.
Object
 Inherited
Devuelve la representación de cadena del objeto especificado.
Object
 Inherited
Devuelve el valor simple del objeto especificado.
Object
Constantes públicas
 ConstanteDefinido por
  FORM_CLEAN : String = "formClean"
[estática] 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"
[estática] A special value that specifies that the data is not valid.
FormEvents
  FORM_DATA_VALID : String = "formDataValid"
[estática] A special value that specifies that the data is valid.
FormEvents
  FORM_DIRTY : String = "formDirty"
[estática] A special value that specifies that changes have occurred to the data.
FormEvents
  FORM_INITIAL_DATA : String = "formInitialData"
[estática] A special value that specifies that initial data is sent to the Flex application.
FormEvents
  FORM_READY : String = "formReady"
[estática] A special value that specifies that the Flex application is ready to communicate with Workspace.
FormEvents
  FORM_SAVE_DATA : String = "formSaveData"
[estática] A special value that specifies that the data was saved by Workspace.
FormEvents
  FORM_SAVE_DATA_REQUEST : String = "formSaveDataRequest"
[estática] A special value that specifies that the Save Form button was clicked within Workspace.
FormEvents
  FORM_SUBMIT_DATA : String = "formSubmitData"
[estática] A special value that specifies that the data was successfully submitted by Workspace to the server.
FormEvents
  FORM_SUBMIT_DATA_INVALID : String = "formSubmitDataInvalid"
[estática] A special value that specifies that invalid data that was submitted.
FormEvents
  FORM_SUBMIT_DATA_REQUEST : String = "formSubmitDataRequest"
[estática] A special value that specifies that the Complete button was clicked within Workspace.
FormEvents
Información sobre constantes

FORM_CLEAN

Constante
public static const FORM_CLEAN:String = "formClean"

Versión del lenguaje: ActionScript 3.0
Versión de producto: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versiones de motor de ejecución: 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:

PropertyValue
bubbles true
cancelable false; there is no default behavior to cancel.
currentTargetThe 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

Constante 
public static const FORM_DATA_INVALID:String = "formDataInvalid"

Versión del lenguaje: ActionScript 3.0
Versión de producto: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versiones de motor de ejecución: 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:

PropertyValue
bubbles true
cancelable false; there is no default behavior to cancel.
currentTargetThe 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

Constante 
public static const FORM_DATA_VALID:String = "formDataValid"

Versión del lenguaje: ActionScript 3.0
Versión de producto: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versiones de motor de ejecución: 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:

PropertyValue
bubbles true
cancelable false; there is no default behavior to cancel.
currentTargetThe 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

Constante 
public static const FORM_DIRTY:String = "formDirty"

Versión del lenguaje: ActionScript 3.0
Versión de producto: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versiones de motor de ejecución: 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:

PropertyValue
bubbles true
cancelable false; there is no default behavior to cancel.
currentTargetThe 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

Constante 
public static const FORM_INITIAL_DATA:String = "formInitialData"

Versión del lenguaje: ActionScript 3.0
Versión de producto: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versiones de motor de ejecución: 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:

PropertyValue
bubbles true
cancelable false; there is no default behavior to cancel.
currentTargetThe 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

Constante 
public static const FORM_READY:String = "formReady"

Versión del lenguaje: ActionScript 3.0
Versión de producto: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versiones de motor de ejecución: 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:

PropertyValue
bubbles true
cancelable false; there is no default behavior to cancel.
currentTargetThe 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

Constante 
public static const FORM_SAVE_DATA:String = "formSaveData"

Versión del lenguaje: ActionScript 3.0
Versión de producto: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versiones de motor de ejecución: 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:

PropertyValue
bubbles true
cancelable false; there is no default behavior to cancel.
currentTargetThe 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

Constante 
public static const FORM_SAVE_DATA_REQUEST:String = "formSaveDataRequest"

Versión del lenguaje: ActionScript 3.0
Versión de producto: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versiones de motor de ejecución: 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:

PropertyValue
bubbles true
cancelable false; there is no default behavior to cancel.
currentTargetThe 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

Constante 
public static const FORM_SUBMIT_DATA:String = "formSubmitData"

Versión del lenguaje: ActionScript 3.0
Versión de producto: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versiones de motor de ejecución: 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:

PropertyValue
bubbles true
cancelable false; there is no default behavior to cancel.
currentTargetThe 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

Constante 
public static const FORM_SUBMIT_DATA_INVALID:String = "formSubmitDataInvalid"

Versión del lenguaje: ActionScript 3.0
Versión de producto: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versiones de motor de ejecución: 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:

PropertyValue
bubbles true
cancelable false; there is no default behavior to cancel.
currentTargetThe 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

Constante 
public static const FORM_SUBMIT_DATA_REQUEST:String = "formSubmitDataRequest"

Versión del lenguaje: ActionScript 3.0
Versión de producto: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versiones de motor de ejecución: 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:

PropertyValue
bubbles true
cancelable false; there is no default behavior to cancel.
currentTargetThe 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.





[ X ]¿Por qué hay texto en inglés?
Cierto contenido de la Referencia de ActionScript 3.0 se muestra en inglés

No todo el contenido de la Referencia de ActionScript 3.0 se traduce a todos los idiomas. Si un elemento del lenguaje no se traduce, aparecerá en inglés. Por ejemplo, la clase ga.controls.HelpBox no está traducida en ningún idioma. Por lo tanto, en la versión en español de la referencia, la clase ga.controls.HelpBox aparecerá en inglés.