Class CKEDITOR.ui.button
Defined in: plugins/button/plugin.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
CKEDITOR.ui.button(definition)
Represents a button UI element.
|
| Field Attributes | Field Name and Description |
|---|---|
| <static> |
CKEDITOR.ui.button.handler
Transforms a button definition in a CKEDITOR.ui.button instance.
|
|
The command name associated to the button.
|
|
|
The button label.
|
|
|
The button advisory title.
|
| Method Attributes | Method Name and Description |
|---|---|
|
click()
The function to be called when the user clicks the button.
|
|
|
render(editor, output)
Renders the button.
|
|
|
setState(state)
|
Class Detail
CKEDITOR.ui.button(definition)
Since:
3.0
Represents a button UI element. This class should not be called directly. To
create new buttons use CKEDITOR.ui.prototype.addButton instead.
- Parameters:
- {Object} definition
- The button definition.
Field Detail
<static>
{Object}
CKEDITOR.ui.button.handler
Since:
3.0
Transforms a button definition in a CKEDITOR.ui.button instance.
{String}
command
Since:
3.0
The command name associated to the button. If no command is defined, the
"click" event is used.
{String}
label
Since:
3.0
The button label.
{String}
title
Since:
3.0
The button advisory title. It is usually displayed as the button tooltip.
If not defined, the label is used.
Method Detail
{Undefined}
click()
Since:
3.0
The function to be called when the user clicks the button. If not
defined, the "command" property is required, and the command gets
executed on click.
{Undefined}
render(editor, output)
Since:
3.0
Renders the button.
- Parameters:
- {CKEDITOR.editor} editor
- The editor instance which this button is to be used by.
- {Array} output
- The output array to which append the HTML relative to this button.
{Undefined}
setState(state)
Since:
3.0
NO EXAMPLE AVAILABLE
- Parameters:
- {Undefined} state