SettingsDialog

SettingsDialog

Class used to create a settings dialog.

Constructor

new SettingsDialog(initialPageNameopt)

Source:

Create a settings dialog.

Parameters:
Name Type Attributes Description
initialPageName string <optional>

Extends

Methods

(protected) collectSettings() → {object}

Source:

Get setting values from controls.

Returns:
Type
object

confirmClose()

Source:
Overrides:

Confirm closing the dialog.

(protected) createPages(settingValues) → {object}

Source:

Create widget fields with states of controls set according to setting values.

Parameters:
Name Type Description
settingValues object

Values of settings according to which to set the states of controls.

Returns:
Type
object

(protected) getStateSettings() → {object}

Source:

Get an object with settings related to states (see module:settings.scheme).

Returns:
Type
object

(protected) handleError(e, messageName, recoverable)

Source:
Overrides:

Handle a error, displaying a message with the provided name and popping the pending state. If the error is not recoverable, the dialog is closed on "Dismiss".

Parameters:
Name Type Description
e CdError | Error
messageName string
recoverable boolean

isUnsaved() → {boolean}

Source:
Overrides:

Check if there are unsaved changes.

Returns:
Type
boolean

(protected) onDesktopNotificationsSelectChange(option)

Source:

Handler of the event of change of the desktop notifications radio select.

Parameters:
Name Type Description
option external:OO.ui.RadioOptionWidget

(async, protected) removeData()

Source:

Remove script data as requested by the user after confirmation.

(protected) renderControls(settingValues)

Source:

Render control widgets.

Parameters:
Name Type Description
settingValues object

Values of settings according to which to set the states of controls.

(async, protected) updateStates()

Source:

Update the control states.