CKEditor 4 Documentation

CKEDITOR.ui.button

Subclasses

Files

Represents a button UI element. This class should not be called directly. To create new buttons use CKEDITOR.ui.addButton instead.

Defined By

Methods

CKEDITOR.ui.button
view source
new( definition ) : CKEDITOR.ui.button
Creates a button class instance. ...

Creates a button class instance.

Parameters

  • definition : Object

    The button definition.

Returns

CKEDITOR.ui.button
view source
( ) : Number
Gets the button state. ...

Gets the button state.

Returns

CKEDITOR.ui.button
view source
( editor, output )
Renders the button. ...

Renders the button.

Parameters

  • editor : CKEDITOR.editor

    The editor instance which this button is to be used by.

  • output : Array

    The output array to which the HTML code related to this button should be appended.

CKEDITOR.ui.button
view source
( state )
Sets the button state. ...

Sets the button state.

Parameters

CKEDITOR.ui.button
view source
( Editor ) : CKEDITOR.feature
Returns this button's CKEDITOR.feature instance. ...

Returns this button's CKEDITOR.feature instance.

It may be this button instance if it has at least one of allowedContent and requiredContent properties. Otherwise, if a command is bound to this button by the command property, then that command will be returned.

This method implements the CKEDITOR.feature.toFeature interface method.

Available since: 4.1

Parameters

Returns