ViewDowncastWriter

The view document instance in which this writer operates.

Holds references to the attribute groups that share the same id. The keys are ids, the values are Sets holding ViewAttributeElements.

The slot factory used by the elementToStructure downcast helper.

Parameters

document : ViewDocument

The view document instance.

Adds specified class to the element.

writer.addClass( 'foo', linkElement );
writer.addClass( [ 'foo', 'bar' ], linkElement );

Parameters

className : string | Array<string>

element : ViewElement

Returns

void

Breaks attribute elements at the provided position or at the boundaries of a provided range. It breaks attribute elements up to their first ancestor that is a container element.

In following examples <p> is a container, <b> and <u> are attribute elements:

<p>foo<b><u>bar{}</u></b></p> -> <p>foo<b><u>bar</u></b>[]</p>
<p>foo<b><u>{}bar</u></b></p> -> <p>foo{}<b><u>bar</u></b></p>
<p>foo<b><u>b{}ar</u></b></p> -> <p>foo<b><u>b</u></b>[]<b><u>ar</u></b></p>
<p><b>fo{o</b><u>ba}r</u></p> -> <p><b>fo</b><b>o</b><u>ba</u><u>r</u></b></p>

Note: DocumentFragment is treated like a container.

Note: The difference between breakAttributes() and breakContainer() is that breakAttributes() breaks all attribute elements that are ancestors of a given position, up to the first encountered container element. breakContainer() assumes that a given position is directly in the container element and breaks that container element.

Throws the view-writer-invalid-range-container CKEditorError when the start and end positions of a passed range are not placed inside same parent container.

Throws the view-writer-cannot-break-empty-element CKEditorError when trying to break attributes inside an ViewEmptyElement.

Throws the view-writer-cannot-break-ui-element CKEditorError when trying to break attributes inside a UIElement.

Parameters

positionOrRange : ViewPosition | ViewRange

The position where to break attribute elements.

Returns

ViewPosition | ViewRange

The new position or range, after breaking the attribute elements.

Related:

• ViewAttributeElement
• ViewContainerElement
• ViewDowncastWriter#breakContainer

Breaks a container view element into two, at the given position. The position has to be directly inside the container element and cannot be in the root. It does not break the conrainer view element if the position is at the beginning or at the end of its parent element.

<p>foo^bar</p> -> <p>foo</p><p>bar</p>
<div><p>foo</p>^<p>bar</p></div> -> <div><p>foo</p></div><div><p>bar</p></div>
<p>^foobar</p> -> ^<p>foobar</p>
<p>foobar^</p> -> <p>foobar</p>^

Note: The difference between breakAttributes() and breakContainer() is that breakAttributes() breaks all attribute elements that are ancestors of a given position, up to the first encountered container element. breakContainer() assumes that the given position is directly in the container element and breaks that container element.

Parameters

position : ViewPosition

The position where to break the element.

Returns

ViewPosition

The position between broken elements. If an element has not been broken, the returned position is placed either before or after it.

Related:

• ViewAttributeElement
• ViewContainerElement
• ViewDowncastWriter#breakAttributes

Removes matching elements from given range.

Throws CKEditorError view-writer-invalid-range-container when start and end positions are not placed inside same parent container.

Parameters

range : ViewRange

Range to clear.

element : ViewElement

Element to remove.

Returns

void

Cleans up memory by removing obsolete cloned elements group from the writer.

Should be used whenever all attribute elements with the same id are going to be removed from the view and the group will no longer be needed.

Cloned elements group are not removed automatically in case if the group is still needed after all its elements were removed from the view.

Keep in mind that group names are equal to the id property of the attribute element.

Parameters

groupName : string

Name of the group to clear.

Returns

void

Creates a new ViewAttributeElement.

writer.createAttributeElement( 'strong' );
writer.createAttributeElement( 'a', { href: 'foo.bar' } );

// Make `<a>` element contain other attributes element so the `<a>` element is not broken.
writer.createAttributeElement( 'a', { href: 'foo.bar' }, { priority: 5 } );

// Set `id` of a marker element so it is not joined or merged with "normal" elements.
writer.createAttributeElement( 'span', { class: 'my-marker' }, { id: 'marker:my' } );

