CKEDITOR.htmlDataProcessor
Represents an HTML data processor, which is responsible for translating and transforming the editor data on input and output.
Filtering
Properties
dataFilter : filterCKEDITOR.htmlDataProcessor#dataFilterData filter used when processing input by toHtml.
htmlFilter : filterCKEDITOR.htmlDataProcessor#htmlFilterHTML filter used when processing output by toDataFormat.
writer : basicWriterCKEDITOR.htmlDataProcessor#writerThe HTML writer used by this data processor to format the output.
Methods
constructor( editor ) → htmlDataProcessorCKEDITOR.htmlDataProcessor#constructorCreates an htmlDataProcessor class instance.
Parameters
editor : editor
Returns
htmlDataProcessor
-
Transforms HTML into data to be output by the editor, in the format expected by the data processor.
While the editor is able to handle non-HTML data (like BBCode), it can only handle HTML data at runtime. The role of the data processor is to transform the HTML data contained by the editor into a specific data format through this function.
// Tranforming into BBCode data, with a custom BBCode data processor available. var html = '<p>This is <b>an example</b>.</p>'; var data = editor.dataProcessor.toDataFormat( html ); // 'This is [b]an example[/b].'Parameters
html : StringThe HTML to be transformed.
fixForBody : StringThe tag name to be used if the output data is coming from the
<body>element and may be eventually fixed for it. This is generally not used by non-HTML data processors.Transforms input data into HTML to be loaded into the editor. While the editor is able to handle non-HTML data (like BBCode), it can only handle HTML data at runtime. The role of the data processor is to transform the input data into HTML through this function.
// Tranforming BBCode data, with a custom BBCode data processor available. var data = 'This is [b]an example[/b].'; var html = editor.dataProcessor.toHtml( data ); // '<p>This is <b>an example</b>.</p>'Parameters
data : StringThe input data to be transformed.
[ fixForBody ] : StringThe tag name to be used if the data must be fixed because it is supposed to be loaded direcly into the
<body>tag. This is generally not used by non-HTML data processors. fixForBody type - compare to htmlDataProcessor.