Expand all

ve.ui.TargetToolbar

Extends

Constructor

new ve.ui.TargetToolbar(target, [config]) #

UserInterface target toolbar.

Parameters:

Name Type Attributes Description
target ve.init.Target

Target to control
config Object optional

Configuration options
Source:
UserInterface target toolbar.

Methods

destroy() #

Destroys toolbar, removing event handlers and DOM elements.

Call this whenever you are done using a toolbar.

Inherited from:
Source:
Destroys toolbar, removing event handlers and DOM elements.

detach() #

Detach toolbar from surface and all event listeners

Inherited from:
Source:
Detach toolbar from surface and all event listeners

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

Get a list of commands available to this toolbar's surface

Overrides:
Source:

Returns:

Command names

Type
Array.<string>
Get a list of commands available to this toolbar's surface

getSurface() → {ve.ui.Surface|null} #

Gets the surface which the toolbar controls.

Returns null if the toolbar hasn't been set up yet.

Inherited from:
Source:

Returns:

Surface being controlled

Type
ve.ui.Surface | null
Gets the surface which the toolbar controls.

getTarget() → {ve.init.Target} #

Gets the target which the toolbar controls.

Source:

Returns:

Target being controlled

Type
ve.init.Target
Gets the target which the toolbar controls.

getToolAccelerator() #

Inherited from:
Source:

getTriggers(name) → {Array.<ve.ui.Trigger>|undefined} #

Get triggers for a specified name.

Parameters:

Name Type Description
name string

Trigger name
Overrides:
Source:

Returns:

Triggers

Type
Array.<ve.ui.Trigger> | undefined
Get triggers for a specified name.

isToolAvailable() #

Inherited from:
Source:

onContextChange() #

Handle context changes on the surface.

Inherited from:
Source:

Fires:

Handle context changes on the surface.

onInspectorOrDialogOpeningOrClosing(win, openingOrClosing, data) #

Handle windows opening or closing in the dialogs' or inspectors' window manager.

Parameters:

Name Type Description
win OO.ui.Window
openingOrClosing jQuery.Promise
data Object
Inherited from:
Source:
Handle windows opening or closing in the dialogs' or inspectors' window manager.

setup(groups, [surface]) #

Setup toolbar

Parameters:

Name Type Attributes Description
groups Object

List of tool group configurations
surface ve.ui.Surface optional

Surface to attach to
Inherited from:
Source:

Fires:

Setup toolbar

updateToolState() #

Update the state of the tools

Inherited from:
Source:

Fires:

Update the state of the tools

Events

resize() #

Inherited from:
Source:

surfaceChange(oldSurface, newSurface) #

Parameters:

Name Type Description
oldSurface ve.ui.Surface | null

Old surface being controlled
newSurface ve.ui.Surface | null

New surface being controlled
Inherited from:
Source:

updateState(fragment, direction, activeDialogs) #

Parameters:

Name Type Description
fragment ve.dm.SurfaceFragment | null

Surface fragment. Null if no surface is active.
direction Object | null

Context direction with 'inline' & 'block' properties if a surface exists. Null if no surface is active.
activeDialogs Array.<string>

List of names of currently open dialogs.
Inherited from:
Source: