Expand all

abstract ve.ui.FormatTool

Extends

Constructor

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

UserInterface format tool.

Parameters:

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

Configuration options
Source:
UserInterface format tool.

Properties

formatabstractstatic #

Format the tool applies.

Object should contain a required type and optional attributes property.

Properties:

Type Description
Object
Source:
Format the tool applies.

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.

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.