ModelDocumentSelection

class

ModelDocumentSelection is a special selection which is used as the document's selection. There can be only one instance of ModelDocumentSelection per document.

Document selection can only be changed by using the ModelWriter instance inside the change() block, as it provides a secure way to modify model.

ModelDocumentSelection is automatically updated upon changes in the document to always contain valid ranges. Its attributes are inherited from the text unless set explicitly.

Differences between ModelSelection and ModelDocumentSelection are:

there is always a range in ModelDocumentSelection - even if no ranges were added there is a "default range" present in the selection,
ranges added to this selection updates automatically when the document changes,
attributes of ModelDocumentSelection are updated automatically according to selection ranges.

Since ModelDocumentSelection uses live ranges and is updated when document changes, it cannot be set on nodes that are inside document fragment. If you need to represent a selection in document fragment, use Selection class instead.

See source

Properties

anchor : null | ModelPosition
readonly

Selection anchor. Anchor may be described as a position where the most recent part of the selection starts. Together with focus they define the direction of selection, which is important when expanding/shrinking selection. Anchor is always start or end position of the most recently added range.

Is set to null if there are no ranges in selection.

See source (with github icon)
focus : null | ModelPosition
readonly

Selection focus. Focus is a position where the selection ends.

Is set to null if there are no ranges in selection.

See source (with github icon)
hasOwnRange : boolean
readonly

Describes whether Documentselection has own range(s) set, or if it is defaulted to document's default range.

See source (with github icon)
isBackward : boolean
readonly

Specifies whether the focus precedes anchor.

See source (with github icon)
isCollapsed : boolean
readonly

Describes whether the selection is collapsed. Selection is collapsed when there is exactly one range which is collapsed.

See source (with github icon)
isGravityOverridden : boolean
readonly

Describes whether the gravity is overridden (using overrideSelectionGravity) or not.

Note that the gravity remains overridden as long as will not be restored the same number of times as it was overridden.

See source (with github icon)
markers : Collection<Marker>
readonly

A collection of selection markers. Marker is a selection marker when selection range is inside the marker range.

Note: Only markers from observed markers groups are collected.

See source (with github icon)
rangeCount : number
readonly

Number of ranges in selection.

See source (with github icon)
_ranges : Array<ModelRange>
internalreadonly

Used for the compatibility with the isEqual method.

See source (with github icon)
_selection : LiveSelection
private

Selection used internally by that class (ModelDocumentSelection is a proxy to that selection).

See source (with github icon)

Methods

constructor( doc )

Creates an empty live selection for given ModelDocument.

See source (with github icon)

Parameters

doc : ModelDocument

Document which owns this selection.
containsEntireContent( element ) → boolean

Checks whether the selection contains the entire content of the given element. This means that selection must start at a position touching the element's start and ends at position touching the element's end.

By default, this method will check whether the entire content of the selection's current root is selected. Useful to check if e.g. the user has just pressed Ctrl + A.

See source (with github icon)

Parameters

element : ModelElement

Returns

boolean
delegate( events ) → EmitterMixinDelegateChain
inherited

module:engine/model/documentselection~ModelDocumentSelection#delegate
Delegates selected events to another Emitter. For instance:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
Copy code
then eventX is delegated (fired by) emitterB and emitterC along with data:
```
emitterA.fire( 'eventX', data );
```
Copy code
and eventY is delegated (fired by) emitterC along with data:
```
emitterA.fire( 'eventY', data );
```
Copy code
See source (with github icon)

Parameters

events : Array<string>

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain
destroy() → void

Unbinds all events previously bound by document selection.

See source (with github icon)

Returns

void
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]
inherited

Fires an event, executing all callbacks registered for it.

The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

See source (with github icon)

Type parameters

TEvent : extends BaseEvent

The type describing the event. See BaseEvent.

Parameters

eventOrInfo : GetNameOrEventInfo<TEvent>

The name of the event or EventInfo object if event is delegated.

args : TEvent[ 'args' ]

Additional arguments to be passed to the callbacks.

Returns

GetEventInfo<TEvent>[ 'return' ]

By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).
getAttribute( key ) → unknown

Gets an attribute value for given key or undefined if that attribute is not set on the selection.

See source (with github icon)

Parameters

key : string

Key of attribute to look for.

Returns

unknown

