Expand all

ve.ui.CommentAnnotationContextItem

Extends

Constructor

new ve.ui.CommentAnnotationContextItem(context, model, [config]) #

Context item for a comment.

Parameters:

Name Type Attributes Description
context ve.ui.LinearContext

Context the item is in
model ve.dm.Model

Model the item is related to
config Object optional

Configuration options
Source:
Context item for a comment.

Methods

applyToAnnotations(callback) #

Apply a callback to every modelClass annotation in the current fragment

Parameters:

Name Type Description
callback function

Callback, will be passed fragment and annotation
Inherited from:
Source:
Apply a callback to every modelClass annotation in the current fragment

getAnnotationView() → {ve.ce.Annotation|undefined} #

Find the CE view for the annotation related to this context item

Problem: Going from the model to the view is difficult, as there can be many views of any given model. Assumption: an active annotation context item must mean the focus is within the relevant annotation.

Inherited from:
Source:

Returns:

The annotation view, if it's found, or undefined if not

Type
ve.ce.Annotation | undefined

Find the CE view for the annotation related to this context item

Problem: Going from the model to the view is difficult, as there can be many views of any given model.

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

Get the command for this item.

Inherited from:
Source:

Returns:

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

getDescription() → {string} #

Get the description.

Inherited from:
Source:

Returns:

Item description

Type
string
Get the description.

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

isClearable() → {boolean} #

Check if item is clearable.

Inherited from:
Source:

Returns:

Item is clearable

Type
boolean
Check if item is clearable.

isEditable() → {boolean} #

Check if item is editable.

Inherited from:
Source:

Returns:

Item is editable

Type
boolean
Check if item is editable.

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

onClearButtonClick()protected #

Handle clear button click events.

Inherited from:
Source:
Handle clear button click events.

onEditButtonClick()protected #

Handle edit button click events.

Inherited from:
Source:

Fires:

Handle edit button click events.

renderBody() #

Render the body.

Overrides:
Source:
Render the body.

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

Setup the item.

Inherited from:
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.

renderThread(model) → {jQuery}static #

Parameters:

Name Type Description
model ve.dm.CommentAnnotation
Source:

Returns:

Type
jQuery

Events

command() #

The context executed a ve.ui.Command

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