Report an issue
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

Methods

  • constructor( definition ) → button

    Creates a button class instance.

    Parameters

    definition : Object

    The button definition.

    Returns

    button
  • getState() → Number

    Gets the button state.

    Returns

    Number

    The button state. One of CKEDITOR.TRISTATE_ON, CKEDITOR.TRISTATE_OFF, or CKEDITOR.TRISTATE_DISABLED.

  • render( editor, output )

    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 )

    Sets the button state.

    Parameters

    state : Number

    Indicates the button state. One of CKEDITOR.TRISTATE_ON, CKEDITOR.TRISTATE_OFF, or CKEDITOR.TRISTATE_DISABLED.

  • toFeature( Editor ) → feature

    since 4.1.0

    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.