Attribute value or undefined.
getAttributeKeys() → IterableIterator<string>

Returns iterable that iterates over this selection's attribute keys.

See source (with github icon)

Returns

IterableIterator<string>
getAttributes() → IterableIterator<tuple>

Returns iterable that iterates over this selection's attributes.

Attributes are returned as arrays containing two items. First one is attribute key and second is attribute value. This format is accepted by native Map object and also can be passed in Node constructor.

See source (with github icon)

Returns

IterableIterator<tuple>
getFirstPosition() → null | ModelPosition

Returns the first position in the selection. First position is the position that is before any other position in the selection.

Returns null if there are no ranges in selection.

See source (with github icon)

Returns

null | ModelPosition
getFirstRange() → null | ModelRange

Returns a copy of the first range in the selection. First range is the one which start position is before start position of all other ranges (not to confuse with the first range added to the selection).

Returns null if there are no ranges in selection.

See source (with github icon)

Returns

null | ModelRange
getLastPosition() → null | ModelPosition

Returns the last position in the selection. Last position is the position that is after any other position in the selection.

Returns null if there are no ranges in selection.

See source (with github icon)

Returns

null | ModelPosition
getLastRange() → null | ModelRange

Returns a copy of the last range in the selection. Last range is the one which end position is after end position of all other ranges (not to confuse with the range most recently added to the selection).

Returns null if there are no ranges in selection.

See source (with github icon)

Returns

null | ModelRange
getRanges() → IterableIterator<ModelRange>

Returns an iterable that iterates over copies of selection ranges.

See source (with github icon)

Returns

IterableIterator<ModelRange>
getSelectedBlocks() → IterableIterator<ModelElement>

module:engine/model/documentselection~ModelDocumentSelection#getSelectedBlocks
Gets elements of type "block" touched by the selection.

This method's result can be used for example to apply block styling to all blocks covered by this selection.

Note: getSelectedBlocks() returns blocks that are nested in other non-block elements but will not return blocks nested in other blocks.

In this case the function will return exactly all 3 paragraphs (note: <blockQuote> is not a block itself):
```
<paragraph>[a</paragraph>
<blockQuote>
	<paragraph>b</paragraph>
</blockQuote>
<paragraph>c]d</paragraph>
```
Copy code
In this case the paragraph will also be returned, despite the collapsed selection:
```
<paragraph>[]a</paragraph>
```
Copy code
In such a scenario, however, only blocks A, B & E will be returned as blocks C & D are nested in block B:
```
[<blockA></blockA>
<blockB>
	<blockC></blockC>
	<blockD></blockD>
</blockB>
<blockE></blockE>]
```
Copy code
If the selection is inside a block all the inner blocks (A & B) are returned:
```
<block>
	<blockA>[a</blockA>
	<blockB>b]</blockB>
</block>
```
Copy code
Special case: If a selection ends at the beginning of a block, that block is not returned as from user perspective this block wasn't selected. See #984 for more details.
```
<paragraph>[a</paragraph>
<paragraph>b</paragraph>
<paragraph>]c</paragraph> // this block will not be returned
```
Copy code
See source (with github icon)

Returns

IterableIterator<ModelElement>
getSelectedElement() → null | ModelElement

Returns the selected element. Element is considered as selected if there is only one range in the selection, and that range contains exactly one element. Returns null if there is no selected element.

See source (with github icon)

Returns

null | ModelElement
hasAttribute( key ) → boolean

Checks if the selection has an attribute for given key.

See source (with github icon)

Parameters

key : string

Key of attribute to check.

Returns

boolean

true if attribute with given key is set on selection, false otherwise.
is( type ) → this is ModelElement | ModelRootElement
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:ELEMENT
Checks whether the object is of type ModelElement or its subclass.
```
element.is( 'element' ); // -> true
element.is( 'node' ); // -> true
element.is( 'model:element' ); // -> true
element.is( 'model:node' ); // -> true

element.is( 'view:element' ); // -> false
element.is( 'documentSelection' ); // -> false
```
Copy code
Assuming that the object being checked is an element, you can also check its name:
```
element.is( 'element', 'imageBlock' ); // -> true if this is an <imageBlock> element
text.is( 'element', 'imageBlock' ); -> false
```
Copy code
See source (with github icon)

Parameters

type : 'element' | 'model:element'

Returns

