Skip to content

Commit

Permalink
Merge pull request #500 from ckeditor/t/495
Browse files Browse the repository at this point in the history
Update fake element docs

Closes #495
  • Loading branch information
Comandeer authored Jun 12, 2017
2 parents 82721bb + 20db800 commit 8deb98b
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions plugins/fakeobjects/plugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,15 @@
} );

/**
* Creates fake {@link CKEDITOR.dom.element} based on real element.
* Fake element is an img with special attributes, which keep real element properties.
*
* @member CKEDITOR.editor
* @todo
* @param {CKEDITOR.dom.element} realElement Real element to transform.
* @param {String} className Class name which will be used as class of fake element.
* @param {String} realElementType Stores type of fake element.
* @param {Boolean} isResizable Keeps information if element is resizable.
* @returns {CKEDITOR.dom.element} Fake element.
*/
CKEDITOR.editor.prototype.createFakeElement = function( realElement, className, realElementType, isResizable ) {
var lang = this.lang.fakeobjects,
Expand Down Expand Up @@ -115,8 +122,14 @@
};

/**
* Creates fake {@link CKEDITOR.htmlParser.element} based on real element.
*
* @member CKEDITOR.editor
* @todo
* @param {CKEDITOR.dom.element} realElement Real element to transform.
* @param {String} className Class name which will be used as class of fake element.
* @param {String} realElementType Store type of fake element.
* @param {Boolean} isResizable Keep information if element is resizable.
* @returns {CKEDITOR.htmlParser.element} Fake htmlParser element.
*/
CKEDITOR.editor.prototype.createFakeParserElement = function( realElement, className, realElementType, isResizable ) {
var lang = this.lang.fakeobjects,
Expand Down Expand Up @@ -160,8 +173,11 @@
};

/**
* Creates {@link CKEDITOR.dom.element} from fake element.
*
* @member CKEDITOR.editor
* @todo
* @param {CKEDITOR.dom.element} fakeElement Fake element to transform.
* @returns {CKEDITOR.dom.element/null} Returns real element or `null` if transformed element wasn't fake.
*/
CKEDITOR.editor.prototype.restoreRealElement = function( fakeElement ) {
if ( fakeElement.data( 'cke-real-node-type' ) != CKEDITOR.NODE_ELEMENT )
Expand Down

0 comments on commit 8deb98b

Please sign in to comment.