Class Index | File Index

Classes


Class orion.preferences.Preferences

A preferences object returned by the preferences service
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.core/web/orion/preferences.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Constructs a new preferences instance.
Method Summary
Method Attributes Method Name and Description
 
Removes all preferences from this preference node.
 
Flushes all preference changes in this node to its backing storage.
 
get(key)
Returns the value of the preference with the given key
 
keys()
Returns an array of String preference keys available in this node.
 
put(key, value)
Associates a new preference value with the given key, replacing any existing value.
 
remove(key)
Removes the preference with the given key.
 
sync(optForce)
Synchronizes this preference node with its storage.
Class Detail
orion.preferences.Preferences()
Constructs a new preferences instance. This constructor is not intended to be used by clients. Preferences should instead be obtained from a preference service
See:
orion.preferences.PreferencesService
Method Detail
clear()
Removes all preferences from this preference node.

flush()
Flushes all preference changes in this node to its backing storage.

get(key)
Returns the value of the preference with the given key
Parameters:
{String} key
The preference key to return

keys()
Returns an array of String preference keys available in this node.

put(key, value)
Associates a new preference value with the given key, replacing any existing value.
Parameters:
{String} key
The preference key
{String} value
The preference value

remove(key)
Removes the preference with the given key. Has no effect if no such key is defined.
Parameters:
{String} key
The preference key to remove

sync(optForce)
Synchronizes this preference node with its storage. Any new values in the storage area will become available to this preference object.
Parameters:
optForce

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Apr 01 2014 22:58:24 GMT-0400 (EDT)