Expand all

abstract ve.ui.FragmentWindowTool

Extends

Constructor

new ve.ui.FragmentWindowTool(toolGroup, [config])abstract #

UserInterface fragment window tool.

Parameters:

Name Type Attributes Description
toolGroup OO.ui.ToolGroup
config Object optional

Configuration options
Source:
UserInterface fragment window tool.

Properties

modelClassesstatic #

Annotation or node models this tool is related to.

Used by #isCompatibleWith.

Properties:

Type Description
Array.<function()>
Source:
Annotation or node models this tool is related to.

Methods

getCommand() → {ve.ui.Command|null|undefined} #

Get the command for this tool.

Inherited from:
Source:

Returns:

Undefined means command not found, null means no command set

Type
ve.ui.Command | null | undefined
Get the command for this tool.

getSelectedModels(fragment) → {Array.<ve.dm.Model>} #

Get list of selected nodes and annotations.

Parameters:

Name Type Description
fragment ve.dm.SurfaceFragment | null

Surface fragment
Source:

Returns:

Selected models

Type
Array.<ve.dm.Model>
Get list of selected nodes and annotations.

onSelect() #

Inherited from:
Source:

onUpdateState(fragment, direction) #

Handle the toolbar state being updated.

Parameters:

Name Type Description
fragment ve.dm.SurfaceFragment | null

Surface fragment
direction Object | null

Context direction with 'inline' & 'block' properties
Overrides:
Source:
Handle the toolbar state being updated.

isCompatibleWith()static #

Source: