XmlDataProcessor

DOM converter used to convert DOM elements to view elements.

DOM parser instance used to parse an XML string to an XML document.

A basic HTML writer instance used to convert DOM elements to an XML string. There is no need to use a dedicated XML writer because the basic HTML writer works well in this case.

A list of namespaces allowed to use in the XML input.

For example, registering namespaces [ 'attribute', 'container' ] allows to use <attirbute:tagName></attribute:tagName> and <container:tagName></container:tagName> input. It is mainly for debugging.

If false, comment nodes will be converted to $comment. Otherwise comment nodes are ignored.

Creates a new instance of the XML data processor class.

Parameters

document : ViewDocument

The view document instance.

options : object

Configuration options.

Properties

[ options.namespaces ] : Array<string>

A list of namespaces allowed to use in the XML input.

Defaults to {}

Registers a MatcherPattern for view elements whose content should be treated as raw data and not processed during the conversion from XML to view elements.

The raw data can be later accessed by a custom property of a view element called "$rawContent".

Parameters

pattern : MatcherPattern

Pattern matching all view elements whose content should be treated as raw data.

Returns

void

Converts the provided document fragment to data format – in this case an XML string.

Parameters

viewFragment : ViewDocumentFragment

Returns

string

An XML string.

Converts the provided XML string to a view tree.

Parameters

data : string

An XML string.

Returns

ViewDocumentFragment

A converted view element.

If the processor is set to use marked fillers, it will insert   fillers wrapped in <span> elements (<span data-cke-filler="true">&nbsp;</span>) instead of regular   characters.

This mode allows for a more precise handling of block fillers (so they do not leak into editor content) but bloats the editor data with additional markup.

This mode may be required by some features and will be turned on by them automatically.

Parameters

type : 'default' | 'marked'

Whether to use the default or the marked   block fillers.

Returns

void

Converts an XML string to its DOM representation. Returns a document fragment containing nodes parsed from the provided data.

Parameters

data : string

Returns

DocumentFragment