This class triggers the installation of the {@code ckeditor5-premium-features} npm package * when referenced in your application. Premium features require a valid license key from * ckeditor.com/pricing.
* *
* // Step 1: Enable premium features (call once at application startup)
* VaadinCKEditorPremium.enable();
*
* // Step 2: Use premium plugins in your editor
* VaadinCKEditor editor = VaadinCKEditor.create()
* .withPreset(CKEditorPreset.FULL)
* .withLicenseKey("your-license-key") // Required for premium features
* .addCustomPlugin(CustomPlugin.fromPremium("ExportPdf"))
* .addCustomPlugin(CustomPlugin.fromPremium("ExportWord"))
* .addCustomPlugin(CustomPlugin.fromPremium("FormatPainter"))
* .withToolbar("exportPdf", "exportWord", "formatPainter", "|", "bold", "italic")
* .build();
*
*
* | Plugin | Toolbar Item | Description |
|---|---|---|
| ExportPdf | exportPdf | Export content to PDF |
| ExportWord | exportWord | Export content to Word (DOCX) |
| ImportWord | importWord | Import Word documents |
| FormatPainter | formatPainter | Copy and apply formatting |
| CaseChange | caseChange | Change text case |
| SlashCommand | - | Slash command menu (type /) |
| TableOfContents | tableOfContents | Auto-generated TOC |
| DocumentOutline | - | Document structure outline |
| Template | insertTemplate | Content templates |
| MergeFields | insertMergeField | Mail merge fields |
| Pagination | - | Page breaks and pagination |
| AIAssistant | aiCommands, aiAssistant | AI-powered writing assistant (deprecated, use modular AI plugins) |
| AIChat | toggleAi | AI chat sidebar panel (v47.5.0+) |
| AIEditorIntegration | - | AI editor integration core (v47.5.0+) |
| AIQuickActions | aiQuickActions | AI quick actions on text selection (v47.5.0+) |
| AIReviewMode | - | AI review mode (v47.5.0+) |
| AITranslate | - | AI translation (v47.5.0+) |
| Comments | comment | Inline commenting |
| TrackChanges | trackChanges | Track document changes |
| RevisionHistory | revisionHistory | Version history |
| LineHeight | lineHeight | Line height adjustment |
| EmailConfigurationHelper | - | Email editor configuration optimizer (v47.5.0+) |
| SourceEditingEnhanced | sourceEditingEnhanced | Enhanced source editing with HTML validation (v47.5.0+) |
| ExportInlineStyles | - | Inline style export for email compatibility (v47.5.0+) |
| TableLayout | insertTableLayout | Predefined table layout templates (v47.5.0+) |
Premium features require a commercial license. You can:
*
* // Recommended: Load license key from environment
* String licenseKey = System.getenv("CKEDITOR_LICENSE_KEY");
* editor.withLicenseKey(licenseKey);
*
*
* @see VaadinCKEditor
* @see CustomPlugin#fromPremium(String)
* @since 5.0.0
*/
@NpmPackage(value = "ckeditor5-premium-features", version = "48.1.1")
public final class VaadinCKEditorPremium {
private static volatile boolean enabled = false;
/**
* Private constructor to prevent instantiation.
*/
private VaadinCKEditorPremium() {
// Utility class
}
/**
* Ensures the premium npm package is included in the Vaadin build.
*
* The actual npm installation is handled by the {@code @NpmPackage} annotation on this * class. Calling this method forces the class to be loaded, which makes Vaadin's * annotation scanner pick up the annotation. Without this call the class may be * pruned by dead-code elimination since nothing else references it.
* *This method is idempotent - calling it multiple times has no additional effect.
* *
* @SpringBootApplication
* public class Application implements AppShellConfigurator {
* public static void main(String[] args) {
* VaadinCKEditorPremium.enable(); // Trigger class loading for @NpmPackage
* SpringApplication.run(Application.class, args);
* }
* }
*
*
* @return {@code true} if this call enabled premium features, {@code false} if already enabled
*/
public static boolean enable() {
if (!enabled) {
synchronized (VaadinCKEditorPremium.class) {
if (!enabled) {
enabled = true;
return true;
}
}
}
return false;
}
/**
* Checks if premium features have been enabled.
*
* @return {@code true} if {@link #enable()} has been called, {@code false} otherwise
*/
public static boolean isEnabled() {
return enabled;
}
/**
* Resets the enabled state. Visible for testing only.
*/
static synchronized void resetForTesting() {
enabled = false;
}
/**
* Returns the version of the ckeditor5-premium-features package.
*
* @return the npm package version
*/
public static String getVersion() {
return "48.1.1";
}
/**
* Enumeration of all available premium plugins.
*
* Use with {@link CustomPlugin#fromPremium(String)} to add premium plugins to your editor.
*/ public enum PremiumPlugin { /** * Export content to PDF format. */ EXPORT_PDF("ExportPdf", "exportPdf"), /** * Export content to Word (DOCX) format. */ EXPORT_WORD("ExportWord", "exportWord"), /** * Import Word documents into the editor. */ IMPORT_WORD("ImportWord", "importWord"), /** * Enhanced paste from Office documents with advanced formatting preservation. */ PASTE_FROM_OFFICE_ENHANCED("PasteFromOfficeEnhanced"), /** * Copy and apply text formatting. */ FORMAT_PAINTER("FormatPainter", "formatPainter"), /** * Change text case (upper, lower, title). */ CASE_CHANGE("CaseChange", "caseChange"), /** * Slash command menu for quick actions. * Triggered by typing "/" in the editor. */ SLASH_COMMAND("SlashCommand"), /** * Auto-generated table of contents. */ TABLE_OF_CONTENTS("TableOfContents", "tableOfContents"), /** * Document structure outline panel. */ DOCUMENT_OUTLINE("DocumentOutline"), /** * Content templates for quick insertion. */ TEMPLATE("Template", "insertTemplate"), /** * Mail merge fields for personalized content. */ MERGE_FIELDS("MergeFields", "insertMergeField"), /** * Page breaks and pagination support (A4/Letter page layout). */ PAGINATION("Pagination", "pagination"), /** * AI-powered writing assistant (bundled). * @deprecated Since CKEditor 47.5.0, use modular AI plugins instead: * {@link #AI_CHAT}, {@link #AI_EDITOR_INTEGRATION}, {@link #AI_QUICK_ACTIONS}, * {@link #AI_REVIEW_MODE}, {@link #AI_TRANSLATE}. */ @Deprecated AI_ASSISTANT("AIAssistant", "aiCommands", "aiAssistant"), /** AI 聊天侧栏面板（v47.5.0+） */ AI_CHAT("AIChat", "toggleAi"), /** AI 编辑器集成，核心 AI 功能，无 toolbar（v47.5.0+） */ AI_EDITOR_INTEGRATION("AIEditorIntegration"), /** AI 快捷操作，选中文本弹出（v47.5.0+） */ AI_QUICK_ACTIONS("AIQuickActions", "aiQuickActions"), /** AI 审阅模式（v47.5.0+） */ AI_REVIEW_MODE("AIReviewMode"), /** AI 翻译（v47.5.0+） */ AI_TRANSLATE("AITranslate"), /** * Inline commenting and discussions. */ COMMENTS("Comments", "comment"), /** * Track changes in documents. */ TRACK_CHANGES("TrackChanges", "trackChanges"), /** * Track changes data integration (process data without showing suggestions UI). */ TRACK_CHANGES_DATA("TrackChangesData"), /** * Track changes preview (accept/reject all changes preview). */ TRACK_CHANGES_PREVIEW("TrackChangesPreview"), /** * Revision history and version management. */ REVISION_HISTORY("RevisionHistory", "revisionHistory"), /** * Real-time collaborative editing (meta plugin). */ REAL_TIME_COLLABORATION("RealTimeCollaboration"), /** * Real-time collaborative editing (individual plugin). */ REAL_TIME_COLLABORATIVE_EDITING("RealTimeCollaborativeEditing"), /** * Real-time collaborative comments sync. */ REAL_TIME_COLLABORATIVE_COMMENTS("RealTimeCollaborativeComments"), /** * Real-time collaborative track changes sync. */ REAL_TIME_COLLABORATIVE_TRACK_CHANGES("RealTimeCollaborativeTrackChanges"), /** * Real-time collaborative revision history sync. */ REAL_TIME_COLLABORATIVE_REVISION_HISTORY("RealTimeCollaborativeRevisionHistory"), /** * Presence list showing active collaborators. */ PRESENCE_LIST("PresenceList"), /** * Multi-level list formatting (nested lists with different styles). */ MULTI_LEVEL_LIST("MultiLevelList", "multiLevelList"), /** * Line height adjustment for paragraphs. */ LINE_HEIGHT("LineHeight", "lineHeight"), /** 邮件编辑器配置优化助手（v47.5.0+） */ EMAIL_CONFIGURATION_HELPER("EmailConfigurationHelper"), /** 增强版源代码编辑（带 HTML 验证，v47.5.0+） */ SOURCE_EDITING_ENHANCED("SourceEditingEnhanced", "sourceEditingEnhanced"), /** 内联样式导出（邮件客户端兼容性必需，v47.5.0+） */ EXPORT_INLINE_STYLES("ExportInlineStyles"), /** 表格布局选项（预设表格布局模板，premium，v47.5.0+） */ TABLE_LAYOUT("TableLayout", "insertTableLayout"); private final String pluginName; private final String[] toolbarItems; PremiumPlugin(String pluginName, String... toolbarItems) { this.pluginName = pluginName; this.toolbarItems = toolbarItems; } /** * Returns the CKEditor plugin class name. * * @return the plugin name as used in CKEditor configuration */ public String getPluginName() { return pluginName; } /** * Returns the toolbar items provided by this plugin. * * @return array of toolbar item names, or empty array if none */ public String[] getToolbarItems() { return toolbarItems.clone(); } /** * Creates a CustomPlugin instance for this premium plugin. * * @return a configured CustomPlugin ready to add to the editor */ public CustomPlugin toCustomPlugin() { CustomPlugin.Builder builder = CustomPlugin.builder(pluginName).premium(); if (toolbarItems.length > 0) { builder.withToolbarItems(toolbarItems); } return builder.build(); } } }