this is ModelElement | ModelRootElement
is( type ) → this is ModelText
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:TEXT
Checks whether the object is of type ModelText.
```
text.is( '$text' ); // -> true
text.is( 'node' ); // -> true
text.is( 'model:$text' ); // -> true
text.is( 'model:node' ); // -> true

text.is( 'view:$text' ); // -> false
text.is( 'documentSelection' ); // -> false
```
Copy code
Note: Until version 20.0.0 this method wasn't accepting '$text' type. The legacy 'text' type is still accepted for backward compatibility.

See source (with github icon)

Parameters

type : '$text' | 'model:$text'

Returns

this is ModelText
is( type ) → this is ModelRootElement
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:ROOT_ELEMENT
Checks whether the object is of type ModelRootElement.
```
rootElement.is( 'rootElement' ); // -> true
rootElement.is( 'element' ); // -> true
rootElement.is( 'node' ); // -> true
rootElement.is( 'model:rootElement' ); // -> true
rootElement.is( 'model:element' ); // -> true
rootElement.is( 'model:node' ); // -> true

rootElement.is( 'view:element' ); // -> false
rootElement.is( 'documentFragment' ); // -> false
```
Copy code
Assuming that the object being checked is an element, you can also check its name:
```
rootElement.is( 'rootElement', '$root' ); // -> same as above
```
Copy code
See source (with github icon)

Parameters

type : 'rootElement' | 'model:rootElement'

Returns

this is ModelRootElement
is( type ) → this is ModelLiveRange
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:LIVE_RANGE
Checks whether the object is of type ModelLiveRange.
```
liveRange.is( 'range' ); // -> true
liveRange.is( 'model:range' ); // -> true
liveRange.is( 'liveRange' ); // -> true
liveRange.is( 'model:liveRange' ); // -> true

liveRange.is( 'view:range' ); // -> false
liveRange.is( 'documentSelection' ); // -> false
```
Copy code
See source (with github icon)

Parameters

type : 'liveRange' | 'model:liveRange'

Returns

this is ModelLiveRange
is( type ) → this is ModelRange | ModelLiveRange
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:RANGE
Checks whether the object is of type ModelRange or its subclass.
```
range.is( 'range' ); // -> true
range.is( 'model:range' ); // -> true

range.is( 'view:range' ); // -> false
range.is( 'documentSelection' ); // -> false
```
Copy code
See source (with github icon)

Parameters

type : 'range' | 'model:range'

Returns

this is ModelRange | ModelLiveRange
is( type ) → this is ModelLivePosition
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:LIVE_POSITION
Checks whether the object is of type ModelLivePosition.
```
livePosition.is( 'position' ); // -> true
livePosition.is( 'model:position' ); // -> true
livePosition.is( 'liveposition' ); // -> true
livePosition.is( 'model:livePosition' ); // -> true

livePosition.is( 'view:position' ); // -> false
livePosition.is( 'documentSelection' ); // -> false
```
Copy code
See source (with github icon)

Parameters

type : 'livePosition' | 'model:livePosition'

Returns

this is ModelLivePosition
is( type ) → this is ModelPosition | ModelLivePosition
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:POSITION
Checks whether the object is of type ModelPosition or its subclass.
```
position.is( 'position' ); // -> true
position.is( 'model:position' ); // -> true

position.is( 'view:position' ); // -> false
position.is( 'documentSelection' ); // -> false
```
Copy code
See source (with github icon)

Parameters

type : 'position' | 'model:position'

Returns

this is ModelPosition | ModelLivePosition
is( type ) → this is ModelSelection | ModelDocumentSelection
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:SELECTION
Checks whether the object is of type ModelSelection or ModelDocumentSelection.
```
selection.is( 'selection' ); // -> true
selection.is( 'model:selection' ); // -> true

selection.is( 'view:selection' ); // -> false
selection.is( 'range' ); // -> false
```
Copy code
See source (with github icon)

Parameters

type : 'selection' | 'model:selection'

Returns

this is ModelSelection | ModelDocumentSelection
is( type, name ) → boolean
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:ELEMENT_NAME
Checks whether the object is of type ModelElement or its subclass and has the specified name.
```
element.is( 'element', 'imageBlock' ); // -> true if this is an <imageBlock> element
text.is( 'element', 'imageBlock' ); -> false
```
Copy code
See source (with github icon)