Parameters

name : string

Name of the element.

[ attributes ] : ViewElementAttributes

Element's attributes.

options : object

Element's options.

Properties

[ options.id ] : string | number

Element's id.

[ options.priority ] : number

Element's priority.

[ options.renderUnsafeAttributes ] : Array<string>

A list of attribute names that should be rendered in the editing pipeline even though they would normally be filtered out by unsafe attribute detection mechanisms.

Defaults to {}

Returns

ViewAttributeElement

Created element.

Creates a new ViewContainerElement with children.

// Create element with children.
writer.createContainerElement( 'figure', { class: 'image' }, [
	writer.createEmptyElement( 'img' ),
	writer.createContainerElement( 'figcaption' )
] );

// Create element with specific options.
writer.createContainerElement( 'figure', { class: 'image' }, [
	writer.createEmptyElement( 'img' ),
	writer.createContainerElement( 'figcaption' )
], { renderUnsafeAttributes: [ 'foo' ] } );

Parameters

name : string

Name of the element.

attributes : ViewElementAttributes

Elements attributes.

children : ViewNode | Iterable<ViewNode>

A node or a list of nodes to be inserted into the created element. If no children were specified, element's options can be passed in this argument.

[ options ] : object

Element's options.

Properties

[ options.renderUnsafeAttributes ] : Array<string>

A list of attribute names that should be rendered in the editing pipeline even though they would normally be filtered out by unsafe attribute detection mechanisms.

Returns

ViewContainerElement

Created element.

Creates a new ViewContainerElement.

writer.createContainerElement( 'p' );

// Create element with custom attributes.
writer.createContainerElement( 'div', { id: 'foo-bar', 'data-baz': '123' } );

// Create element with custom styles.
writer.createContainerElement( 'p', { style: 'font-weight: bold; padding-bottom: 10px' } );

// Create element with custom classes.
writer.createContainerElement( 'p', { class: 'foo bar baz' } );

// Create element with specific options.
writer.createContainerElement( 'span', { class: 'placeholder' }, { renderUnsafeAttributes: [ 'foo' ] } );

Parameters

name : string

Name of the element.

[ attributes ] : ViewElementAttributes

Elements attributes.

[ options ] : object

Element's options.

Properties

[ options.renderUnsafeAttributes ] : Array<string>

A list of attribute names that should be rendered in the editing pipeline even though they would normally be filtered out by unsafe attribute detection mechanisms.

Returns

ViewContainerElement

Created element.

Creates a new ViewDocumentFragment instance.

Parameters

[ children ] : ViewNode | Iterable<ViewNode>

A list of nodes to be inserted into the created document fragment.

Returns

ViewDocumentFragment

The created document fragment.

Creates a new ViewEditableElement.

writer.createEditableElement( 'div' );
writer.createEditableElement( 'div', { id: 'foo-1234' } );

Note: The editable element is to be used in the editing pipeline. Usually, together with toWidgetEditable().

Parameters

name : string

Name of the element.

[ attributes ] : ViewElementAttributes

Elements attributes.

options : object

Element's options.

Properties

[ options.renderUnsafeAttributes ] : Array<string>

A list of attribute names that should be rendered in the editing pipeline even though they would normally be filtered out by unsafe attribute detection mechanisms.

Defaults to {}

Returns

ViewEditableElement

Created element.

Creates a new ViewEmptyElement.

writer.createEmptyElement( 'img' );
writer.createEmptyElement( 'img', { id: 'foo-1234' } );

Parameters

name : string

Name of the element.

[ attributes ] : ViewElementAttributes

Elements attributes.

options : object

Element's options.

Properties

[ options.renderUnsafeAttributes ] : Array<string>

A list of attribute names that should be rendered in the editing pipeline even though they would normally be filtered out by unsafe attribute detection mechanisms.

Defaults to {}

Returns

ViewEmptyElement

Created element.

Creates a new position after given view item.

Parameters

item : ViewItem

View item after which the position should be located.

Returns

ViewPosition

Creates position at the given location. The location can be specified as:

