(Beta)
| Package | lc.foundation |
| Interface | public interface IPreferencesManager extends IManager , IEventDispatcher |
| Implementors | PreferencesManager |
| 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 |
IPreferencesManagerinterface is implemented
to determine the various preferences properties that the user has set.
Implement the IPreferencesManager interface to retrieve a list of preferences that a user can
set or change.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | faultHandler : Function
The default fault handler function. | IManager | |
| preferences : Object [read-only]
The preferences for this user. | IPreferencesManager | ||
| preferencesCommitRequired : Boolean [read-only]
A flag that indicates whether outstanding preference changes
need to be committed. | IPreferencesManager | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
| 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. | IEventDispatcher | |
|
Dispatches an event into the event flow. | IEventDispatcher | |
|
Determines whether the default operation is prevented. | IManager | |
|
Determines whether the default operation is prevented. | IManager | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
Commits any preference changes that have been made. | IPreferencesManager | ||
Loads all preferences into the manager. | IPreferencesManager | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
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():BooleanMethod 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.
|
Wed Nov 21 2018, 06:34 AM -08:00