Defines an interface for contextually enabled CKEditor plugins.
Contextually enabled CKEditor plugins can be enabled via an explicit setting, or enable themselves based on the configuration of another setting, such as enabling based on a particular button being present in the toolbar.
If a contextually enabled CKEditor plugin must also be configurable (e.g. in the case where it must be enabled based on an explicit setting), then one must also implement the CKEditorPluginConfigurableInterface interface.
Expanded class hierarchy of CKEditorPluginContextualInterface
All classes that implement CKEditorPluginContextualInterface
CKEditorPluginConfigurableInterface
interface CKEditorPluginContextualInterface extends CKEditorPluginInterface {
/**
* Checks if this plugin should be enabled based on the editor configuration.
*
* The editor's settings can be found in $editor->settings.
*
* @param \Drupal\editor\Plugin\Core\Entity\Editor $editor
* A configured text editor object.
*
* @return bool
*/
public function isEnabled(Editor $editor);
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CKEditorPluginContextualInterface:: |
public | function | Checks if this plugin should be enabled based on the editor configuration. | 2 |
CKEditorPluginInterface:: |
public | function | Returns the additions to CKEDITOR.config for a specific CKEditor instance. | 3 |
CKEditorPluginInterface:: |
public | function | Returns the Drupal root-relative file path to the plugin JavaScript file. | 3 |
CKEditorPluginInterface:: |
public | function | Indicates if this plugin is part of the optimized CKEditor build. | 2 |
PluginInspectionInterface:: |
public | function | Returns the definition of the plugin implementation. | 1 |
PluginInspectionInterface:: |
public | function | Returns the plugin_id of the plugin instance. | 1 |