• a position,
• parent element and offset (offset defaults to 0),
• parent element and 'end' (sets position at the end of that element),
• view item and 'before' or 'after' (sets position before or after given view item).

This method is a shortcut to other constructors such as:

• createPositionBefore,
• createPositionAfter,

Parameters

itemOrPosition : ViewPosition | ViewItem

[ offset ] : ViewPositionOffset

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

Returns

ViewPosition

Creates a new position before given view item.

Parameters

item : ViewItem

View item before which the position should be located.

Returns

ViewPosition

Creates a range spanning from start position to end position.

Note: This factory method creates its own ViewPosition instances basing on passed values.

Parameters

start : ViewPosition

Start position.

[ end ] : null | ViewPosition

End position. If not set, range will be collapsed at start position.

Returns

ViewRange

Creates a range inside an element which starts before the first child of that element and ends after the last child of that element.

Parameters

element : ViewElement | ViewDocumentFragment

Element which is a parent for the range.

Returns

ViewRange

Creates a range that starts before given view item and ends after it.

Parameters

item : ViewItem

Returns

ViewRange

Creates a new ViewRawElement.

writer.createRawElement( 'span', { id: 'foo-1234' }, function( domElement ) {
	domElement.innerHTML = '<b>This is the raw content of the raw element.</b>';
} );

Raw elements work as data containers ("wrappers", "sandboxes") but their children are not managed or even recognized by the editor. This encapsulation allows integrations to maintain custom DOM structures in the editor content without, for instance, worrying about compatibility with other editor features. Raw elements are a perfect tool for integration with external frameworks and data sources.

Unlike UI elements, raw elements act like "real" editor content (similar to ViewContainerElement or ViewEmptyElement), and they are considered by the editor selection.

You should not use raw elements to render the UI in the editor content. Check out #createUIElement() instead.

Parameters

name : string

The name of the element.

[ attributes ] : ViewElementAttributes

Element attributes.

[ renderFunction ] : ( domElement: HTMLElement, domConverter: ViewDomConverter ) => void

A custom render function.

options : object

Element's options.

Properties

[ options.renderUnsafeAttributes ] : Array<string>

A list of attribute names that should be rendered in the editing pipeline even though they would normally be filtered out by unsafe attribute detection mechanisms.

Defaults to {}

Returns

ViewRawElement

The created element.

Creates new ViewSelection instance.

// Creates empty selection without ranges.
const selection = writer.createSelection();

// Creates selection at the given range.
const range = writer.createRange( start, end );
const selection = writer.createSelection( range );

// Creates selection at the given ranges
const ranges = [ writer.createRange( start1, end2 ), writer.createRange( star2, end2 ) ];
const selection = writer.createSelection( ranges );

// Creates selection from the other selection.
const otherSelection = writer.createSelection();
const selection = writer.createSelection( otherSelection );

// Creates selection from the document selection.
const selection = writer.createSelection( editor.editing.view.document.selection );

// Creates selection at the given position.
const position = writer.createPositionFromPath( root, path );
const selection = writer.createSelection( position );

Selection's constructor allow passing additional options (backward, fake and label) as the last argument.

// Creates backward selection.
const selection = writer.createSelection( range, { backward: true } );

Fake selection does not render as browser native selection over selected elements and is hidden to the user. This way, no native selection UI artifacts are displayed to the user and selection over elements can be represented in other way, for example by applying proper CSS class.

Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM (and be properly handled by screen readers).

// Creates fake selection with label.
const selection = writer.createSelection( range, { fake: true, label: 'foo' } );

See also: createSelection( node, placeOrOffset, options ).

Parameters

[ selectable ] : null | ViewPosition | ViewRange | ViewSelection | ViewDocumentSelection | Iterable<ViewRange>

[ option ] : ViewSelectionOptions

Returns

ViewSelection

Creates new ViewSelection instance.

// Creates collapsed selection at the position of given item and offset.
const paragraph = writer.createContainerElement( 'p' );
const selection = writer.createSelection( paragraph, offset );

// Creates a range inside an element which starts before the
// first child of that element and ends after the last child of that element.
const selection = writer.createSelection( paragraph, 'in' );

// Creates a range on an item which starts before the item and ends
// just after the item.
const selection = writer.createSelection( paragraph, 'on' );

Selection's constructor allow passing additional options (backward, fake and label) as the last argument.

// Creates backward selection.
const selection = writer.createSelection( element, 'in', { backward: true } );

Fake selection does not render as browser native selection over selected elements and is hidden to the user. This way, no native selection UI artifacts are displayed to the user and selection over elements can be represented in other way, for example by applying proper CSS class.

Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM (and be properly handled by screen readers).

// Creates fake selection with label.
const selection = writer.createSelection( element, 'in', { fake: true, label: 'foo' } );

See also: createSelection( selectable, options ).

Parameters

selectable : ViewNode

placeOrOffset : ViewPlaceOrOffset

[ options ] : ViewSelectionOptions

Returns

ViewSelection

Creates placeholders for child elements of the elementToStructure() conversion helper.

const viewSlot = conversionApi.writer.createSlot();
const viewPosition = conversionApi.writer.createPositionAt( viewElement, 0 );

conversionApi.writer.insert( viewPosition, viewSlot );

It could be filtered down to a specific subset of children (only <foo> model elements in this case):

const viewSlot = conversionApi.writer.createSlot( node => node.is( 'element', 'foo' ) );
const viewPosition = conversionApi.writer.createPositionAt( viewElement, 0 );

conversionApi.writer.insert( viewPosition, viewSlot );

While providing a filtered slot, make sure to provide slots for all child nodes. A single node cannot be downcasted into multiple slots.

Note: You should not change the order of nodes. View elements should be in the same order as model nodes.

Parameters

modeOrFilter : 'children' | DowncastSlotFilter

The filter for child nodes.

Defaults to 'children'

Returns

ViewElement

The slot element to be placed in to the view structure while processing elementToStructure().

Creates a new text node.

writer.createText( 'foo' );

Parameters

data : string

The text's data.

Returns

ViewText

The created text node.

Creates a new ViewUIElement.

writer.createUIElement( 'span' );
writer.createUIElement( 'span', { id: 'foo-1234' } );

A custom render function can be provided as the third parameter:

writer.createUIElement( 'span', null, function( domDocument ) {
	const domElement = this.toDomElement( domDocument );
	domElement.innerHTML = '<b>this is ui element</b>';

	return domElement;
} );

Unlike raw elements, UI elements are by no means editor content, for instance, they are ignored by the editor selection system.

You should not use UI elements as data containers. Check out createRawElement instead.

Parameters

name : string

The name of the element.

[ attributes ] : ViewElementAttributes

Element attributes.

[ renderFunction ] : ( this: ViewUIElement, domDocument: Document, domConverter: ViewDomConverter ) => HTMLElement

A custom render function.

Returns

ViewUIElement

The created element.

Inserts a node or nodes at specified position. Takes care about breaking attributes before insertion and merging them afterwards.

Throws CKEditorError view-writer-insert-invalid-node when nodes to insert contains instances that are not Texts, ViewAttributeElements, ViewContainerElements, ViewEmptyElements, RawElements or UIElements.

Parameters

position : ViewPosition

Insertion position.

nodes : ViewNode | Iterable<ViewNode>

Node or nodes to insert.

Returns

ViewRange

Range around inserted nodes.

Merges attribute elements. It also merges text nodes if needed. Only similar attribute elements can be merged.

In following examples <p> is a container and <b> is an attribute element:

<p>foo[]bar</p> -> <p>foo{}bar</p>
<p><b>foo</b>[]<b>bar</b></p> -> <p><b>foo{}bar</b></p>
<p><b foo="bar">a</b>[]<b foo="baz">b</b></p> -> <p><b foo="bar">a</b>[]<b foo="baz">b</b></p>

It will also take care about empty attributes when merging:

<p><b>[]</b></p> -> <p>[]</p>
<p><b>foo</b><i>[]</i><b>bar</b></p> -> <p><b>foo{}bar</b></p>

Note: Difference between mergeAttributes and mergeContainers is that mergeAttributes merges two attribute elements or text nodes while mergeContainer merges two container elements.

Parameters

position : ViewPosition

Merge position.

Returns

ViewPosition

Position after merge.

Related:

• ViewAttributeElement
• ViewContainerElement
• ViewDowncastWriter#mergeContainers

Merges two container elements that are before and after given position. Precisely, the element after the position is removed and it's contents are moved to element before the position.

<p>foo</p>^<p>bar</p> -> <p>foo^bar</p>
<div>foo</div>^<p>bar</p> -> <div>foo^bar</div>

Note: Difference between mergeAttributes and mergeContainers is that mergeAttributes merges two attribute elements or text nodes while mergeContainer merges two container elements.

Parameters

position : ViewPosition

Merge position.

Returns

ViewPosition

Position after merge.

Related:

• ViewAttributeElement
• ViewContainerElement
• ViewDowncastWriter#mergeAttributes

Moves nodes from provided range to target position.

Throws CKEditorError view-writer-invalid-range-container when start and end positions are not placed inside same parent container.

Parameters

sourceRange : ViewRange

Range containing nodes to move.

targetPosition : ViewPosition

Position to insert.

Returns

ViewRange

Range in target container. Inserted nodes are placed between start and end positions.

Removes provided range from the container.

Throws CKEditorError view-writer-invalid-range-container when start and end positions are not placed inside same parent container.

Parameters

rangeOrItem : ViewRange | ViewItem

Range to remove from container or an item to remove. If range is provided, after removing, it will be updated to a collapsed range showing the new position.

Returns

ViewDocumentFragment

Document fragment containing removed nodes.

Removes specified tokens from an attribute value (for example class names, style properties). If resulting attribute become empty, the whole attribute is removed.

writer.removeAttribute( 'class', 'foo', linkElement );

Parameters

key : string

Attribute key.

tokens : ArrayOrItem<string>

Tokens to partly remove from attribute value. For example class names or style property names.

element : ViewElement

The element to remove an attribute of.

Returns

void

Removes attribute from the element.

writer.removeAttribute( 'href', linkElement );

Parameters

key : string

Attribute key.

element : ViewElement

The element to remove an attribute of.

Returns

void

Removes specified class from the element.

writer.removeClass( 'foo', linkElement );
writer.removeClass( [ 'foo', 'bar' ], linkElement );

Parameters

className : string | Array<string>

element : ViewElement

Returns

void

Removes a custom property stored under the given key.

Parameters

key : string | symbol

element : ViewElement | ViewDocumentFragment

Returns

boolean

Returns true if property was removed.

Removes specified style from the element.

writer.removeStyle( 'color', element ); // Removes 'color' style.
writer.removeStyle( [ 'color', 'border-top' ], element ); // Removes both 'color' and 'border-top' styles.

Note: This method can work with normalized style names if a particular style processor rule is enabled. See StylesMap#remove() for details.

Parameters

property : string | Array<string>

element : ViewElement

Returns

void

Renames element by creating a copy of renamed element but with changed name and then moving contents of the old element to the new one. Keep in mind that this will invalidate all positions which has renamed element as a parent.

New element has to be created because Element#tagName property in DOM is readonly.

Since this function creates a new element and removes the given one, the new element is returned to keep reference.

Parameters

newName : string

New name for element.

viewElement : ViewContainerElement

Element to be renamed.

Returns

ViewContainerElement

Element created due to rename.

Adds or overwrites the element's attribute with a specified key and value. Note that for tokenized attributes it allows the reset parameter to specify if the previous attribute value should be overwritten or a new token (class name, style property) should be added.

writer.setAttribute( 'href', 'http://ckeditor.com', linkElement );
writer.setAttribute( 'class', 'foo', false, element );

Parameters

key : string

The attribute key.

value : unknown

The attribute value.

overwrite : boolean

Whether tokenized attribute should overwrite the attribute value or just add a token.

element : ViewElement

The element to set an attribute on.

Returns

void

Adds or overwrites the element's attribute with a specified key and value.

writer.setAttribute( 'href', 'http://ckeditor.com', linkElement );

Parameters

key : string

The attribute key.

value : unknown

The attribute value.

element : ViewElement

The element to set an attribute on.

Returns

void

