(Beta)
| Package | lc.procmgmt.ui.layout |
| Class | public class NavigationEvent |
| Inheritance | NavigationEvent  LiveCycleEvent Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
NavigationEvent event is used to manage events when a user
completes a form in LiveCycle Workspace ES2.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| navigationApproved : Boolean
A flag that specifies whether the user can navigate the form. | NavigationEvent | ||
| navigationCallback : Function
The callback function to invoke when the user edits the form. | NavigationEvent | ||
| result : Object
The object that dispatched the event to send the result to. | NavigationEvent | ||
| target : Object [read-only]
The event target. | Event | |
| token : lc.foundation.util:Token [read-only]
The token that represents the call to the method. | LiveCycleEvent | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
NavigationEvent(type:String, object:Object, navigationApproved:Boolean, navigationCallback:Function = null, bubbles:Boolean = true, cancelable:Boolean = false)
Constructor. | NavigationEvent | ||
[override]
Creates a copy of a NavigationEvent object
and sets the value of each property to match that of the original. | NavigationEvent | ||
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| CLEAN : String = "clean" [static]
A special value that specifies that no changes have occurred to the form. | NavigationEvent | ||
| DIRTY : String = "dirty" [static]
A special value that specifies that changes have occurred to the form. | NavigationEvent | ||
| NAVIGATION_CALLBACK : String = "callback" [static]
A special value that specifies that a callback function was set. | NavigationEvent | ||
| NAVIGATION_CANCEL : String = "cancel" [static]
A special value that specifies that the Cancel button was clicked on an Alert box. | NavigationEvent | ||
| NAVIGATION_OK : String = "ok" [static]
A special value that specifies that the OK button was clicked on an Alert box. | NavigationEvent | ||
Property Detail
navigationApproved | property |
public var navigationApproved:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A flag that specifies whether the user can navigate the form. A value of true
specifies that the user can navigate the form. A value of false specifies
that the user cannot modify the form.
navigationCallback | property |
public var navigationCallback:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The callback function to invoke when the user edits the form.
result | property |
public var result:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The object that dispatched the event to send the result to.
Constructor Detail
NavigationEvent | () | Constructor |
public function NavigationEvent(type:String, object:Object, navigationApproved:Boolean, navigationCallback:Function = null, bubbles:Boolean = true, cancelable:Boolean = false)| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Constructor.
Parameterstype:String — Specifies the type of the event.
| |
object:Object — Specifies object that is dispatching the event.
| |
navigationApproved:Boolean — Specifies whether the event object participates bubbling of the event flow.
| |
navigationCallback:Function (default = null) | |
bubbles:Boolean (default = true) | |
cancelable:Boolean (default = false) |
Method Detail
clone | () | method |
override public function clone():Event| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Creates a copy of a NavigationEvent object
and sets the value of each property to match that of the original.
Event — A copy of the NavigationEvent object.
|
Constant Detail
CLEAN | Constant |
public static const CLEAN:String = "clean"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A special value that specifies that no changes have occurred to the form.
DIRTY | Constant |
public static const DIRTY:String = "dirty"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A special value that specifies that changes have occurred to the form.
NAVIGATION_CALLBACK | Constant |
public static const NAVIGATION_CALLBACK:String = "callback"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A special value that specifies that a callback function was set.
NAVIGATION_CANCEL | Constant |
public static const NAVIGATION_CANCEL:String = "cancel"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A special value that specifies that the Cancel button was clicked on an Alert box.
NAVIGATION_OK | Constant |
public static const NAVIGATION_OK:String = "ok"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A special value that specifies that the OK button was clicked on an Alert box.
Mon Nov 18 2013, 11:47 AM -08:00