ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
lc.foundation 

IPreferencesManager  - AS3 ADEP Workspace
Packagelc.foundation
Interfacepublic interface IPreferencesManager extends IManager , IEventDispatcher
Implementors PreferencesManager

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

The IPreferencesManagerinterface is implemented to manage the various preferences that the user has access to.

Implement the IPreferencesManager interface to retrieve a list of preferences that a user can set or change.

Preferences that start with "/" are system properties and cannot be modified; Preferences that do not start with "/" are user properties and can be modified.


Public Properties
 PropertyDefined By
 InheritedfaultHandler : Function
The default fault handler function.
IManager
Public Methods
 MethodDefined By
 Inherited
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
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
IEventDispatcher
  
getPreferencesStartingWith(namePrefix:String):ListCollectionView
Get a list of all preferences starting with a provided prefix.
IPreferencesManager
  
getPreferenceValue(name:String):Object
Get the value of the preference with the provided name.
IPreferencesManager
 Inherited
handleEvent(token:lc.foundation.util:Token, event:LiveCycleEvent):void
Determines whether the default operation is prevented.
IManager
 Inherited
handleFault(token:lc.foundation.util:Token, event:LiveCycleFaultEvent):void
Determines whether the default operation is prevented.
IManager
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
preferencesLoad(types:String):lc.foundation.util:Token
Loads all preferences into the manager.
IPreferencesManager
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
  
setPreferenceValue(name:String, value:Object):void
Set the value of the preference with the provided name.
IPreferencesManager
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
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.

Returns
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.

Returns
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)

Returns
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.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy