io.wcm.handler.richtext

Interface RichTextHandler

public interface RichTextHandler

Manages XHTML rich text fragment formatting. The rich text fragments are produced with CQ5 Rich Edit control.

Method Summary

Methods

Modifier and Type	Method and Description
void	addContent(String text, org.jdom2.Element parent) Adds rich text content to given HTML element.
void	addContent(String text, org.jdom2.Element parent, boolean supressParsingError) Adds rich text content to given HTML element.
void	addPlaintextContent(String text, org.jdom2.Element parent) Add multi line plain text to parent element.
List<org.jdom2.Content>	getContent(String text) Gets rich text content as DOM elements.
boolean	isEmpty(String text) Check if the given formatted text block is empty.

Method Detail

addContent

void addContent(String text,
              org.jdom2.Element parent)
                throws org.jdom2.JDOMException

Adds rich text content to given HTML element.

Parameters:

text - XHTML text string (root element not needed)

parent - Parent HTML element

Throws:

org.jdom2.JDOMException - Is thrown if the text could not be parsed as XHTML

addContent

void addContent(String text,
              org.jdom2.Element parent,
              boolean supressParsingError)

Adds rich text content to given HTML element.

Parameters:

text - XHTML text string (root element not needed)

parent - Parent HTML element

supressParsingError - If set to true, parsing errors (JDOMExceptions) are suppressed, and logged only in debug mode. Otherwise the JDOMException is wrapped in a IllegalArgumentException and thrown again.

Throws:

IllegalArgumentException - Is thrown if the text cannot be parsed, and pSuppressParsingError is not set to true

addPlaintextContent

void addPlaintextContent(String text,
                       org.jdom2.Element parent)

Add multi line plain text to parent element. Splits text by \n and inserts a HTML break for each newline.

Parameters:

text - Multiline text

parent - Parent HTML element

getContent

List<org.jdom2.Content> getContent(String text)
                                   throws org.jdom2.JDOMException

Gets rich text content as DOM elements.

Parameters:

text - XHTML text string (root element not needed)

Returns:

List of content DOM elements

Throws:

org.jdom2.JDOMException - Is thrown if the text could not be parsed as XHTML

isEmpty

boolean isEmpty(String text)

Check if the given formatted text block is empty. A text block containing only one paragraph element and whitespaces is considered as empty. A text block with more than 20 characters (raw data) is never considered as empty.

Parameters:

text - XHTML text string (root element not needed)

Returns:

true if text block is empty