(Beta)
| Package | lc.foundation |
| Class | public class PreferencesManager |
| Inheritance | PreferencesManager  Manager EventDispatcher Object |
| Implements | IPreferencesManager |
| 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 |
PreferencesManager class is the standard implementation of the
ISessionManager interface.
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 | |
| preferences : Object [read-only]
The preferences for this user. | PreferencesManager | ||
| preferencesCommitRequired : Boolean [read-only]
A flag that indicates whether outstanding preference changes
need to be committed. | PreferencesManager | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
PreferencesManager(session:SessionMap)
Constructor. | PreferencesManager | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Commits any preference changes that have been made. | PreferencesManager | ||
Loads all preferences into the manager. | PreferencesManager | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| SESSION_KEY : String = "lc.foundation.IPreferencesManager" [static]
A special value that specifies the manager key name in the SessionMap object. | PreferencesManager | ||
Property Detail
preferences | property |
preferences:Object [read-only] | 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 |
The preferences for this user. Properties that start with "/" are
system properties and cannot be modified; properties that do not start
with "/" are user properties and can be modified.
Although this property is read-only, it is possible to modify the object,
and the changes are automatically passed to the LiveCycle ES2 server
when the preferencesCommit() method is called.
Implementation
public function get preferences():ObjectpreferencesCommitRequired | property |
preferencesCommitRequired:Boolean [read-only] | 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 |
A flag that indicates whether outstanding preference changes
need to be committed. A value of true indicates that a commit
is required.
Implementation
public function get preferencesCommitRequired():BooleanConstructor Detail
PreferencesManager | () | Constructor |
public function PreferencesManager(session:SessionMap)| 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 |
Constructor.
Parameterssession:SessionMap — Specifies the location of the server URL. If the URL is a value of
null, the default is to access the LiveCycle ES2 server at the
same location where LiveCycle Workspace ES2 SWF file is loaded from.
|
Method Detail
preferencesCommit | () | method |
public function preferencesCommit():lc.foundation.util:Token| 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 |
Commits any preference changes that have been made.
Returnslc.foundation.util:Token — A token used to set result and fault handlers that execute when the operation completes.
|
preferencesLoad | () | method |
public function preferencesLoad(types:String):lc.foundation.util:Token| 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 |
Loads all preferences into the manager.
Parameters
types:String — Specifies the preferences to load.
|
lc.foundation.util:Token — A token used to set result and fault handlers that execute when the operation completes.
|
Constant Detail
SESSION_KEY | Constant |
public static const SESSION_KEY:String = "lc.foundation.IPreferencesManager"| 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 |
A special value that specifies the manager key name in the SessionMap object.
Wed Nov 21 2018, 06:34 AM -08:00