CKEditor Ecosystem Documentation

Report an issue

Home/CKEditor 4/API

Class

CKEDITOR.plugins.indent

classsingleton

Global command class definitions and global helpers.

Methods

registerCommands( editor, commands )
See source
Registers content-specific commands as a part of the indentation system directed by generic commands. Once a command is registered, it listens for events of a related generic command.
```
CKEDITOR.plugins.indent.registerCommands( editor, {
    'indentlist': new indentListCommand( editor, 'indentlist' ),
    'outdentlist': new indentListCommand( editor, 'outdentlist' )
} );
```
Content-specific commands listen for the generic command's exec and try to execute their own jobs, one after another. If some execution is successful, evt.data.done is set so no more jobs (commands) are involved.
Content-specific commands also listen for the generic command's refresh and fill the evt.data.states object with states of jobs. A generic command uses this data to determine its own state and to update the UI.
Parameters
editor : editor
The editor instance this command is applied to.
commands : Object
An object of CKEDITOR.command.