CKEditor configuration UI methods of Backbone objects.
Classes
Members
(static) models :object
A hash of Model instances.
Type:
- object
(static, nullable) saveCallback :function
Variable storing the current dialog's save callback.
Type:
- function
(static) views :object
A hash of View instances.
Type:
- object
Methods
(static) openDialog(editor, url, existingValues, saveCallback, dialogSettings)
Open a dialog for a Drupal-based plugin.
This dynamically loads jQuery UI (if necessary) using the Drupal AJAX framework, then opens a dialog at the specified Drupal path.
Parameters:
| Name | Type | Description |
|---|---|---|
editor |
CKEditor | The CKEditor instance that is opening the dialog. |
url |
string | The URL that contains the contents of the dialog. |
existingValues |
object | Existing values that will be sent via POST to the url for the dialog contents. |
saveCallback |
function | A function to be called upon saving the dialog. |
dialogSettings |
object | An object containing settings to be passed to the jQuery UI. |
(static) openGroupNameDialog(view, $group, callback)
Opens a dialog with a form for changing the title of a button group.
Parameters:
| Name | Type | Description |
|---|---|---|
view |
Backbone.View | The Backbone View that invoked this function. |
$group |
jQuery | A jQuery set that contains an li element that wraps a group of buttons. |
callback |
function | A callback to invoke after the button group naming modal dialog has been closed. |
(static) registerButtonMove(view, $button, callback)
Translates changes in CKEditor config DOM structure to the config model.
If the button is moved within an existing group, the DOM structure is simply translated to a configuration model. If the button is moved into a new group placeholder, then a process is launched to name that group before the button move is translated into configuration.
Parameters:
| Name | Type | Description |
|---|---|---|
view |
Backbone.View | The Backbone View that invoked this function. |
$button |
jQuery | A jQuery set that contains an li element that wraps a button element. |
callback |
function | A callback to invoke after the button group naming modal dialog has been closed. |
(static) registerGroupMove(view, $group)
Translates changes in CKEditor config DOM structure to the config model.
Each row has a placeholder group at the end of the row. A user may not move an existing button group past the placeholder group at the end of a row.
Parameters:
| Name | Type | Description |
|---|---|---|
view |
Backbone.View | The Backbone View that invoked this function. |
$group |
jQuery | A jQuery set that contains an li element that wraps a group of buttons. |