Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
{anchor:top} The Temporary Settings Store subcomponent is used by [UI Enhancer] to store/save user preferences temporarily, without persistence. This store may be useful for testing situations. For a settings store that persists, use the [Cookie Settings Store]. *Do not use this component directly.* The information on this page should be use when customizing UI Enhancer. *See Also* [UI Enhancer] [Cookie Settings Store] {div2:class=summary-table} ||Supported Events| _none_ | ||[#Methods]| {{[#fetch()]}}\\ Retrieves the current settings.\\ {{[#save(settings)]}}\\ Saves the specified settings. | {div2} h2. Methods {span:class=back-to-top}[back to top|#top]{span} h3. fetch() {div2:class=api-table} ||Description|Retrieves the current settings. | ||Parameters| _none_ | ||Return value| A JavaScript object containing the currently stored settings. This object has the following format:{code:javascript}

Div
classcomponent-api-page
Wiki Markup
Anchor
top
top

The Temporary Settings Store subcomponent is used by UI Enhancer to store/save user preferences temporarily, without persistence. This store may be useful for testing situations. For a settings store that persists, use the Cookie Settings Store.

Do not use this component directly. The information on this page should be use when customizing UI Enhancer.

See Also
UI Enhancer
Cookie Settings Store

Div
classsummary-table

Supported Events

none

#Methods

#fetch()
Retrieves the current settings.
#save(settings)
Saves the specified settings.

Methods

Span
classback-to-top
back to top

fetch()

Div
classapi-table

Description

Retrieves the current settings.

Parameters

none

Return value

A JavaScript object containing the currently stored settings. This object has the following format:

Code Block
javascript
javascript
{
    textFont: <string>, // key from classname map
    theme: <string>, // key from classname map
    textSize: <number>, // in points
    lineSpacing: <number>, // in ems
    layout: <boolean>,
    toc: <boolean>,
    links: <boolean>,
    inputsLarger: <boolean>
}
{code}| ||Availability| Infusion

Availability

Infusion 1.4

and

later

| ||

See

also

| {{[]}} | {div2} h3.

save(settings)

{div2:class=

} ||Description|Stores the specified settings. | ||Parameters| _settings_\\ A JavaScript object containing the settings to be stored.\\ Form:{code:javascript}
Div
classapi-table

Description

Stores the specified settings.

Parameters

settings
A JavaScript object containing the settings to be stored.
Form:

Code Block
javascript
javascript
{
    textFont: <string>, // key from classname map
    theme: <string>, // key from classname map
    textSize: <number>, // in points
    lineSpacing: <number>, // in ems
    layout: <boolean>,
    toc: <boolean>,
    links: <boolean>,
    inputsLarger: <boolean>
}
{code}| ||Availability| Infusion

Availability

Infusion 1.4

and

later

| ||

See

also

| {{[]}} | {div2}