Class CKEditorConfig.StyleDefinition

java.lang.Object

com.wontlost.ckeditor.CKEditorConfig.StyleDefinition

Enclosing class:

CKEditorConfig

public static class CKEditorConfig.StyleDefinition
extends Object

Style definition for the Style plugin. Defines a style that applies CSS classes to HTML elements.

Usage example:

config.setStyle(
    // Block styles (applied to block elements like p, h2, blockquote)
    StyleDefinition.block("Info box", "p", "info-box"),
    StyleDefinition.block("Big heading", "h2", "big-heading"),
    StyleDefinition.block("Side quote", "blockquote", "side-quote"),
    // Inline styles (applied to inline elements like span)
    StyleDefinition.inline("Marker", "marker"),
    StyleDefinition.inline("Typewriter", "typewriter"),
    StyleDefinition.inline("Spoiler", "spoiler")
);

Constructor Summary

Constructors

Constructor	Description
StyleDefinition(String name, String element, String... classes)	Create a style definition

Method Summary

Modifier and Type	Method	Description
static CKEditorConfig.StyleDefinition	block(String name, String element, String... classes)	Create a block style definition.
static CKEditorConfig.StyleDefinition	codeBlock(String name, String... classes)	Create a code block style definition.
String[]	getClasses()	Get the CSS classes
String	getElement()	Get the HTML element
String	getName()	Get the style name
static CKEditorConfig.StyleDefinition	inline(String name, String... classes)	Create an inline style definition.
tools.jackson.databind.node.ObjectNode	toJson()	Convert to JSON for CKEditor configuration

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StyleDefinition

public StyleDefinition(String name,
 String element,
 String... classes)

Create a style definition

Parameters:

name - display name shown in the dropdown

element - HTML element to apply style to (e.g., "p", "h2", "span", "blockquote")

classes - CSS classes to apply

Method Details

block

public static CKEditorConfig.StyleDefinition block(String name,
 String element,
 String... classes)

Create a block style definition. Block styles are applied to block-level elements like paragraphs, headings, blockquotes.

Parameters:

name - display name

element - block element (e.g., "p", "h2", "h3", "blockquote", "pre")

classes - CSS classes to apply

Returns:

style definition

inline

public static CKEditorConfig.StyleDefinition inline(String name,
 String... classes)

Create an inline style definition. Inline styles are applied to text using span elements.

Parameters:

name - display name

classes - CSS classes to apply to span element

Returns:

style definition

codeBlock

public static CKEditorConfig.StyleDefinition codeBlock(String name,
 String... classes)

Create a code block style definition.

Parameters:

name - display name

classes - CSS classes to apply to pre element

Returns:

style definition

getName

public String getName()

Get the style name

getElement

public String getElement()

Get the HTML element

getClasses

public String[] getClasses()

Get the CSS classes

toJson

public tools.jackson.databind.node.ObjectNode toJson()

Convert to JSON for CKEditor configuration