org.openlowcode.tools.richtext

Class RichText

java.lang.Object

org.openlowcode.tools.richtext.RichText

public class RichText
extends java.lang.Object

A rich-text is an element of text with formatting on sections of text. Formatting includes the following options (with the codes):

• B: bold
• I: italic
• CFF0000: color with the color precised in RGB hexa (here full red, no green or blue)
• P: bullet point
• T: section title

To enter rich text, you should add tabs between share brackets with the style precised (or nothing if you want to display as standard). There can be several styles. Example: "This is a word with an [BCFF0000]highlighted[] word. If you need to enter opening curly bracket, you have to double it (e.g. "The formula [[x=y] is not correct" will display on screen 'The formula [x=y] is not correct.

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
RichText(java.lang.String richtext) creates a rich text with the given input

Method Summary

Modifier and Type	Method and Description
static java.lang.String	escapetoHTML(java.lang.String input)
Paragraph[]	generateAllParagraphs(boolean editable, RichTextArea parent) generates all paragraphes in this rich text.
java.lang.String	generateHtmlString() generates an HTML representation of this rich text
java.lang.String	generatePlainString() this method generates a plain text representation of the rich text for display in places where rich text cannot be displayed

Methods inherited from class java.lang.Object

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

Constructor Detail

RichText

public RichText(java.lang.String richtext)

creates a rich text with the given input

Parameters:

richtext - the rich text as encoded

Method Detail

generateAllParagraphs

public Paragraph[] generateAllParagraphs(boolean editable,
                                         RichTextArea parent)

generates all paragraphes in this rich text. This method should only be called on the client with javafx package in the classpath. The rest of rich text class can be used on the server without javafx

Parameters:

editable - true if editable

parent - parent rich text area (widget)

Returns:

a list of paragraphs

generatePlainString

public java.lang.String generatePlainString()

this method generates a plain text representation of the rich text for display in places where rich text cannot be displayed

Returns:

a plain string representation

generateHtmlString

public java.lang.String generateHtmlString()

generates an HTML representation of this rich text

Returns:

text in html

escapetoHTML

public static java.lang.String escapetoHTML(java.lang.String input)

Parameters:

input -

Returns: