class CkeditorTableToolsToolbar in CKEditor Table Tools Toolbar 2.x

Defines the "Table Tools Toolbar" plugin.

Plugin annotation

@CKEditorPlugin(
  id = "tabletoolstoolbar",
  label = @Translation("Table Tools Toolbar")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\ckeditor\CKEditorPluginBase implements CKEditorPluginButtonsInterface, CKEditorPluginInterface
      • class \Drupal\ckeditor_tabletoolstoolbar\Plugin\CKEditorPlugin\CkeditorTableToolsToolbar

File

src/Plugin/CKEditorPlugin/CkeditorTableToolsToolbar.php, line 16

Namespace

Drupal\ckeditor_tabletoolstoolbar\Plugin\CKEditorPlugin

class CkeditorTableToolsToolbar extends CKEditorPluginBase {

  /**
   * {@inheritdoc}
   */
  public function getFile() {
    return $this
      ->getPluginPath() . '/plugin.js';
  }

  /**
   * {@inheritdoc}
   */
  public function getLibraries(Editor $editor) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getButtons() {
    return [
      'tableinsert' => [
        'label' => $this
          ->t('Add new table'),
        'image' => $this
          ->getPluginPath() . '/icons/tableinsert.png',
      ],
      'tabledelete' => [
        'label' => $this
          ->t('Delete current table'),
        'image' => $this
          ->getPluginPath() . '/icons/tabledelete.png',
      ],
      'tableproperties' => [
        'label' => $this
          ->t('Show dialog with table properties'),
        'image' => $this
          ->getPluginPath() . '/icons/tableproperties.png',
      ],
      'tablerowinsertbefore' => [
        'label' => $this
          ->t('Add row above current cell'),
        'image' => $this
          ->getPluginPath() . '/icons/tablerowinsertbefore.png',
      ],
      'tablerowinsertafter' => [
        'label' => $this
          ->t('Add row under current cell'),
        'image' => $this
          ->getPluginPath() . '/icons/tablerowinsertafter.png',
      ],
      'tablerowdelete' => [
        'label' => $this
          ->t('Delete row with current cell'),
        'image' => $this
          ->getPluginPath() . '/icons/tablerowdelete.png',
      ],
      'tablecolumninsertbefore' => [
        'label' => $this
          ->t('Add column before current cell'),
        'image' => $this
          ->getPluginPath() . '/icons/tablecolumninsertbefore.png',
      ],
      'tablecolumninsertafter' => [
        'label' => $this
          ->t('Add column after current cell'),
        'image' => $this
          ->getPluginPath() . '/icons/tablecolumninsertafter.png',
      ],
      'tablecolumndelete' => [
        'label' => $this
          ->t('Delete column with current cell'),
        'image' => $this
          ->getPluginPath() . '/icons/tablecolumndelete.png',
      ],
      'tablecellinsertbefore' => [
        'label' => $this
          ->t('Add cell before current cell'),
        'image' => $this
          ->getPluginPath() . '/icons/tablecellinsertbefore.png',
      ],
      'tablecellinsertafter' => [
        'label' => $this
          ->t('Add cell after current cell'),
        'image' => $this
          ->getPluginPath() . '/icons/tablecellinsertafter.png',
      ],
      'tablecelldelete' => [
        'label' => $this
          ->t('Delete current cell'),
        'image' => $this
          ->getPluginPath() . '/icons/tablecelldelete.png',
      ],
      'tablecellproperties' => [
        'label' => $this
          ->t('Show dialog with current cell properties'),
        'image' => $this
          ->getPluginPath() . '/icons/tablecellproperties.png',
      ],
      'tablecellsmerge' => [
        'label' => $this
          ->t('Merge selected cells'),
        'image' => $this
          ->getPluginPath() . '/icons/tablecellsmerge.png',
      ],
      'tablecellmergeright' => [
        'label' => $this
          ->t('Merge current cell with right cell'),
        'image' => $this
          ->getPluginPath() . '/icons/tablecellmergeright.png',
      ],
      'tablecellmergedown' => [
        'label' => $this
          ->t('Merge current cell with down cell'),
        'image' => $this
          ->getPluginPath() . '/icons/tablecellmergedown.png',
      ],
      'tablecellsplithorizontal' => [
        'label' => $this
          ->t('Split horizontal current cell'),
        'image' => $this
          ->getPluginPath() . '/icons/tablecellsplithorizontal.png',
      ],
      'tablecellsplitvertical' => [
        'label' => $this
          ->t('Split vertical current cell'),
        'image' => $this
          ->getPluginPath() . '/icons/tablecellsplitvertical.png',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getConfig(Editor $editor) {
    return [];
  }

  /**
   * Return ckeditor tabletoolstoolbar plugin path relative to drupal root.
   *
   * @return string
   *   Relative path to the ckeditor plugin folder
   */
  private function getPluginPath() {
    return 'libraries/tabletoolstoolbar';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CKEditorPluginBase::$moduleList	protected	property	The module list service.
CKEditorPluginBase::getDependencies	public	function	Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface::getDependencies	1
CKEditorPluginBase::getModuleList	protected	function	Gets the module list service.
CKEditorPluginBase::getModulePath	protected	function	Gets the Drupal-root relative installation directory of a module.
CKEditorPluginBase::isInternal	public	function	Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface::isInternal	4
CkeditorTableToolsToolbar::getButtons	public	function	Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface::getButtons
CkeditorTableToolsToolbar::getConfig	public	function	Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface::getConfig
CkeditorTableToolsToolbar::getFile	public	function	Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface::getFile
CkeditorTableToolsToolbar::getLibraries	public	function	Returns a list of libraries this plugin requires. Overrides CKEditorPluginBase::getLibraries
CkeditorTableToolsToolbar::getPluginPath	private	function	Return ckeditor tabletoolstoolbar plugin path relative to drupal root.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	98
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.