Expand all

ve.ui.TableLineContext

Extends

Constructor

new ve.ui.TableLineContext(tableNode, itemGroup, [config]) #

Context menu for editing tables.

Three are usually generated for column, row and (on mobile) table-wide actions separately.

Parameters:

Name Type Attributes Description
tableNode ve.ce.TableNode
itemGroup string

Tool group to use, 'col', 'row', or 'table'
config Object optional

Configuration options
Source:
Context menu for editing tables.

Properties

getRelatedSources #

Get related item sources.

Result is cached, and cleared when the model or selection changes.

Overrides:
Source:
Get related item sources.

Methods

destroy() → {ve.ui.Context}chainable #

Destroy the context, removing all DOM elements.

Inherited from:
Source:

Returns:

Type
ve.ui.Context
Destroy the context, removing all DOM elements.

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

Get the surface the context is being used with.

Inherited from:
Source:

Returns:

Type
ve.ui.Surface
Get the surface the context is being used with.

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

Get an object describing the amount of padding the context adds to the surface.

For example the mobile context, which is fixed to the bottom of the viewport, will add bottom padding, whereas the floating desktop context will add none.

Inherited from:
Source:

Returns:

Padding object, or null

Type
ve.ui.Surface.Padding | null
Get an object describing the amount of padding the context adds to the surface.

hide() #

Hide the context while it has valid items in the menu

This could be triggered by clicking the close button on mobile or by pressing escape.

Inherited from:
Source:

Hide the context while it has valid items in the menu

This could be triggered by clicking the close button on mobile or by pressing escape.

isMobile() → {boolean} #

Check if context is for mobile devices

Inherited from:
Source:

Returns:

Context is for mobile devices

Type
boolean
Check if context is for mobile devices

isVisible() → {boolean} #

Check if context is visible.

Inherited from:
Source:

Returns:

Context is visible

Type
boolean
Check if context is visible.

onContextItemCommand() #

Handle command events from context items

Overrides:
Source:
Handle command events from context items

onDocumentMouseDown(e) #

Handle document mouse down events

Parameters:

Name Type Description
e jQuery.Event

Mouse down event
Source:
Handle document mouse down events

onIconMouseDown(e) #

Handle mouse down events on the icon

Parameters:

Name Type Description
e jQuery.Event

Mouse down event
Source:
Handle mouse down events on the icon

onModelSelect(selection) #

Handle model select events

Parameters:

Name Type Description
selection ve.dm.Selection
Source:
Handle model select events

setupMenuItems([previousItems]) → {ve.ui.Context}protectedchainable #

Setup menu items.

Parameters:

Name Type Attributes Description
previousItems Array.<ve.ui.ContextItem> optional

if a context is being refreshed, this will be the previously-open items for comparison
Inherited from:
Source:

Returns:

Type
ve.ui.Context
Setup menu items.

teardownMenuItems() → {ve.ui.Context}protectedchainable #

Teardown menu items.

Inherited from:
Source:

Returns:

Type
ve.ui.Context
Teardown menu items.

toggle([show]) → {jQuery.Promise} #

Toggle the visibility of the context.

Parameters:

Name Type Attributes Description
show boolean optional

Show the context, omit to toggle
Inherited from:
Source:

Returns:

Promise resolved when context is finished showing/hiding

Type
jQuery.Promise

Fires:

Toggle the visibility of the context.

toggleMenu([show]) → {ve.ui.Context}chainable #

Toggle the menu.

Parameters:

Name Type Attributes Description
show boolean optional

Show the menu, omit to toggle
Overrides:
Source:

Returns:

Type
ve.ui.Context
Toggle the menu.

updateDimensions() → {ve.ui.Context}chainable #

Update the size and position of the context.

Inherited from:
Source:

Returns:

Type
ve.ui.Context

Fires:

Update the size and position of the context.

Events

resize() #

Inherited from:
Source: