| Package | lc.foundation |
| Class | public class PreferencesManager |
| Inheritance | PreferencesManager  Manager |
| Implements | IPreferencesManager |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
PreferencesManager class is the standard implementation of the
ISessionManager interface.
Public Methods
| Method | Defined By | ||
|---|---|---|---|
PreferencesManager(session:SessionMap)
Constructor. | PreferencesManager | ||
Get a list of all preferences starting with a provided prefix. | PreferencesManager | ||
Get the value of the preference with the provided name. | PreferencesManager | ||
Loads all preferences into the manager. | PreferencesManager | ||
Set the value of the preference with the provided name. | PreferencesManager | ||
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 | ||
Constructor Detail
PreferencesManager | () | Constructor |
public function PreferencesManager(session:SessionMap)| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Constructor.
Parameterssession:SessionMap — Specifies the SessionMap object to use.
|
Method Detail
getPreferencesStartingWith | () | method |
public function getPreferencesStartingWith(namePrefix:String):ListCollectionView| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Get a list of all preferences starting with a provided prefix.
Parameters
namePrefix:String — preference prefix.
|
ListCollectionView — A list of all preferences starting with a provided prefix.
|
getPreferenceValue | () | method |
public function getPreferenceValue(name:String):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Get the value of the preference with the provided name.
Parameters
name:String — preference name.
|
Object — The value of the preference with the provided name.
|
preferencesLoad | () | method |
public function preferencesLoad(types:String):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Loads all preferences into the manager.
Parameters
types:String — Specifies the preferences to load. (Not implemented)
|
lc.foundation.util:Token — A token used to set result and fault handlers that execute when the operation completes.
|
setPreferenceValue | () | method |
public function setPreferenceValue(name:String, value:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Set the value of the preference with the provided name. Attempting to set the value of a system preference will be silently ignored.
Parameters
name:String — The name of preference.
| |
value:Object — The value of the preference.
|
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 Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies the manager key name in the SessionMap object.
Thu Dec 6 2018, 01:12 PM -08:00