Class: PathsWidget

Extends

• module:settings/js/widget.Widget

Members

className :string

Classes applied to the widget. Override if using Bootstrap 3

Type:

• string

Inherited From:

• module:settings/js/widget.Widget#className

Default Value:

• row-fluid accordion-group

Source:

• widget.js, line 41

controlGroupClass

Class applied to control groups. Set to 'form-group' if using Bootstrap 3

Inherited From:

• module:settings/js/widget.Widget#controlGroupClass

Default Value:

• control-group

Source:

• widget.js, line 54

errorClass

Class used to indicate failed validation. Set to 'has-error' if using Bootstrap 3

Inherited From:

• module:settings/js/widget.Widget#errorClass

Default Value:

• error

Source:

• widget.js, line 72

formControlClass

Class applied to form controls. Set to 'form-control' if using Bootstrap 3

Inherited From:

• module:settings/js/widget.Widget#formControlClass

Default Value:

• ''

Source:

• widget.js, line 60

itemTemplate :module:settings/js/widgets/path-widget.PathWidget~PathTemplate

Template for each individual row. Override if using Bootstrap 3

Type:

• module:settings/js/widgets/path-widget.PathWidget~PathTemplate

Source:

• widgets/paths-widget.js, line 48

successClass

Class used to indicate successful validation. Set to 'has-success' if using Bootstrap 3

Inherited From:

• module:settings/js/widget.Widget#successClass

Default Value:

• success

Source:

• widget.js, line 66

template :module:settings/js/widgets/paths-widget.PathsWidget~PathsTemplate

Base template for the widget. Override if using Bootstrap 3

Type:

• module:settings/js/widgets/paths-widget.PathsWidget~PathsTemplate

Source:

• widgets/paths-widget.js, line 54

widgetTemplate :module:settings/js/widget.Widget~WidgetTemplate

Base template for the widget. Override if using Bootstrap 3

Type:

• module:settings/js/widget.Widget~WidgetTemplate

Inherited From:

• module:settings/js/widget.Widget#widgetTemplate

Source:

• widget.js, line 90

Methods

getConfig() → {PathsConfig}

Gets the configuration associated with the widget

Source:

• widgets/paths-widget.js, line 102

Returns:

The configuration associated with the widget

Type

PathsConfig

getName() → {string}

Gets the name for the widget

Inherited From:

• module:settings/js/widget.Widget#getName

Deprecated:

• Users of this class do not need to call this

Source:

• widget.js, line 131

Returns:

this.serverName, or this.configItem if serverName is undefined

Type

string

handleInputChange()

Handler for change events on any inputs in the widget. Calls hideValidationInfo and
setValidationFormatting

Inherited From:

• module:settings/js/widget.Widget#handleInputChange

Source:

• widget.js, line 139

<abstract> handleValidation(config, response) → {boolean}

Handles the results of server side validation (several widgets have a Test Connection button to do
this). Override this method if your widget needs server side validation

Parameters:

Name	Type	Description
config	object	The configuration object for the widget
response	ValidationResponse	The validation response from the server

Inherited From:

• module:settings/js/widget.Widget#handleValidation

Source:

• widget.js, line 158

Returns:

True if the widget is valid; false otherwise

Type

boolean

hideValidationInfo()

Hides any validation information (elements with the settings-client-validation class)

Inherited From:

• module:settings/js/widget.Widget#hideValidationInfo

Source:

• widget.js, line 163

render()

Renders the widget

Source:

• widgets/paths-widget.js, line 87

setValidationFormatting(state)

Removes this.successClass and this.errorClass from elements in the widget with this.controlGroupClass.

If state === 'clear', remove successClass and errorClass from this.$el. Otherwise adds the given class
and removes the other class

Parameters:

Name	Type	Description
state	string	clear to remove classes, otherwise this.successClass or this.errorClass to add that class and remove the other class

Inherited From:

• module:settings/js/widget.Widget#setValidationFormatting

Source:

• widget.js, line 174

<abstract> shouldValidate() → {boolean}

Returns false by default; override it to return true if your widget needs client side validation

Inherited From:

• module:settings/js/widget.Widget#shouldValidate

Source:

• widget.js, line 190

Returns:

True if the widget should validate; false otherwise

Type

boolean

updateConfig(config)

Updates the widget with the given configuration

Parameters:

Name	Type	Description
config	PathsConfig	The new configuration

Source:

• widgets/paths-widget.js, line 111

<protected> updateInputValidation($input, isValid)

Updates the formatting of the given input

If isValid is true, removes errorClass from the input and hides elements with the class
settings-client-validation

If isValid is false, adds errorClass to the input and shows elements with the class
settings-client-validation

Parameters:

Name	Type	Description
$input	jQuery	The input to apply the classes to
isValid	boolean	True if the input is valid; false otherwise

Inherited From:

• module:settings/js/widget.Widget#updateInputValidation

Source:

• widget.js, line 214

<protected> updateRemoveButtons()

Disables the remove buttons when the number of inputs reaches 1, enables them otherwise

Source:

• widgets/paths-widget.js, line 123

validateInputs() → {boolean}

Validates the widget and applies formatting accordingly

Source:

• widgets/paths-widget.js, line 131

Returns:

False if any of the paths is empty; true otherwise

Type

boolean

Type Definitions

PathsTemplate(parameters)

Parameters:

Name	Type	Description
parameters	PathsWidgetTemplateParameters

Source:

• widgets/paths-widget.js, line 40