jsx3.app

class UserSettings

Object

->jsx3.lang.Object

->jsx3.app.UserSettings

class UserSettings
extends jsx3.lang.Object

Read-Write per-User settings for a particular GI application (server).

This implementation stores settings in a browser cookie.

Since:

3.0

Field Summary
static int	PERSIST_INDEFINITE
static int	PERSIST_SESSION

Constructor Summary
void	init(objServer : jsx3.app.Server, intPersistence : int) The instance initializer.

Method Summary
void	clear() Clears all settings of this user settings instance.
String \| Number \| boolean \| Array \| Object	get(strKey : String...) Returns a stored setting value.
void	remove(strKey : String...) Removes a stored setting value.
void	save() Persists the user settings.
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

Field Detail

PERSIST_INDEFINITE

static final int PERSIST_INDEFINITE

PERSIST_SESSION

static final int PERSIST_SESSION

Constructor Detail

init

void init(objServer : jsx3.app.Server, intPersistence : int)

The instance initializer.

Parameters:

objServer – the app server.

intPersistence – the persistence code, defaults to PERSIST_INDEFINITE.

Method Detail

clear

void clear()

Clears all settings of this user settings instance. This implementation deletes the cookie.

get

String | Number | boolean | Array | Object get(strKey : String...)

Returns a stored setting value.

Parameters:

strKey – the setting key.

Returns:

the stored value.

remove

void remove(strKey : String...)

Removes a stored setting value.

Parameters:

strKey – the key of the setting to remove.

save

void save()

Persists the user settings. Any modifications to this user settings instance will be lost if this method is not called.

set

void set(strKey : String..., value : String | Number | boolean | Array | Object)

Sets a stored setting value.

Parameters:

strKey – the setting key.

value – the value to store.