Enum Class CKEditorPlugin

java.lang.Object
java.lang.Enum<CKEditorPlugin>
com.wontlost.ckeditor.CKEditorPlugin
All Implemented Interfaces:
Serializable, Comparable<CKEditorPlugin>, Constable
public enum CKEditorPlugin extends Enum<CKEditorPlugin>
CKEditor 5 official plugin enumeration. Each plugin corresponds to an export from the ckeditor5 npm package.

Usage example:

VaadinCKEditor.create()
    .withPlugins(CKEditorPlugin.BOLD, CKEditorPlugin.ITALIC, CKEditorPlugin.IMAGE)
    .build();

  • Enum Constant Details

    • ESSENTIALS

      public static final CKEditorPlugin ESSENTIALS
      Essential editing features (required)

    • PARAGRAPH

      public static final CKEditorPlugin PARAGRAPH
      Paragraph support (required)

    • UNDO

      public static final CKEditorPlugin UNDO
      Undo/Redo functionality

    • CLIPBOARD

      public static final CKEditorPlugin CLIPBOARD
      Clipboard support

    • TYPING

      public static final CKEditorPlugin TYPING
      Input handling

    • SELECT_ALL

      public static final CKEditorPlugin SELECT_ALL
      Select all content

    • BOLD

      public static final CKEditorPlugin BOLD
      Bold text

    • ITALIC

      public static final CKEditorPlugin ITALIC
      Italic text

    • UNDERLINE

      public static final CKEditorPlugin UNDERLINE
      Underlined text

    • STRIKETHROUGH

      public static final CKEditorPlugin STRIKETHROUGH
      Strikethrough text

    • CODE

      public static final CKEditorPlugin CODE
      Inline code

    • SUPERSCRIPT

      public static final CKEditorPlugin SUPERSCRIPT
      Superscript text

    • SUBSCRIPT

      public static final CKEditorPlugin SUBSCRIPT
      Subscript text

    • FONT_SIZE

      public static final CKEditorPlugin FONT_SIZE
      Font size control

    • FONT_FAMILY

      public static final CKEditorPlugin FONT_FAMILY
      Font family control

    • FONT_COLOR

      public static final CKEditorPlugin FONT_COLOR
      Font color

    • FONT_BACKGROUND_COLOR

      public static final CKEditorPlugin FONT_BACKGROUND_COLOR
      Background color

    • HEADING

      public static final CKEditorPlugin HEADING
      Headings

    • ALIGNMENT

      public static final CKEditorPlugin ALIGNMENT
      Text alignment

    • INDENT

      public static final CKEditorPlugin INDENT
      Indentation

    • INDENT_BLOCK

      public static final CKEditorPlugin INDENT_BLOCK
      Block indentation

    • BLOCK_QUOTE

      public static final CKEditorPlugin BLOCK_QUOTE
      Block quotes

    • LINE_HEIGHT

      public static final CKEditorPlugin LINE_HEIGHT
      Line height

    • LIST

      public static final CKEditorPlugin LIST
      Ordered/Unordered lists

    • TODO_LIST

      public static final CKEditorPlugin TODO_LIST
      To-do lists

    • IMAGE

      public static final CKEditorPlugin IMAGE
      Basic image support

    • IMAGE_TOOLBAR

      public static final CKEditorPlugin IMAGE_TOOLBAR
      Image toolbar

    • IMAGE_CAPTION

      public static final CKEditorPlugin IMAGE_CAPTION
      Image captions

    • IMAGE_STYLE

      public static final CKEditorPlugin IMAGE_STYLE
      Image styles

    • IMAGE_RESIZE

      public static final CKEditorPlugin IMAGE_RESIZE
      Image resizing

    • IMAGE_UPLOAD

      public static final CKEditorPlugin IMAGE_UPLOAD
      Image upload

    • IMAGE_INSERT

      public static final CKEditorPlugin IMAGE_INSERT
      Image insertion

    • IMAGE_BLOCK

      public static final CKEditorPlugin IMAGE_BLOCK
      Block images

    • IMAGE_INLINE

      public static final CKEditorPlugin IMAGE_INLINE
      Inline images

    • AUTO_IMAGE

      public static final CKEditorPlugin AUTO_IMAGE
      Auto-detect images from URLs

    • BASE64_UPLOAD_ADAPTER

      public static final CKEditorPlugin BASE64_UPLOAD_ADAPTER
      Base64 upload adapter

    • SIMPLE_UPLOAD_ADAPTER

      public static final CKEditorPlugin SIMPLE_UPLOAD_ADAPTER
      Simple upload adapter

    • TABLE

      public static final CKEditorPlugin TABLE
      Basic table support

    • TABLE_TOOLBAR

      public static final CKEditorPlugin TABLE_TOOLBAR
      Table toolbar

    • TABLE_PROPERTIES

      public static final CKEditorPlugin TABLE_PROPERTIES
      Table properties

    • TABLE_CELL_PROPERTIES

      public static final CKEditorPlugin TABLE_CELL_PROPERTIES
      Table cell properties

    • TABLE_CAPTION

      public static final CKEditorPlugin TABLE_CAPTION
      Table captions

    • TABLE_COLUMN_RESIZE

      public static final CKEditorPlugin TABLE_COLUMN_RESIZE
      Table column resizing

    • MEDIA_EMBED

      public static final CKEditorPlugin MEDIA_EMBED
      Embed media from URLs

    • HTML_EMBED

      public static final CKEditorPlugin HTML_EMBED
      Embed raw HTML

    • CODE_BLOCK

      public static final CKEditorPlugin CODE_BLOCK
      Code blocks

    • HORIZONTAL_LINE

      public static final CKEditorPlugin HORIZONTAL_LINE
      Horizontal lines

    • PAGE_BREAK

      public static final CKEditorPlugin PAGE_BREAK
      Page breaks

    • SPECIAL_CHARACTERS

      public static final CKEditorPlugin SPECIAL_CHARACTERS
      Special characters

    • SPECIAL_CHARACTERS_ESSENTIALS

      public static final CKEditorPlugin SPECIAL_CHARACTERS_ESSENTIALS
      Essential special character sets

    • AUTOFORMAT

      public static final CKEditorPlugin AUTOFORMAT
      Markdown-like autoformatting

    • TEXT_TRANSFORMATION

      public static final CKEditorPlugin TEXT_TRANSFORMATION
      Text transformations

    • FIND_AND_REPLACE

      public static final CKEditorPlugin FIND_AND_REPLACE
      Find and replace

    • REMOVE_FORMAT

      public static final CKEditorPlugin REMOVE_FORMAT
      Remove formatting

    • SOURCE_EDITING

      public static final CKEditorPlugin SOURCE_EDITING
      Source code editing

    • SHOW_BLOCKS

      public static final CKEditorPlugin SHOW_BLOCKS
      Show block elements

    • HIGHLIGHT

      public static final CKEditorPlugin HIGHLIGHT
      Text highlighting

    • MENTION

      public static final CKEditorPlugin MENTION

    • AUTOSAVE

      public static final CKEditorPlugin AUTOSAVE
      Autosave functionality

    • WORD_COUNT

      public static final CKEditorPlugin WORD_COUNT
      Word/character count

    • TITLE

      public static final CKEditorPlugin TITLE
      Document title placeholder

    • PASTE_FROM_OFFICE

      public static final CKEditorPlugin PASTE_FROM_OFFICE
      Paste from Office

    • GENERAL_HTML_SUPPORT

      public static final CKEditorPlugin GENERAL_HTML_SUPPORT
      General HTML support

    • HTML_COMMENT

      public static final CKEditorPlugin HTML_COMMENT
      HTML comments

    • STYLE

      public static final CKEditorPlugin STYLE
      Style attribute support - applies CSS classes to elements

    • RESTRICTED_EDITING_MODE

      public static final CKEditorPlugin RESTRICTED_EDITING_MODE
      Restricted editing mode

    • STANDARD_EDITING_MODE

      public static final CKEditorPlugin STANDARD_EDITING_MODE
      Standard editing mode

    • BOOKMARK

      public static final CKEditorPlugin BOOKMARK
      Anchor bookmarks for document navigation

    • FULLSCREEN

      public static final CKEditorPlugin FULLSCREEN
      Full-screen editing mode

    • MARKDOWN

      public static final CKEditorPlugin MARKDOWN
      Markdown GFM data processor

    • PASTE_FROM_MARKDOWN_EXPERIMENTAL

      public static final CKEditorPlugin PASTE_FROM_MARKDOWN_EXPERIMENTAL
      Paste from Markdown (experimental)

    • LIST_PROPERTIES

      public static final CKEditorPlugin LIST_PROPERTIES
      List start number, reversed, style type

    • LIST_FORMATTING

      public static final CKEditorPlugin LIST_FORMATTING
      Bold/italic/font in list markers

    • ADJACENT_LISTS_SUPPORT

      public static final CKEditorPlugin ADJACENT_LISTS_SUPPORT
      Merge adjacent lists

    • SPECIAL_CHARACTERS_ARROWS

      public static final CKEditorPlugin SPECIAL_CHARACTERS_ARROWS
      Arrow symbols

    • SPECIAL_CHARACTERS_CURRENCY

      public static final CKEditorPlugin SPECIAL_CHARACTERS_CURRENCY
      Currency symbols

    • SPECIAL_CHARACTERS_LATIN

      public static final CKEditorPlugin SPECIAL_CHARACTERS_LATIN
      Latin extended characters

    • SPECIAL_CHARACTERS_MATHEMATICAL

      public static final CKEditorPlugin SPECIAL_CHARACTERS_MATHEMATICAL
      Mathematical symbols

    • SPECIAL_CHARACTERS_TEXT

      public static final CKEditorPlugin SPECIAL_CHARACTERS_TEXT
      Text symbols

    • TEXT_PART_LANGUAGE

      public static final CKEditorPlugin TEXT_PART_LANGUAGE
      Multi-language text markup

    • CLOUD_SERVICES

      public static final CKEditorPlugin CLOUD_SERVICES
      CKEditor Cloud Services integration

    • CLOUD_SERVICES_CORE

      public static final CKEditorPlugin CLOUD_SERVICES_CORE
      Cloud Services core

    • CLOUD_SERVICES_UPLOAD_ADAPTER

      public static final CKEditorPlugin CLOUD_SERVICES_UPLOAD_ADAPTER
      Cloud Services upload adapter

    • EASY_IMAGE

      public static final CKEditorPlugin EASY_IMAGE
      Cloud-based image upload (requires CloudServices)

    • MINIMAP

      public static final CKEditorPlugin MINIMAP
      Content minimap for document navigation

    • WIDGET

      public static final CKEditorPlugin WIDGET
      Widget framework base

    • WIDGET_TOOLBAR_REPOSITORY

      public static final CKEditorPlugin WIDGET_TOOLBAR_REPOSITORY
      Widget toolbar management

    • WIDGET_RESIZE

      public static final CKEditorPlugin WIDGET_RESIZE
      Widget resizing

    • WIDGET_TYPE_AROUND

      public static final CKEditorPlugin WIDGET_TYPE_AROUND
      Widget type around navigation

    • EMOJI

      public static final CKEditorPlugin EMOJI
      Emoji picker and insertion

    • EMOJI_PICKER

      public static final CKEditorPlugin EMOJI_PICKER
      Visual emoji picker UI

  • Method Details

    • values

      public static CKEditorPlugin[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static CKEditorPlugin valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getJsName

      public String getJsName()
      Get the JavaScript plugin name

    • getCategory

      public CKEditorPlugin.Category getCategory()
      Get the plugin category

    • getToolbarItems

      public Set<String> getToolbarItems()
      Get toolbar items provided by this plugin

    • isPremium

      public boolean isPremium()
      Check if this is a premium feature (requires license). Note: All built-in plugins are free. Premium features require the ckeditor5-premium-features package and a license key. Use CustomPlugin to load premium plugins.
      Returns:
      always false for built-in plugins

    • getByCategory

      public static Set<CKEditorPlugin> getByCategory(CKEditorPlugin.Category category)
      Get all plugins in a category

    • fromJsName

      public static CKEditorPlugin fromJsName(String jsName)
      Find plugin by JavaScript name
      Parameters:
      jsName - JavaScript plugin name
      Returns:
      the corresponding plugin, or null if not found