Type parameters

N : extends string

Parameters

type : 'element' | 'model:element'

name : N

Returns

boolean
is( type, name ) → boolean
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:ROOT_ELEMENT_NAME
Checks whether the object is of type ModelRootElement and has the specified name.
```
rootElement.is( 'rootElement', '$root' );
```
Copy code
See source (with github icon)

Type parameters

N : extends string

Parameters

type : 'rootElement' | 'model:rootElement'

name : N

Returns

boolean
is( type ) → this is ModelTextProxy
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:TEXT_PROXY
Checks whether the object is of type ModelTextProxy.
```
textProxy.is( '$textProxy' ); // -> true
textProxy.is( 'model:$textProxy' ); // -> true

textProxy.is( 'view:$textProxy' ); // -> false
textProxy.is( 'range' ); // -> false
```
Copy code
Note: Until version 20.0.0 this method wasn't accepting '$textProxy' type. The legacy 'textProxt' type is still accepted for backward compatibility.

See source (with github icon)

Parameters

type : '$textProxy' | 'model:$textProxy'

Returns

this is ModelTextProxy
is( type ) → this is Marker
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:MARKER
Checks whether the object is of type Marker.
```
marker.is( 'marker' ); // -> true
marker.is( 'model:marker' ); // -> true

marker.is( 'view:element' ); // -> false
marker.is( 'documentSelection' ); // -> false
```
Copy code
See source (with github icon)

Parameters

type : 'marker' | 'model:marker'

Returns

this is Marker
is( type ) → this is ModelDocumentSelection
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:DOCUMENT_SELECTION
Checks whether the object is of type ModelDocumentSelection.
```
selection.is( 'selection' ); // -> true
selection.is( 'documentSelection' ); // -> true
selection.is( 'model:selection' ); // -> true
selection.is( 'model:documentSelection' ); // -> true

selection.is( 'view:selection' ); // -> false
selection.is( 'element' ); // -> false
selection.is( 'node' ); // -> false
```
Copy code
See source (with github icon)

Parameters

type : 'documentSelection' | 'model:documentSelection'

Returns

this is ModelDocumentSelection
is( type ) → this is ModelDocumentFragment
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:DOCUMENT_FRAGMENT
Checks whether the object is of type ModelDocumentFragment.
```
docFrag.is( 'documentFragment' ); // -> true
docFrag.is( 'model:documentFragment' ); // -> true

docFrag.is( 'view:documentFragment' ); // -> false
docFrag.is( 'element' ); // -> false
docFrag.is( 'node' ); // -> false
```
Copy code
See source (with github icon)

Parameters

type : 'documentFragment' | 'model:documentFragment'

Returns

this is ModelDocumentFragment
is( type ) → this is ModelNode | ModelText | ModelElement | ModelRootElement
inherited

module:engine/model/documentselection~ModelDocumentSelection#is:NODE
Checks whether the object is of type ModelNode or its subclass.

This method is useful when processing model objects that are of unknown type. For example, a function may return a ModelDocumentFragment or a ModelNode that can be either a text node or an element. This method can be used to check what kind of object is returned.
```
someObject.is( 'element' ); // -> true if this is an element
someObject.is( 'node' ); // -> true if this is a node (a text node or an element)
someObject.is( 'documentFragment' ); // -> true if this is a document fragment
```
Copy code
Since this method is also available on a range of view objects, you can prefix the type of the object with model: or view: to check, for example, if this is the model's or view's element:
```
modelElement.is( 'model:element' ); // -> true
modelElement.is( 'view:element' ); // -> false
```
Copy code
By using this method it is also possible to check a name of an element:
```
imageElement.is( 'element', 'imageBlock' ); // -> true
imageElement.is( 'element', 'imageBlock' ); // -> same as above
imageElement.is( 'model:element', 'imageBlock' ); // -> same as above, but more precise
```
Copy code
See source (with github icon)

Parameters

type : 'node' | 'model:node'

Returns

this is ModelNode | ModelText | ModelElement | ModelRootElement
listenTo( emitter, event, callback, [ options ] ) → void
inherited

module:engine/model/documentselection~ModelDocumentSelection#listenTo:BASE_EMITTER
Registers a callback function to be executed when an event is fired in a specific (emitter) object.

Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.
```
// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
```
Copy code
An event callback can stop the event and set the return value of the fire method.

