Extends
Constructor
new ve.ui.ToolContextItem(context, model, tool, [config])
#
Context item for a tool.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
context |
ve.ui.LinearContext | 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 |
Context item for a tool.
Methods
equals(other) → {boolean}
#
Check whether this context item represents the same content as another
Parameters:
| Name | Type | Description |
|---|---|---|
other |
ve.ui.ContextItem |
Returns:
- Type
- boolean
- Inherited from:
- Source:
Check whether this context item represents the same content as another
getCommand() → {ve.ui.Command}
#
Get the command for this item.
getDescription() → {string}
#
Get a description of the model.
Returns:
Description of model
- Type
- string
Get a description of the model.
getFragment() → {ve.dm.SurfaceFragment}
#
Get a surface fragment covering the related model node, or the current selection otherwise
Returns:
Surface fragment
- Inherited from:
- Source:
Get a surface fragment covering the related model node, or the current selection otherwise
isEditable() → {boolean}
#
Check if item is editable.
Returns:
Item is editable
- Type
- boolean
- Inherited from:
- Source:
Check if item is editable.
isNode() → {boolean}
#
Check if model is a node
Returns:
Model is a node
- Type
- boolean
- Inherited from:
- Source:
Check if model is a node
isReadOnly() → {boolean}
#
Check if the context's surface is readOnly
Returns:
Context's surface is readOnly
- Type
- boolean
- Inherited from:
- Source:
Check if the context's surface is readOnly
onEditButtonClick()protected
#
Handle edit button click events.
Fires:
- Inherited from:
- Source:
Handle edit button click events.
renderBody()
#
Render the body.
- Inherited from:
- Source:
Render the body.
setup(refreshing) → {ve.ui.ContextItem}chainable
#
Setup the item.
Parameters:
| Name | Type | Description |
|---|---|---|
refreshing |
boolean | If this is a reconstruction/refresh of a context |
Returns:
- Type
- ve.ui.ContextItem
- Inherited from:
- Source:
Setup the item.
teardown() → {ve.ui.ContextItem}chainable
#
Teardown the item.
Events
command()
#
The context executed a ve.ui.Command
- Inherited from:
- Source:
The context executed a ve.ui.Command