lwh.pref

Overview

File

Class

Tree

Index

Help

LogWeb V3 Default Emulator (AJAX based)

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Class lwh.pref

Object
   |
   +--lwh.pref

class lwh.pref

Defines the Preferences library. Uses Cookie "lwPref" to save the preferences across sessions.

2006-11-16 / JF handle default values in preferences object lwh.pref.initial
Defined in lwhpref.js

Requires:

lw.Cookie

Field Summary
`<static> {String}`	`cookiePrefix` meta preference: the cookie name prefix.
`<static> Object`	`defaults` Default user preferences.
`<static> Object`	`initial` Initial user preferences.

Constructor Summary
`lwh.pref ()` Defines the Preferences library.

Method Summary
`<static> Object`	`cookieName()` returns the preferences cookie name
`<static> void`	`load()` Loads the preferences from the "lwPref" Cookie.
`<static> void`	`remove()` removes the "lwPref" Cookie.
`<static> void`	`restore()` restores the default preferences.
`<static> void`	`save()` saves the current preferences in the "lwPref" Cookie.

Field Detail

cookiePrefix

<static> {String} cookiePrefix

meta preference: the cookie name prefix.

defaults

<static> Object defaults

These values will be used on session start and on reset
Corresponding Cookie values will be ignored
Users may modify these values via corresponding menu entry (if menu entry is available)
On session end, the current values will NOT be saved in a Cookie on the user PC

initial

<static> Object initial

These values will be used if no Cookie is found, or when user resets to initial values.
Users may modify these values via corresponding menu entry (if menu entry is available)
On session end, the current values will be saved in a Cookie on the user PC (if enabled)
On next session start, current values will be loaded from Cookie and used instead of the initial values (if a Cookie is found).
Moving an entry from this list to lwh.pref.defaults list has following effects:
- Entry will not be loaded from Cookie
- On session start and on reset, value from lwh.pref.defaults list will be used instead
- User may temporarily change value via corresponding menu entry (if menu entry is available)
- On session end, entry will not be saved to Cookie

Constructor Detail

lwh.pref

lwh.pref()

Defines the Preferences library. Uses Cookie "lwPref" to save the preferences across sessions.

Requires:

lw.Cookie

Method Detail

cookieName

<static> Object cookieName()

returns the preferences cookie name

load

<static> void load()

Loads the preferences from the "lwPref" Cookie. Only elements contained in default values will be restored. If some elements are missing in Cookie: use default values. If the Cookie is missing altogether: load all from default values. Default values are defined by lwh.pref.initial and lwh.pref.defaults (both set in _default.js). Current values defined in lwh.pref.initial will be saved to "lwPref" Cookie. Values defined in lwh.pref.defaults will override Cookie or initial values.

See:

lwh.pref.initial

lwh.pref.defaults

lwh.pref.cookieName()

remove

<static> void remove()

removes the "lwPref" Cookie.

restore

<static> void restore()

restores the default preferences.

save

<static> void save()

saves the current preferences in the "lwPref" Cookie. keep cookie for a year.