class CkeditorTableSelection in CKEditor Table Selection 2.0.x
Same name and namespace in other branches
- 8 src/Plugin/CKEditorPlugin/CkeditorTableSelection.php \Drupal\ckeditor_tableselection\Plugin\CKEditorPlugin\CkeditorTableSelection
- 9.1.x src/Plugin/CKEditorPlugin/CkeditorTableSelection.php \Drupal\ckeditor_tableselection\Plugin\CKEditorPlugin\CkeditorTableSelection
Defines the "Table Selection" plugin.
Plugin annotation
@CKEditorPlugin(
id = "tableselection",
label = @Translation("Table Selection")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\ckeditor_tableselection\Plugin\CKEditorPlugin\CkeditorTableSelection implements CKEditorPluginContextualInterface, CKEditorPluginCssInterface, CKEditorPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of CkeditorTableSelection
File
- src/
Plugin/ CKEditorPlugin/ CkeditorTableSelection.php, line 19
Namespace
Drupal\ckeditor_tableselection\Plugin\CKEditorPluginView source
class CkeditorTableSelection extends PluginBase implements CKEditorPluginInterface, CKEditorPluginContextualInterface, CKEditorPluginCssInterface {
/**
* {@inheritdoc}
*/
public function isInternal() {
return FALSE;
}
/**
* Returns ckeditor tableselection plugin path relative to drupal root.
*
* @return string
* Relative path to the ckeditor plugin folder
*/
private function getPluginPath() {
return 'libraries/tableselection';
}
/**
* {@inheritdoc}
*/
public function getFile() {
return $this
->getPluginPath() . '/plugin.js';
}
/**
* {@inheritdoc}
*/
public function isEnabled(Editor $editor) {
if (!$editor
->hasAssociatedFilterFormat()) {
return FALSE;
}
// Automatically enable this plugin if the text format associated with this
// text editor uses the filter_align or filter_caption filter and the
// Table button is enabled.
$format = $editor
->getFilterFormat();
if ($format
->filters('filter_align')->status || $format
->filters('filter_caption')->status) {
$settings = $editor
->getSettings();
foreach ($settings['toolbar']['rows'] as $row) {
foreach ($row as $group) {
foreach ($group['items'] as $button) {
if ($button === 'Table') {
return TRUE;
}
}
}
}
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function getCssFiles(Editor $editor) {
return [
$this
->getPluginPath() . '/styles/tableselection.css',
];
}
/**
* {@inheritdoc}
*/
public function getLibraries(Editor $editor) {
return [];
}
/**
* {@inheritdoc}
*/
public function getConfig(Editor $editor) {
return [];
}
/**
* {@inheritdoc}
*/
public function getDependencies(Editor $editor) {
return [];
}
/**
* {@inheritdoc}
*/
public function getButtons() {
return [];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CkeditorTableSelection:: |
public | function | ||
CkeditorTableSelection:: |
public | function |
Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface:: |
|
CkeditorTableSelection:: |
public | function |
Retrieves enabled plugins' iframe instance CSS files. Overrides CKEditorPluginCssInterface:: |
|
CkeditorTableSelection:: |
public | function |
Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface:: |
|
CkeditorTableSelection:: |
public | function |
Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface:: |
|
CkeditorTableSelection:: |
public | function |
Returns a list of libraries this plugin requires. Overrides CKEditorPluginInterface:: |
|
CkeditorTableSelection:: |
private | function | Returns ckeditor tableselection plugin path relative to drupal root. | |
CkeditorTableSelection:: |
public | function |
Checks if this plugin should be enabled based on the editor configuration. Overrides CKEditorPluginContextualInterface:: |
|
CkeditorTableSelection:: |
public | function |
Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface:: |
|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 98 |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |