Enum Class VaadinCKEditorPremium.PremiumPlugin

java.lang.Object

java.lang.Enum<VaadinCKEditorPremium.PremiumPlugin>

com.wontlost.ckeditor.VaadinCKEditorPremium.PremiumPlugin

All Implemented Interfaces:

Serializable, Comparable<VaadinCKEditorPremium.PremiumPlugin>, Constable

Enclosing class:

VaadinCKEditorPremium

public static enum VaadinCKEditorPremium.PremiumPlugin
extends Enum<VaadinCKEditorPremium.PremiumPlugin>

Enumeration of all available premium plugins.

Use with CustomPlugin.fromPremium(String) to add premium plugins to your editor.

Since:

5.0.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AI_ASSISTANT	AI-powered writing assistant.
CASE_CHANGE	Change text case (upper, lower, title).
COMMENTS	Inline commenting and discussions.
DOCUMENT_OUTLINE	Document structure outline panel.
EXPORT_PDF	Export content to PDF format.
EXPORT_WORD	Export content to Word (DOCX) format.
FORMAT_PAINTER	Copy and apply text formatting.
IMPORT_WORD	Import Word documents into the editor.
LINE_HEIGHT	Line height adjustment for paragraphs.
MERGE_FIELDS	Mail merge fields for personalized content.
MULTI_LEVEL_LIST	Multi-level list formatting (nested lists with different styles).
PAGINATION	Page breaks and pagination support (A4/Letter page layout).
PASTE_FROM_OFFICE_ENHANCED	Enhanced paste from Office documents with advanced formatting preservation.
PRESENCE_LIST	Presence list showing active collaborators.
REAL_TIME_COLLABORATION	Real-time collaborative editing (meta plugin).
REAL_TIME_COLLABORATIVE_COMMENTS	Real-time collaborative comments sync.
REAL_TIME_COLLABORATIVE_EDITING	Real-time collaborative editing (individual plugin).
REAL_TIME_COLLABORATIVE_REVISION_HISTORY	Real-time collaborative revision history sync.
REAL_TIME_COLLABORATIVE_TRACK_CHANGES	Real-time collaborative track changes sync.
REVISION_HISTORY	Revision history and version management.
SLASH_COMMAND	Slash command menu for quick actions.
TABLE_OF_CONTENTS	Auto-generated table of contents.
TEMPLATE	Content templates for quick insertion.
TRACK_CHANGES	Track changes in documents.
TRACK_CHANGES_DATA	Track changes data integration (process data without showing suggestions UI).
TRACK_CHANGES_PREVIEW	Track changes preview (accept/reject all changes preview).

Method Summary

Modifier and Type	Method	Description
String	getPluginName()	Returns the CKEditor plugin class name.
String[]	getToolbarItems()	Returns the toolbar items provided by this plugin.
CustomPlugin	toCustomPlugin()	Creates a CustomPlugin instance for this premium plugin.
static VaadinCKEditorPremium.PremiumPlugin	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VaadinCKEditorPremium.PremiumPlugin[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EXPORT_PDF

public static final VaadinCKEditorPremium.PremiumPlugin EXPORT_PDF

Export content to PDF format.

EXPORT_WORD

public static final VaadinCKEditorPremium.PremiumPlugin EXPORT_WORD

Export content to Word (DOCX) format.

IMPORT_WORD

public static final VaadinCKEditorPremium.PremiumPlugin IMPORT_WORD

Import Word documents into the editor.

PASTE_FROM_OFFICE_ENHANCED

public static final VaadinCKEditorPremium.PremiumPlugin PASTE_FROM_OFFICE_ENHANCED

Enhanced paste from Office documents with advanced formatting preservation.

FORMAT_PAINTER

public static final VaadinCKEditorPremium.PremiumPlugin FORMAT_PAINTER

Copy and apply text formatting.

CASE_CHANGE

public static final VaadinCKEditorPremium.PremiumPlugin CASE_CHANGE

Change text case (upper, lower, title).

SLASH_COMMAND

public static final VaadinCKEditorPremium.PremiumPlugin SLASH_COMMAND

Slash command menu for quick actions. Triggered by typing "/" in the editor.

TABLE_OF_CONTENTS

public static final VaadinCKEditorPremium.PremiumPlugin TABLE_OF_CONTENTS

Auto-generated table of contents.

DOCUMENT_OUTLINE

public static final VaadinCKEditorPremium.PremiumPlugin DOCUMENT_OUTLINE

Document structure outline panel.

TEMPLATE

public static final VaadinCKEditorPremium.PremiumPlugin TEMPLATE

Content templates for quick insertion.

MERGE_FIELDS

public static final VaadinCKEditorPremium.PremiumPlugin MERGE_FIELDS

Mail merge fields for personalized content.

PAGINATION

public static final VaadinCKEditorPremium.PremiumPlugin PAGINATION

Page breaks and pagination support (A4/Letter page layout).

AI_ASSISTANT

public static final VaadinCKEditorPremium.PremiumPlugin AI_ASSISTANT

AI-powered writing assistant.

COMMENTS

public static final VaadinCKEditorPremium.PremiumPlugin COMMENTS

Inline commenting and discussions.

TRACK_CHANGES

public static final VaadinCKEditorPremium.PremiumPlugin TRACK_CHANGES

Track changes in documents.

TRACK_CHANGES_DATA

public static final VaadinCKEditorPremium.PremiumPlugin TRACK_CHANGES_DATA

Track changes data integration (process data without showing suggestions UI).

TRACK_CHANGES_PREVIEW

public static final VaadinCKEditorPremium.PremiumPlugin TRACK_CHANGES_PREVIEW

Track changes preview (accept/reject all changes preview).

REVISION_HISTORY

public static final VaadinCKEditorPremium.PremiumPlugin REVISION_HISTORY

Revision history and version management.

REAL_TIME_COLLABORATION

public static final VaadinCKEditorPremium.PremiumPlugin REAL_TIME_COLLABORATION

Real-time collaborative editing (meta plugin).

REAL_TIME_COLLABORATIVE_EDITING

public static final VaadinCKEditorPremium.PremiumPlugin REAL_TIME_COLLABORATIVE_EDITING

Real-time collaborative editing (individual plugin).

REAL_TIME_COLLABORATIVE_COMMENTS

public static final VaadinCKEditorPremium.PremiumPlugin REAL_TIME_COLLABORATIVE_COMMENTS

Real-time collaborative comments sync.

REAL_TIME_COLLABORATIVE_TRACK_CHANGES

public static final VaadinCKEditorPremium.PremiumPlugin REAL_TIME_COLLABORATIVE_TRACK_CHANGES

Real-time collaborative track changes sync.

REAL_TIME_COLLABORATIVE_REVISION_HISTORY

public static final VaadinCKEditorPremium.PremiumPlugin REAL_TIME_COLLABORATIVE_REVISION_HISTORY

Real-time collaborative revision history sync.

PRESENCE_LIST

public static final VaadinCKEditorPremium.PremiumPlugin PRESENCE_LIST

Presence list showing active collaborators.

MULTI_LEVEL_LIST

public static final VaadinCKEditorPremium.PremiumPlugin MULTI_LEVEL_LIST

Multi-level list formatting (nested lists with different styles).

LINE_HEIGHT

public static final VaadinCKEditorPremium.PremiumPlugin LINE_HEIGHT

Line height adjustment for paragraphs.

Method Details

values

public static VaadinCKEditorPremium.PremiumPlugin[] 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 VaadinCKEditorPremium.PremiumPlugin 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

getPluginName

public String getPluginName()

Returns the CKEditor plugin class name.

Returns:

the plugin name as used in CKEditor configuration

getToolbarItems

public String[] getToolbarItems()

Returns the toolbar items provided by this plugin.

Returns:

array of toolbar item names, or empty array if none

toCustomPlugin

public CustomPlugin toCustomPlugin()

Creates a CustomPlugin instance for this premium plugin.

Returns:

a configured CustomPlugin ready to add to the editor