CKEditor Ecosystem Documentation

Report an issue

Home/CKEditor 4/API

Class

CKEDITOR.ui.button

class

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

Filtering

Public
Inherited
Mixed
Protected
Private
Deprecated

Methods

constructor( definition ) → button

See source
Creates a button class instance.

Parameters

definition : Object

The button definition.

Returns

button
getState() → Number

See source
Gets the button state.

Returns

Number

The button state. One of CKEDITOR.TRISTATE_ON, CKEDITOR.TRISTATE_OFF, or CKEDITOR.TRISTATE_DISABLED.
render( editor, output )

See source
Renders the button.

Parameters

editor : 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.
setState( state )

See source
Sets the button state.

Parameters

state : Number

Indicates the button state. One of CKEDITOR.TRISTATE_ON, CKEDITOR.TRISTATE_OFF, or CKEDITOR.TRISTATE_DISABLED.
since 4.1.0
toFeature( Editor ) → feature

See source
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.

Parameters

Editor : editor

instance.

Returns

feature

The feature.