Class CKEDITOR.ui
Defined in: core/ui.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
CKEDITOR.ui(editor)
Contains UI features related to an editor instance.
|
| Field Attributes | Field Name and Description |
|---|---|
| <static> |
CKEDITOR.ui.separator
The UI element that renders a toolbar separator.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
CKEDITOR.ui.panel(document, definition)
|
|
add(name, type, definition)
Adds a UI item to the items collection.
|
|
|
addButton(The, The)
Adds a button definition to the UI elements list.
|
|
|
addHandler(type, handler)
Adds a handler for a UI item type.
|
|
|
addRichCombo(name, definition)
|
|
|
create(name)
Gets a UI object.
|
Class Detail
CKEDITOR.ui(editor)
Since:
3.0
Contains UI features related to an editor instance.
- Parameters:
- {CKEDITOR.editor} editor
- The editor instance.
Field Detail
<static>
{Object}
CKEDITOR.ui.separator
Since:
3.0
The UI element that renders a toolbar separator.
Defined in: plugins/toolbar/plugin.js.
Defined in: plugins/toolbar/plugin.js.
Method Detail
<static>
{Undefined}
CKEDITOR.ui.panel(document, definition)
Since:
3.0
Defined in: plugins/panel/plugin.js.
NO EXAMPLE AVAILABLE
- Parameters:
- {Undefined} document
- {Undefined} definition
{Undefined}
add(name, type, definition)
Since:
3.0
Adds a UI item to the items collection. These items can be later used in
the interface.
// Add a new button named "MyBold".
editorInstance.ui.add( 'MyBold', CKEDITOR.UI_BUTTON,
{
label : 'My Bold',
command : 'bold'
});
- Parameters:
- {String} name
- The UI item name.
- {Object} type
- The item type.
- {Object} definition
- The item definition. The properties of this object depend on the item type.
{Undefined}
addButton(The, The)
Since:
3.0
Adds a button definition to the UI elements list.
Defined in: plugins/button/plugin.js.
Defined in: plugins/button/plugin.js.
editorInstance.ui.addButton( 'MyBold',
{
label : 'My Bold',
command : 'bold'
});
- Parameters:
- {String} The
- button name.
- {Object} The
- button definition.
{Undefined}
addHandler(type, handler)
Since:
3.0
Adds a handler for a UI item type. The handler is responsible for
transforming UI item definitions in UI objects.
- Parameters:
- {Object} type
- The item type.
- {Object} handler
- The handler definition.
{Undefined}
addRichCombo(name, definition)
Since:
3.0
Defined in: plugins/richcombo/plugin.js.
NO EXAMPLE AVAILABLE
- Parameters:
- {Undefined} name
- {Undefined} definition
{Undefined}
create(name)
Since:
3.0
Gets a UI object.
- Parameters:
- {String} name
- The UI item hame.