Sets a custom property on element. Unlike attributes, custom properties are not rendered to the DOM, so they can be used to add special data to elements.

Parameters

key : string | symbol

value : unknown

element : ViewElement | ViewDocumentFragment

Returns

void

Sets selection's ranges and direction to the specified location based on the given selectable.

Usage:

// Sets selection to the given range.
const range = writer.createRange( start, end );
writer.setSelection( range );

// Sets backward selection to the given range.
const range = writer.createRange( start, end );
writer.setSelection( range );

// Sets selection to given ranges.
const ranges = [ writer.createRange( start1, end2 ), writer.createRange( start2, end2 ) ];
writer.setSelection( range );

// Sets selection to the other selection.
const otherSelection = writer.createSelection();
writer.setSelection( otherSelection );

// Sets collapsed selection at the given position.
const position = writer.createPositionFromPath( root, path );
writer.setSelection( position );

// Removes all ranges.
writer.setSelection( null );

ViewDowncastWriter#setSelection() allow passing additional options (backward, fake and label) as the last argument.

// Sets selection as backward.
writer.setSelection( range, { backward: true } );

// Sets selection as fake.
// Fake selection does not render as browser native selection over selected elements and is hidden to the user.
// This way, no native selection UI artifacts are displayed to the user and selection over elements can be
// represented in other way, for example by applying proper CSS class.
writer.setSelection( range, { fake: true } );

// Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM
// (and be  properly handled by screen readers).
writer.setSelection( range, { fake: true, label: 'foo' } );

See also: setSelection( node, placeOrOffset, options ).

Parameters

selectable : null | ViewPosition | ViewRange | ViewSelection | ViewDocumentSelection | Iterable<ViewRange>

[ options ] : ViewSelectionOptions

Returns

void

Sets selection's ranges and direction to the specified location based on the given selectable.

Usage:

// Sets collapsed selection at the position of given item and offset.
const paragraph = writer.createContainerElement( 'p' );
writer.setSelection( paragraph, offset );

Creates a range inside an element which starts before the first child of that element and ends after the last child of that element.

writer.setSelection( paragraph, 'in' );

Creates a range on the item which starts before the item and ends just after the item.

writer.setSelection( paragraph, 'on' );

ViewDowncastWriter#setSelection() allow passing additional options (backward, fake and label) as the last argument.

// Sets selection as backward.
writer.setSelection( element, 'in', { backward: true } );

// Sets selection as fake.
// Fake selection does not render as browser native selection over selected elements and is hidden to the user.
// This way, no native selection UI artifacts are displayed to the user and selection over elements can be
// represented in other way, for example by applying proper CSS class.
writer.setSelection( element, 'in', { fake: true } );

// Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM
// (and be  properly handled by screen readers).
writer.setSelection( element, 'in', { fake: true, label: 'foo' } );

See also: setSelection( selectable, options ).

Parameters

selectable : ViewNode

placeOrOffset : ViewPlaceOrOffset

[ options ] : ViewSelectionOptions

Returns

void

Moves selection's focus to the specified location.

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

Parameters

itemOrPosition : ViewPosition | ViewItem

[ offset ] : ViewPositionOffset

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

Returns

void

Adds many styles to the element.

writer.setStyle( {
	color: 'red',
	position: 'fixed'
}, element );

Note: The passed style can be normalized if a particular style processor rule is enabled. See StylesMap#set() for details.

Parameters

property : Record<string, string>

Object with key - value pairs.

element : ViewElement

Element to set styles on.

Returns

void

Adds style to the element.

writer.setStyle( 'color', 'red', element );

Note: The passed style can be normalized if a particular style processor rule is enabled. See StylesMap#set() for details.

Parameters

property : string

Property name.

value : string

Value to set.

element : ViewElement

Element to set styles on.

Returns

void

Unwraps nodes within provided range from attribute element.

Throws CKEditorError view-writer-invalid-range-container when start and end positions are not placed inside same parent container.

Parameters

range : ViewRange

attribute : ViewAttributeElement

Returns

ViewRange

Wraps elements within range with provided ViewAttributeElement. If a collapsed range is provided, it will be wrapped only if it is equal to view selection.

