Expand all

ve.ui.MWSettingsPage

Extends

Constructor

new ve.ui.MWSettingsPage(name, [config]) #

MediaWiki meta dialog settings page.

Parameters:

Name Type Attributes Description
name string

Unique symbolic name of page
config Object optional

Configuration options

Properties:
Name Type Attributes Description
$overlay jQuery optional

Overlay to render dropdowns in
Source:
MediaWiki meta dialog settings page.

Methods

checkValidRedirect() → {boolean} #

Source:

Returns:

Whether redirect link is valid.

Type
boolean

getMetaItem(name) → {Object|null} #

Get the first meta item of a given name

Parameters:

Name Type Description
name string

Name of the meta item
Source:

Returns:

Meta item, if any

Type
Object | null
Get the first meta item of a given name

onEnableRedirectChange(value) #

Handle redirect state change events.

Parameters:

Name Type Description
value boolean

Whether a redirect is to be set for this page
Source:
Handle redirect state change events.

onEnableStaticRedirectChange() #

Handle static redirect state change events.

Source:
Handle static redirect state change events.

onRedirectTargetChange() #

Handle redirect target change events.

Source:
Handle redirect target change events.

onTableOfContentsFieldChange() #

Handle Table Of Contents display change events.

Source:
Handle Table Of Contents display change events.

setup(fragment, config) → {jQuery.Promise} #

Setup settings page.

Parameters:

Name Type Description
fragment ve.dm.SurfaceFragment

Surface fragment
config Object
Properties:
Name Type Attributes Default Description
data Object optional

Dialog setup data
isReadOnly boolean optional
 false

Dialog is in read-only mode
Source:

Returns:

Type
jQuery.Promise
Setup settings page.

setupOutlineItem() #

Source:

teardown([data]) #

Tear down settings page.

Parameters:

Name Type Attributes Description
data Object optional

Dialog tear down data
Source:
Tear down settings page.

addMetaCheckbox(metaName, label)static #

Add a checkbox to the list of changeable page settings

Parameters:

Name Type Description
metaName string

The name of the DM meta item
label string

The label to show next to the checkbox
Source:
Add a checkbox to the list of changeable page settings