Expand all

abstract ve.ui.TableLineContextItem

Extends

Constructor

new ve.ui.TableLineContextItem(context, model, tool, [config])abstract #

Context item for a table line (row or column) toolset.

Parameters:

Name Type Attributes Description
context ve.ui.TableLineContext

Context the item is in
model ve.dm.Model

Model the item is related to
tool function

Tool class the item is based on
config Object optional

Configuration options
Source:
Context item for a table line (row or column) toolset.

Properties

titlestatic #

Title to use for context item action

Properties:

Type Description
string
Source:
Title to use for context item action

Methods

equals(other) → {boolean} #

Check whether this context item represents the same content as another

Parameters:

Name Type Description
other ve.ui.ContextItem
Inherited from:
Source:

Returns:

Type
boolean
Check whether this context item represents the same content as another

getCommand() → {ve.ui.Command} #

Get the command for this item.

Inherited from:
Source:

Returns:

Type
ve.ui.Command
Get the command for this item.

getFragment() → {ve.dm.SurfaceFragment} #

Get a surface fragment covering the related model node, or the current selection otherwise

Inherited from:
Source:

Returns:

Surface fragment

Type
ve.dm.SurfaceFragment
Get a surface fragment covering the related model node, or the current selection otherwise

getTitle() → {jQuery|string|OO.ui.HtmlSnippet|function} #

Get the title of the tool, used by the button label

Source:

Returns:

Tool title

Type
jQuery | string | OO.ui.HtmlSnippet | function
Get the title of the tool, used by the button label

isNode() → {boolean} #

Check if model is a node

Inherited from:
Source:

Returns:

Model is a node

Type
boolean
Check if model is a node

isReadOnly() → {boolean} #

Check if the context's surface is readOnly

Inherited from:
Source:

Returns:

Context's surface is readOnly

Type
boolean
Check if the context's surface is readOnly

onActionButtonClick()protected #

Handle action button click events.

Source:

Fires:

Handle action button click events.

setup(refreshing) → {ve.ui.ContextItem}chainable #

Setup the item.

Parameters:

Name Type Description
refreshing boolean

If this is a reconstruction/refresh of a context
Overrides:
Source:

Returns:

Type
ve.ui.ContextItem
Setup the item.

teardown() → {ve.ui.ContextItem}chainable #

Teardown the item.

Inherited from:
Source:

Returns:

Type
ve.ui.ContextItem
Teardown the item.

Events

command() #

The context executed a ve.ui.Command

Inherited from:
Source:
The context executed a ve.ui.Command