OverviewSingleDeprecatedPropertiesEventsXSL Parameters

jsx3.app

class Settings

Object
->jsx3.lang.Object
  ->jsx3.app.Settings

class Settings
extends jsx3.lang.Object
An object oriented interface onto the XML system settings format. Note that this class has no ability to save preferences to disk or other medium. However, the source XML data is returned by calling getNode() with no parameters.

Since:

3.0

Constructor Summary
void
The instance initializer.
Method Summary
String | Number | boolean | Array | Object
get(strKey : String...)
Returns a stored setting value.
jsx3.xml.Entity
getNode(strKey : String...)
Returns a stored setting value as the raw XML node.
void
remove(strKey : String...)
Removes a stored setting value.
void
set(strKey : String..., value : String | Number | boolean | Array | Object)
Sets a stored setting value.
Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString
Constructor Detail

init

void init(objXML : jsx3.xml.Document)
The instance initializer. Creates a view onto the settings persisted on disk. All identical instances of this class are backed by the same XML source document.

Parameters:

objXMLthe underlying XML datasource.
Method Detail

get

String | Number | boolean | Array | Object get(strKey : String...)
Returns a stored setting value.

Parameters:

strKeythe setting key.

Returns:

the stored value.  

getNode

jsx3.xml.Entity getNode(strKey : String...)
Returns a stored setting value as the raw XML node.

Parameters:

strKeythe setting key.

Returns:

 

remove

void remove(strKey : String...)
Removes a stored setting value.

Parameters:

strKey

Since:

3.6

set

void set(strKey : String..., value : String | Number | boolean | Array | Object)
Sets a stored setting value.

Parameters:

strKey
valuethe value to store, map be string, number, boolean, array, or object (map)

Since:

3.6