If a collapsed range was passed and is same as selection, the selection will be moved to the inside of the wrapped attribute element.

Throws CKEditorError view-writer-invalid-range-container when start and end positions are not placed inside same parent container.

Throws CKEditorError view-writer-wrap-invalid-attribute when passed attribute element is not an instance of ViewAttributeElement.

Throws CKEditorError view-writer-wrap-nonselection-collapsed-range when passed range is collapsed and different than view selection.

Parameters

range : ViewRange

Range to wrap.

attribute : ViewAttributeElement

Attribute element to use as wrapper.

Returns

ViewRange

range Range after wrapping, spanning over wrapping attribute element.

Clears the registered slot factory.

Returns

void

Registers a slot factory.

Parameters

slotFactory : ( writer: ViewDowncastWriter, modeOrFilter: 'children' | DowncastSlotFilter ) => ViewElement

The slot factory.

Returns

void

Stores the information that an attribute element was added to the tree. Saves the reference to the group in the given element and updates the group, so other elements from the group now keep a reference to the given attribute element.

The clones group can be obtained using getElementsWithSameId.

Does nothing if added element has no id.

Parameters

element : ViewNode

Attribute element to save.

Returns

void

Helper function used by other ViewDowncastWriter methods. Breaks attribute elements at given position.

Throws CKEditorError view-writer-cannot-break-empty-element when break position is placed inside ViewEmptyElement.

Throws CKEditorError view-writer-cannot-break-ui-element when break position is placed inside UIElement.

Parameters

position : ViewPosition

Position where to break attributes.

forceSplitText : boolean

If set to true, will break text nodes even if they are directly in container element. This behavior will result in incorrect view state, but is needed by other view writing methods which then fixes view state.

Defaults to false

Returns

ViewPosition

New position after breaking the attributes.

Helper function used by other ViewDowncastWriter methods. Breaks attribute elements at the boundaries of given range.

Parameters

range : ViewRange

Range which start and end positions will be used to break attributes.

forceSplitText : boolean

If set to true, will break text nodes even if they are directly in container element. This behavior will result in incorrect view state, but is needed by other view writing methods which then fixes view state.

Defaults to false

Returns

ViewRange

New range with located at break positions.

Inserts a node or nodes at the specified position. Takes care of breaking attributes before insertion and merging them afterwards if requested by the breakAttributes param.

Parameters

position : ViewPosition

Insertion position.

nodes : Iterable<ViewNode>

Node or nodes to insert.

breakAttributes : boolean

Whether attributes should be broken.

Returns

ViewRange

Range around inserted nodes.

Removes all the information about the given attribute element from its clones group.

Keep in mind, that the element will still keep a reference to the group (but the group will not keep a reference to it). This allows to reference the whole group even if the element was already removed from the tree.

Does nothing if the element has no id.

Parameters

element : ViewNode

Attribute element to remove.

Returns

void

Unwraps children from provided unwrapElement. Only children contained in parent element between startOffset and endOffset will be unwrapped.

Parameters

parent : ViewElement

startOffset : number

endOffset : number

unwrapElement : ViewAttributeElement

Returns

ViewRange

Wraps children with provided wrapElement. Only children contained in parent element between startOffset and endOffset will be wrapped.

Parameters

parent : ViewElement

startOffset : number

endOffset : number

wrapElement : ViewAttributeElement

Returns

ViewRange

Helper function for wrap. Wraps position with provided attribute element. This method will also merge newly added attribute element with its siblings whenever possible.

Throws CKEditorError view-writer-wrap-invalid-attribute when passed attribute element is not an instance of ViewAttributeElement.

Parameters

position : ViewPosition

attribute : ViewAttributeElement

Returns

ViewPosition

New position after wrapping.

Helper function for view.writer.wrap. Wraps range with provided attribute element. This method will also merge newly added attribute element with its siblings whenever possible.

Throws CKEditorError view-writer-wrap-invalid-attribute when passed attribute element is not an instance of ViewAttributeElement.

Parameters

range : ViewRange

attribute : ViewAttributeElement

Returns

ViewRange

New range after wrapping, spanning over wrapping attribute element.