Expand all

ve.init.sa.Platform

Extends

Constructor

new ve.init.sa.Platform([messagePaths]) #

Initialization Standalone platform.

Example

var platform = new ve.init.sa.Platform( ve.messagePaths );
    platform.initialize().done( () => {
        $( document.body ).append( $( '<p>' ).text(
            platform.getMessage( 'visualeditor' )
        ) );
    } );

Parameters:

Name Type Attributes Default Description
messagePaths Array.<string> optional
 []

Message folder paths
Source:
Initialization Standalone platform.

Properties

addMessages #

Add multiple messages to the localization system.

Overrides:
Source:
Add multiple messages to the localization system.

addParsedMessages #

Add multiple parsed messages to the localization system.

Overrides:
Source:
Add multiple parsed messages to the localization system.

createLocalStorageabstract #

Create a local storage-based conflictable storage object

Inherited from:
Source:
Create a local storage-based conflictable storage object

createSafeStorageabstract #

Create a safe storage object

Overrides:
Source:
Create a safe storage object

createSessionStorageabstract #

Create a session storage-based conflictable storage object

Inherited from:
Source:
Create a session storage-based conflictable storage object

formatNumber #

For a number as a string

Overrides:
Source:
For a number as a string

getConfig #

Get a platform config value

Overrides:
Source:
Get a platform config value

getExternalLinkUrlProtocolsRegExp #

Get an anchored regular expression that matches allowed external link URLs starting at the beginning of an input string.

Overrides:
Source:

Get an anchored regular expression that matches allowed external link URLs starting at the beginning of an input string.

getHtmlMessage #

Get an HTML message from the localization system, with HTML or DOM arguments

Overrides:
Source:
Get an HTML message from the localization system, with HTML or DOM arguments

getLanguageAutonym #

Get a language's autonym from its code.

Overrides:
Source:
Get a language's autonym from its code.

getLanguageCodes #

Get a list of all language codes.

Overrides:
Source:
Get a list of all language codes.

getLanguageDirection #

Get a language's direction from its code.

Overrides:
Source:
Get a language's direction from its code.

getLanguageName #

Get a language's name from its code, in the current user language if possible.

Overrides:
Source:
Get a language's name from its code, in the current user language if possible.

getMessage #

Get a message from the localization system.

Overrides:
Source:
Get a message from the localization system.

getParsedMessage #

Get a parsed message as HTML string.

Does not support $# replacements.

Overrides:
Source:
Get a parsed message as HTML string.

getUnanchoredExternalLinkUrlProtocolsRegExp #

Get an unanchored regular expression that matches allowed external link URLs anywhere in an input string.

Overrides:
Source:

Get an unanchored regular expression that matches allowed external link URLs anywhere in an input string.

getUserConfig #

Get a user config value

Overrides:
Source:
Get a user config value

getUserLanguages #

Get the user language and any fallback languages.

Overrides:
Source:
Get the user language and any fallback languages.

notify #

Show a read-only notification to the user.

Overrides:
Source:
Show a read-only notification to the user.

parseNumber #

Parse a string into a number

Overrides:
Source:
Parse a string into a number

setUserConfig #

Set a user config value

Overrides:
Source:
Set a user config value

Methods

canUseUserConfig() → {boolean} #

Determine whether we can store preferences

Returns:

Type
boolean
Inherited from:
Source:
Determine whether we can store preferences

createConflictableStorage(safeStorage) → {ve.init.ConflictableStorage} #

Create a list storage object from a safe storage object

Parameters:

Name Type Description
safeStorage ve.init.SafeStorage

Returns:

Type
ve.init.ConflictableStorage
Inherited from:
Source:
Create a list storage object from a safe storage object

decodeEntities(html) → {string} #

Decode HTML entities for insertion into the document

Parameters:

Name Type Description
html string

HTML string

Returns:

Type
string
Inherited from:
Source:
Decode HTML entities for insertion into the document

fetchSpecialCharList() → {jQuery.Promise} #

Fetch the special character list object

Returns a promise which resolves with the character list

Returns:

Type
jQuery.Promise
Inherited from:
Source:

Fetch the special character list object

Returns a promise which resolves with the character list

generateUniqueId() → {string} #

Generate a unique ID

Returns:

Type
string
Inherited from:
Source:
Generate a unique ID

getInitializedPromise() → {jQuery.Promise} #

Get a promise to track when the platform has initialized. The platform won't be ready for use until this promise is resolved.

Since the initialization only happens once, and the same (resolved) promise is returned when called again, and since the Platform instance is global (shared between different Target instances) it is important not to rely on this promise being asynchronous.

Returns:

Promise that will be resolved once the platform is ready

Type
jQuery.Promise
Inherited from:
Source:
Get a promise to track when the platform has initialized.

getMessagePaths() → {Array.<string>} #

Get message folder paths

Returns:

Message folder paths

Type
Array.<string>
Source:
Get message folder paths

getMetadataIdRegExp() → {RegExp|null} #

Get a regular expression that matches IDs used only for linking document data to metadata. Use null if your document format does not have such IDs.

Returns:

Regular expression object

Type
RegExp | null
Inherited from:
Source:

Get a regular expression that matches IDs used only for linking document data to metadata.

getUserName() → {string|null} #

Get the current user's name, if the platform supports it

Returns:

User name, or null if not applicable

Type
string | null
Inherited from:
Source:
Get the current user's name, if the platform supports it

hasLanguageCode(code) → {boolean} #

Check if a language code is known to this platform.

Parameters:

Name Type Description
code string

Language code

Returns:

Language code is known

Type
boolean
Inherited from:
Source:
Check if a language code is known to this platform.

initialize() → {jQuery.Promise}private #

Initialize the platform. The default implementation is to do nothing and return a resolved promise. Subclasses should override this if they have asynchronous initialization work to do. The promise rejects if the platform is incompatible.

External callers should not call this. Instead, call #getInitializedPromise.

Returns:

Promise that will be resolved once initialization is done

Type
jQuery.Promise
Overrides:
Source:
Initialize the platform.

processSpecialCharSymbols(symbols) → {Array.<Object>} #

Post-process the symbol list.

If a keyed object format is used, it is converted to an array, and the label property is set from the key when required.

For individual symbols, turns the source property into a CSS class.

Parameters:

Name Type Description
symbols Object | Array

Symbol data

Returns:

Type
Array.<Object>
Inherited from:
Source:
Post-process the symbol list.