66 lines
2.9 KiB
JavaScript
66 lines
2.9 KiB
JavaScript
/*
|
|
Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
|
|
For licensing, see LICENSE.html or http://ckeditor.com/license
|
|
*/
|
|
|
|
/**
|
|
* @fileOverview Defines the "virtual" {@link CKEDITOR.dataProcessor} class, which
|
|
* defines the basic structure of data processor objects to be
|
|
* set to {@link CKEDITOR.editor.dataProcessor}.
|
|
*/
|
|
|
|
/**
|
|
* If defined, points to the data processor which is responsible to translate
|
|
* and transform the editor data on input and output.
|
|
* Generaly it will point to an instance of {@link CKEDITOR.htmlDataProcessor},
|
|
* which handles HTML data. The editor may also handle other data formats by
|
|
* using different data processors provided by specific plugins.
|
|
* @name CKEDITOR.editor.prototype.dataProcessor
|
|
* @type CKEDITOR.dataProcessor
|
|
*/
|
|
|
|
/**
|
|
* This class is here for documentation purposes only and is not really part of
|
|
* the API. It serves as the base ("interface") for data processors
|
|
* implementation.
|
|
* @name CKEDITOR.dataProcessor
|
|
* @class Represents a data processor, which is responsible to translate and
|
|
* transform the editor data on input and output.
|
|
* @example
|
|
*/
|
|
|
|
/**
|
|
* Transforms input data into HTML to be loaded in the editor.
|
|
* While the editor is able to handle non HTML data (like BBCode), at runtime
|
|
* it can handle HTML data only. The role of the data processor is transforming
|
|
* the input data into HTML through this function.
|
|
* @name CKEDITOR.dataProcessor.prototype.toHtml
|
|
* @function
|
|
* @param {String} data The input data to be transformed.
|
|
* @param {String} [fixForBody] The 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.
|
|
* @example
|
|
* // Tranforming BBCode data, having a custom BBCode data processor.
|
|
* var data = 'This is [b]an example[/b].';
|
|
* var html = editor.dataProcessor.toHtml( data ); // '<p>This is <b>an example</b>.</p>'
|
|
*/
|
|
|
|
/**
|
|
* Transforms HTML into data to be outputted by the editor, in the format
|
|
* expected by the data processor.
|
|
* While the editor is able to handle non HTML data (like BBCode), at runtime
|
|
* it can handle HTML data only. The role of the data processor is transforming
|
|
* the HTML data containined by the editor into a specific data format through
|
|
* this function.
|
|
* @name CKEDITOR.dataProcessor.prototype.toDataFormat
|
|
* @function
|
|
* @param {String} html The HTML to be transformed.
|
|
* @param {String} fixForBody The tag name to be used if the output data is
|
|
* coming from <body> and may be eventually fixed for it. This is
|
|
* generally not used by non-HTML data processors.
|
|
* // Tranforming into BBCode data, having a custom BBCode data processor.
|
|
* var html = '<p>This is <b>an example</b>.</p>';
|
|
* var data = editor.dataProcessor.toDataFormat( html ); // 'This is [b]an example[/b].'
|
|
*/
|