Class: SettingsPage

Extends

• BasePage

Members

configModel :ConfigModel

Model to use for configuration

Type:

• ConfigModel

Default Value:

• {}

Source:

• settings-page.js, line 37

groupClass :String

CSS class to use for widget groups

Type:

• String

Default Value:

• span4

Source:

• settings-page.js, line 44

icon :String

Icon for the page

Type:

• String

Default Value:

• icon-cog

Source:

• settings-page.js, line 51

routeEvent :String

Event name to observe on router

Type:

• String

Default Value:

• route:settings

Source:

• settings-page.js, line 72

router :Backbone.Router

Backbone Router used for navigating to specific widgets

Type:

• Backbone.Router

Default Value:

• {}

Source:

• settings-page.js, line 65

routeRoot :String

vent

Type:

• String

Default Value:

• ''

Source:

• settings-page.js, line 79

SaveModalConstructor :Backbone.View

Constructor function for the save modal

Type:

• Backbone.View

Default Value:

• ValidateOnSaveModal

Source:

• settings-page.js, line 157

scrollSelector :String

Page element to scroll

Type:

• String

Default Value:

• ''

Source:

• settings-page.js, line 86

<abstract> strings :SettingsPageStrings

Strings for the settings page.

Type:

• SettingsPageStrings

Default Value:

• {}

Source:

• settings-page.js, line 115

template :function

Template for the view

Type:

• function

Source:

• settings-page.js, line 172

validateUrl :String

Url to which config will be posted for validation

Type:

• String

Default Value:

• ''

Source:

• settings-page.js, line 122

<abstract> vent :Vent

Instance of Vent used for navigation

Type:

• Vent

Source:

• settings-page.js, line 129

widgetGroupParent :String

CSS selector for the DOM element that the widget groups will be attached to

Type:

• String

Source:

• settings-page.js, line 150

widgetGroups :Array.<Array.<module:settings/js/widget.Widget>>

Array of groups of widgets, where each widget group is itself an array. With the default settings each
group should contain at most three widgets. widgetGroups can also be initialized in initializeWidgets

Type:

• Array.<Array.<module:settings/js/widget.Widget>>

Default Value:

• []

Source:

• settings-page.js, line 144

widgets :Array.<module:settings/js/widget.Widget>

Array containing all of the widgets.

Type:

• Array.<module:settings/js/widget.Widget>

Default Value:

• []

Source:

• settings-page.js, line 136

Methods

canLeavePage() → {boolean}

Source:

• settings-page.js, line 238

Returns:

Returns true if the user has unsaved changes, or false otherwise

Type

boolean

getConfig() → {Object}

Returns the combined configuration from all of the widgets

Source:

• settings-page.js, line 225

Returns:

Type

Object

handleBeforeUnload() → {String|undefined}

Event listener for window unload events

Source:

• settings-page.js, line 251

Returns:

this.strings.confirmUnload if the user has unsaved changes, or undefined
otherwise

Type

String | undefined

handleCancelButton() → {boolean}

Opens a confirm modal which will restore changes to configuration if accepted.
Called when the user presses the restore changes button

Source:

• settings-page.js, line 266

Returns:

false

Type

boolean

handleRouting(configItem)

called when navigating to the page.

Parameters:

Name	Type	Description
configItem		The configItem whose widget should be opened and scrolled to

Source:

• settings-page.js, line 289

handleSubmit(e) → {boolean}

Opens a modal which allows the
user to submit changes to the configuration.

Parameters:

Name	Type	Description
e	Event	The jQuery event object

Source:

• settings-page.js, line 308

Returns:

false

Type

boolean

<abstract> initializeWidgets()

Method for initializing this.widgetGroups

Source:

• settings-page.js, line 58

loadFromConfig()

Updates each widget with the appropriate config item from the configModel. Called when the config model
loads

Source:

• settings-page.js, line 377

onConfigSaved(config)

Callback which will be called when the save is complete; can be overridden by subclasses.

Parameters:

Name	Type	Description
config		the saved configuration

Source:

• settings-page.js, line 163

render()

Renders the settings page. This will render all the widgets and append them to the page

Source:

• settings-page.js, line 199

scrollToWidget(widget)

Scrolls the given widget into view

Parameters:

Name	Type	Description
widget	module:settings/js/widget.Widget	The widget to scroll to

Source:

• settings-page.js, line 398

validate(widgets)

Validate the config in the given widgets by posting to validateUrl.

Parameters:

Name	Type	Description
widgets	module:settings/js/widget.Widget | Array.<module:settings/js/widget.Widget>	The widgets to validate

Source:

• settings-page.js, line 408

Type Definitions

DescriptionCallback(systemProperty, path)

Parameters:

Name	Type	Description
systemProperty		The name of the system property containing the config file
path		The path to the config file

Source:

• settings-page.js, line 88