CKEditor Ecosystem Documentation
Search
CKEditor 4 reached its End of Life (EOL) in June 2023. From then on, it will receive no more updates, new features, bug fixes, and security patches. Visit CKEditor 5 Docs for the actively supported CKEditor or check Extended Support Model.
Report an issue
Home/CKEditor 4/API
Class

CKEDITOR.ui.richCombo.handler

class singleton
See source

Represents a rich combo handler object.

Filtering

Properties

  • since 4.5.0 readonly

    contentsElement : element

    See source

    The element in the host page's document that contains the editor content. If the fixed editor UI is used, then it will be set to editor.ui.space( 'contents' ) — i.e. the <div> which contains the editor <iframe> (in case of classic editor) or CKEDITOR.editable (in case of inline editor). Otherwise it is set to the CKEDITOR.editable itself.

    Use the position of this element if you need to position elements placed in the host page's document relatively to the editor content.

    var editor = CKEDITOR.instances.editor1;
console.log( editor.ui.contentsElement.getName() ); // 'div'

Methods

  • inherited

    create( definition ) → Object

    See source

    Transforms an item definition into a UI item object.

    editorInstance.ui.addHandler( CKEDITOR.UI_BUTTON, {
    create: function( definition ) {
        return new CKEDITOR.ui.button( definition );
    }
} );

    Parameters

    definition : Object

    The item definition.

    Returns

    Object

    The UI element. We lack the "UI element" abstract super class.