See source (with github icon)

Type parameters

TEvent : extends BaseEvent

The type describing the event. See BaseEvent.

Parameters

emitter : Emitter

The object that fires the event.

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void
observeMarkers( prefixOrName ) → void

Registers a marker group prefix or a marker name to be collected in the selection markers collection.

See also MarkerCollection#getMarkersGroup().

See source (with github icon)

Parameters

prefixOrName : string

The marker group prefix or marker name.

Returns

void
off( event, callback ) → void
inherited

Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

See source (with github icon)

Parameters

event : string

The name of the event.

callback : Function

The function to stop being called.

Returns

void
on( event, callback, [ options ] ) → void
inherited

Registers a callback function to be executed when an event is fired.

Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).

See source (with github icon)

Type parameters

TEvent : extends BaseEvent

The type descibing the event. See BaseEvent.

Parameters

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void
once( event, callback, [ options ] ) → void
inherited

Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

See source (with github icon)

Type parameters

TEvent : extends BaseEvent

The type descibing the event. See BaseEvent.

Parameters

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void
refresh() → void

Refreshes selection attributes and markers according to the current position in the model.

See source (with github icon)

Returns

void
stopDelegating( [ event ], [ emitter ] ) → void
inherited

module:engine/model/documentselection~ModelDocumentSelection#stopDelegating
Stops delegating events. It can be used at different levels:
- To stop delegating all events.
- To stop delegating a specific event to all emitters.
- To stop delegating a specific event to a specific emitter.
See source (with github icon)

Parameters

[ event ] : string

The name of the event to stop delegating. If omitted, stops it all delegations.

[ emitter ] : Emitter

(requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.

Returns

void
stopListening( [ emitter ], [ event ], [ callback ] ) → void
inherited

module:engine/model/documentselection~ModelDocumentSelection#stopListening:BASE_STOP
Stops listening for events. It can be used at different levels:
- To stop listening to a specific callback.
- To stop listening to a specific event.
- To stop listening to all events fired by a specific object.
- To stop listening to all events fired by all objects.
See source (with github icon)

Parameters

[ emitter ] : Emitter

The object to stop listening to. If omitted, stops it for all objects.

[ event ] : string

(Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

[ callback ] : Function

(Requires the event) The function to be removed from the call list for the given event.

Returns

void
toJSON() → unknown

Converts DocumentSelection to plain object and returns it.

See source (with github icon)

Returns

unknown

DocumentSelection converted to plain object.
_getStoredAttributes() → Iterable<tuple>
internal

Returns an iterable that iterates through all selection attributes stored in current selection's parent.

See source (with github icon)

Returns

Iterable<tuple>
_overrideGravity() → string
internal

module:engine/model/documentselection~ModelDocumentSelection#_overrideGravity
Temporarily changes the gravity of the selection from the left to the right.

The gravity defines from which direction the selection inherits its attributes. If it's the default left gravity, the selection (after being moved by the the user) inherits attributes from its left hand side. This method allows to temporarily override this behavior by forcing the gravity to the right.

It returns an unique identifier which is required to restore the gravity. It guarantees the symmetry of the process.

See source (with github icon)

Returns

string

The unique id which allows restoring the gravity.

Related:
- ModelWriter#overrideSelectionGravity
_removeAttribute( key ) → void
internal

module:engine/model/documentselection~ModelDocumentSelection#_removeAttribute
Removes an attribute with given key from the selection. If the given attribute was set on the selection, fires the event-change:range event with removed attribute key. Should be used only within the removeSelectionAttribute method.

See source (with github icon)

Parameters

key : string

Key of the attribute to remove.

Returns

void

Related:
- ModelWriter#removeSelectionAttribute
_restoreGravity( uid ) → void
internal

module:engine/model/documentselection~ModelDocumentSelection#_restoreGravity
Restores the overridden gravity.

Restoring the gravity is only possible using the unique identifier returned by _overrideGravity. Note that the gravity remains overridden as long as won't be restored the same number of times it was overridden.

See source (with github icon)

Parameters

uid : string

The unique id returned by _overrideGravity.

Returns

void

Related:
- ModelWriter#restoreSelectionGravity
_setAttribute( key, value ) → void
internal

module:engine/model/documentselection~ModelDocumentSelection#_setAttribute
Sets attribute on the selection. If attribute with the same key already is set, it's value is overwritten. Should be used only within the setSelectionAttribute method.

See source (with github icon)

Parameters

key : string

Key of the attribute to set.

value : unknown

Attribute value.

Returns

void

Related:
- ModelWriter#setSelectionAttribute
_setFocus( itemOrPosition, [ offset ] ) → void
internal

module:engine/model/documentselection~ModelDocumentSelection#_setFocus
Moves focus to the specified location. Should be used only within the setSelectionFocus method.

The location can be specified in the same form as writer.createPositionAt() parameters.

See source (with github icon)

Parameters

itemOrPosition : ModelPosition | ModelItem

[ offset ] : ModelPositionOffset

Offset or one of the flags. Used only when first parameter is a model item.

Returns

void

Related:
- ModelWriter#setSelectionFocus
_setTo( args ) → void
internal

module:engine/model/documentselection~ModelDocumentSelection#_setTo
Sets this selection's ranges and direction to the specified location based on the given selectable. Should be used only within the setSelection method.

See source (with github icon)

Parameters

args : tuple

Returns

void

Related:
- ModelWriter#setSelection

Static methods

_getStoreAttributeKey( key ) → string
internalstatic

Generates and returns an attribute key for selection attributes store, basing on original attribute key.

See source (with github icon)

Parameters

key : string

Attribute key to convert.

Returns

string

Converted attribute key, applicable for selection store.
_isStoreAttributeKey( key ) → boolean
internalstatic

Checks whether the given attribute key is an attribute stored on an element.

See source (with github icon)

Parameters

key : string

Returns

boolean

Events

change( eventInfo, directChange = { [directChange.attributeKeys], directChange.directChange, [directChange.oldMarkers] } )

Fired when selection range(s), attribute(s) or marker(s) changed.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

directChange : object

This is always set to false in case of change:marker event as there is no possibility to change markers directly through ModelDocumentSelection API. See also event-change:range and event-change:attribute.

Properties

[ directChange.attributeKeys ] : Array<string>

directChange.directChange : boolean

[ directChange.oldMarkers ] : Array<Marker>
change:attribute( eventInfo, directChange = { directChange.attributeKeys, directChange.directChange } )

Fired when selection attribute changed.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

directChange : object

In case of ModelSelection class it is always set to true which indicates that the selection change was caused by a direct use of selection's API. The ModelDocumentSelection, however, may change because its attributes were directly changed through the writer or because its position was changed in the model and its attributes were refreshed (which means an indirect change). The indirect change does not occur in case of normal (detached) selections because they are "static" (as "not live") which mean that they are not updated once the document changes.

Properties

directChange.attributeKeys : Array<string>

directChange.directChange : boolean
change:marker( eventInfo, directChange = { directChange.directChange, directChange.oldMarkers } )

Fired when selection marker(s) changed.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

directChange : object

This is always set to false in case of change:marker event as there is no possibility to change markers directly through ModelDocumentSelection API. See also event-change:range and event-change:attribute.

Properties

directChange.directChange : boolean

directChange.oldMarkers : Array<Marker>
change:range( eventInfo, directChange = { directChange.directChange } )

Fired when selection range(s) changed.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

directChange : object

In case of ModelSelection class it is always set to true which indicates that the selection change was caused by a direct use of selection's API. The ModelDocumentSelection, however, may change because its position was directly changed through the writer or because its position was changed because the structure of the model has been changed (which means an indirect change). The indirect change does not occur in case of normal (detached) selections because they are "static" (as "not live") which mean that they are not updated once the document changes.

Properties

directChange.directChange : boolean

ModelDocumentSelection

Properties

anchor : null | ModelPosition readonly

focus : null | ModelPosition readonly

hasOwnRange : boolean readonly

isBackward : boolean readonly

isCollapsed : boolean readonly

isGravityOverridden : boolean readonly

markers : Collection<Marker> readonly

rangeCount : number readonly

_ranges : Array<ModelRange> internalreadonly

_selection : LiveSelection Lock icon private

Methods

constructor( doc )

Parameters

containsEntireContent( element ) → boolean

Parameters

Returns

delegate( events ) → EmitterMixinDelegateChain inherited

Parameters

Returns

destroy() → void

Returns

fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ] inherited

Type parameters

Parameters

Returns

getAttribute( key ) → unknown

Parameters

Returns

getAttributeKeys() → IterableIterator<string>

Returns

getAttributes() → IterableIterator<tuple>

Returns

getFirstPosition() → null | ModelPosition

Returns

getFirstRange() → null | ModelRange

Returns

getLastPosition() → null | ModelPosition

Returns

getLastRange() → null | ModelRange

Returns

getRanges() → IterableIterator<ModelRange>

Returns

getSelectedBlocks() → IterableIterator<ModelElement>

Returns

getSelectedElement() → null | ModelElement

Returns

hasAttribute( key ) → boolean

Parameters

Returns

is( type ) → this is ModelElement | ModelRootElement inherited

Parameters

Returns

is( type ) → this is ModelText inherited

Parameters

Returns

is( type ) → this is ModelRootElement inherited

Parameters

Returns

is( type ) → this is ModelLiveRange inherited

Parameters

Returns

is( type ) → this is ModelRange | ModelLiveRange inherited

Parameters

Returns

is( type ) → this is ModelLivePosition inherited

Parameters

Returns

is( type ) → this is ModelPosition | ModelLivePosition inherited

Parameters

Returns

is( type ) → this is ModelSelection | ModelDocumentSelection inherited

Parameters

Returns

is( type, name ) → boolean inherited

Type parameters

Parameters

Returns

is( type, name ) → boolean inherited

`anchor : null | ModelPosition`
readonly

`focus : null | ModelPosition`
readonly

`hasOwnRange : boolean`
readonly

`isBackward : boolean`
readonly

`isCollapsed : boolean`
readonly

`isGravityOverridden : boolean`
readonly

`markers : Collection<Marker>`
readonly

`rangeCount : number`
readonly

`_ranges : Array<ModelRange>`
internalreadonly

`_selection : LiveSelection`
private

`constructor( doc )`

`containsEntireContent( element ) → boolean`

`delegate( events ) → EmitterMixinDelegateChain`
inherited

`destroy() → void`

`fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]`
inherited

`getAttribute( key ) → unknown`

`getAttributeKeys() → IterableIterator<string>`

`getAttributes() → IterableIterator<tuple>`

`getFirstPosition() → null | ModelPosition`

`getFirstRange() → null | ModelRange`

`getLastPosition() → null | ModelPosition`

`getLastRange() → null | ModelRange`

`getRanges() → IterableIterator<ModelRange>`

`getSelectedBlocks() → IterableIterator<ModelElement>`

`getSelectedElement() → null | ModelElement`

`hasAttribute( key ) → boolean`

`is( type ) → this is ModelElement | ModelRootElement`
inherited

`is( type ) → this is ModelText`
inherited

`is( type ) → this is ModelRootElement`
inherited

`is( type ) → this is ModelLiveRange`
inherited

`is( type ) → this is ModelRange | ModelLiveRange`
inherited

`is( type ) → this is ModelLivePosition`
inherited

`is( type ) → this is ModelPosition | ModelLivePosition`
inherited

`is( type ) → this is ModelSelection | ModelDocumentSelection`
inherited

`is( type, name ) → boolean`
inherited

`is( type, name ) → boolean`
inherited

`is( type ) → this is ModelTextProxy`
inherited

`is( type ) → this is Marker`
inherited

`is( type ) → this is ModelDocumentSelection`
inherited

`is( type ) → this is ModelDocumentFragment`
inherited

`is( type ) → this is ModelNode | ModelText | ModelElement | ModelRootElement`
inherited

`listenTo( emitter, event, callback, [ options ] ) → void`
inherited

`observeMarkers( prefixOrName ) → void`

`off( event, callback ) → void`
inherited

`on( event, callback, [ options ] ) → void`
inherited

`once( event, callback, [ options ] ) → void`
inherited

`refresh() → void`

`stopDelegating( [ event ], [ emitter ] ) → void`
inherited

`stopListening( [ emitter ], [ event ], [ callback ] ) → void`
inherited

`toJSON() → unknown`

`_getStoredAttributes() → Iterable<tuple>`
internal

`_overrideGravity() → string`
internal

`_removeAttribute( key ) → void`
internal

`_restoreGravity( uid ) → void`
internal

`_setAttribute( key, value ) → void`
internal

`_setFocus( itemOrPosition, [ offset ] ) → void`
internal

`_setTo( args ) → void`
internal