Extends
Constructor
new ve.ui.LinearContextItem(context, [model], [config])
#
Hierarchy
Children
Item in a context.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
context |
ve.ui.LinearContext | Context the item is in |
|
model |
ve.dm.Model |
optional |
Model the item is related to |
config |
Object |
optional |
Configuration options |
- Mixes in:
- Source:
Properties
embeddablestatic
#
Whether the context item should try (if space permits) to go inside the node, rather than below with an arrow
Properties:
| Type | Description |
|---|---|
| boolean |
Whether the context item should try (if space permits) to go inside the node, rather than below with an arrow
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
getCommand() → {ve.ui.Command}
#
getDescription() → {string}
#
Get the description.
Returns:
Item description
- Type
- string
getFragment() → {ve.dm.SurfaceFragment}
#
Get a surface fragment covering the related model node, or the current selection otherwise
- Inherited from:
- Source:
Returns:
Surface fragment
isEditable() → {boolean}
#
Check if item is editable.
Returns:
Item is editable
- Type
- boolean
isNode() → {boolean}
#
Check if model is a node
- Inherited from:
- Source:
Returns:
Model is a node
- Type
- boolean
isReadOnly() → {boolean}
#
Check if the context's surface is readOnly
- Inherited from:
- Source:
Returns:
Context's surface is readOnly
- Type
- boolean
onEditButtonClick()protected
#
Handle edit button click events.
Fires:
renderBody()
#
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 |
- Overrides:
- Source:
Returns:
- Type
- ve.ui.ContextItem
teardown() → {ve.ui.ContextItem}chainable
#
Events
command()
#
The context executed a ve.ui.Command
- Inherited from:
- Source: