Package com.storedobject.common

Class HTMLText

java.lang.Object

com.storedobject.common.HTMLText

All Implemented Interfaces:

StyledBuilder

Direct Known Subclasses:

ErrorText, HTMLText

public class HTMLText
extends Object
implements StyledBuilder

Build HTML text.

Author:

Syam

Nested Class Summary

Nested classes/interfaces inherited from interface com.storedobject.common.StyledBuilder

StyledBuilder.Style

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	ALLOW_TOP_LEVEL	A flag indicating whether top-level HTML elements such as html, body, and `head are allowed while building HTML content.
protected final StringBuilder	value	A StringBuilder instance that serves as the primary container for constructing and managing the internal content of this HTMLText object.

Fields inherited from interface com.storedobject.common.StyledBuilder

EMPTY_STRINGS

Constructor Summary

Constructors

Constructor	Description
HTMLText()	Constructor.
HTMLText(Object object)	Constructor.
HTMLText(Object object, StyledBuilder.Style... style)	Constructor.
HTMLText(Object object, String... style)	Constructor.

Method Summary

Modifier and Type	Method	Description
HTMLText	append(Object object)	Append an object.
HTMLText	append(Object object, StyledBuilder.Style... styles)	Append an object with the given style.
HTMLText	append(Object object, String color)	Append an object with the given color.
HTMLText	append(Object object, String... style)	Append an object with the given style.
HTMLText	appendHTML(String html)	Appends the provided HTML string to the current content.
HTMLText	clear()	Clear the content.
HTMLText	clearContent()	Clear the content.
HTMLText	drawLine()	Append a line using the tag.
static String	encode(Object object)	Encode an object as an HTML string.
StringBuilder	getText()	Get the current text of the HTML.
static boolean	isAllowTopLevelHTML()	Whether top-level HTML elements are allowed or not.
boolean	isEmpty()	Check if the content is empty or not.
boolean	isNewLine()	Check if the last add was a new line or not.
HTMLText	newLine()	Adds a new line.
HTMLText	newLine(boolean force)	Adds a new line.
static void	setAllowTopLevelHTML()	If this method is invoked ever, top-leve HTML elements will be allowed while building the HTML content.
void	setText(String text, String... style)	Set text.
HTMLText	space(int count)	Add spaces.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.common.StyledBuilder

setValue, setValue, setValue, update

Field Details

ALLOW_TOP_LEVEL

public static boolean ALLOW_TOP_LEVEL

A flag indicating whether top-level HTML elements such as html, body, and `head are allowed while building HTML content. When set to `true`, top-level elements can be included in the content, which may introduce unexpected modifications to the surrounding HTML structure. By default, this is set to `false` to ensure that only valid inner HTML content is added without altering the top-level structure.

value

protected final StringBuilder value

A StringBuilder instance that serves as the primary container for constructing and managing the internal content of this HTMLText object. This field is used to build and store the current state of the HTML content being generated.

• The value is marked as protected to allow access within the class, subclasses, and classes in the same package.
• The final modifier ensures that the reference to the StringBuilder cannot be changed once it has been initialized, maintaining data consistency.

Constructor Details

HTMLText

public HTMLText()

Constructor.

HTMLText

public HTMLText(Object object,
 String... style)

Constructor.

Parameters:

object - Object to be added.

style - Styles to be set.

HTMLText

public HTMLText(Object object,
 StyledBuilder.Style... style)

Constructor.

Parameters:

object - Object to be added.

style - Styles to be set.

HTMLText

public HTMLText(Object object)

Constructor.

Parameters:

object - Object to be added.

Method Details

toString

public String toString()

Overrides:

toString in class Object

getText

public StringBuilder getText()

Get the current text of the HTML.

Returns:

Current text.

setText

public void setText(String text,
 String... style)

Set text.

Parameters:

text - Text to be set.

style - Style to be applied.

encode

public static String encode(Object object)

Encode an object as an HTML string. (The string representation of the object is encoded).

Parameters:

object - Object to be encoded.

Returns:

Encoded string.

newLine

public HTMLText newLine(boolean force)

Description copied from interface: StyledBuilder

Adds a new line.

Specified by:

newLine in interface StyledBuilder

Parameters:

force - If true, a new line is added anyway. Otherwise, no new line should be added if StyledBuilder.isNewLine() returns false.

Returns:

Self-reference is returned.

newLine

public HTMLText newLine()

Description copied from interface: StyledBuilder

Adds a new line. (Default implementation doesn't force a new line).

Specified by:

newLine in interface StyledBuilder

Returns:

Self-reference is returned.

drawLine

public HTMLText drawLine()

Append a line using the tag.

Returns:

Self-reference is returned.

append

public HTMLText append(Object object,
 String color)

Description copied from interface: StyledBuilder

Append an object with the given color.

Specified by:

append in interface StyledBuilder

Parameters:

object - Object to append.

color - Color to be set. (Default implementation ignores this).

Returns:

Self-reference is returned.

append

public HTMLText append(Object object,
 String... style)

Description copied from interface: StyledBuilder

Append an object with the given style.

Specified by:

append in interface StyledBuilder

Parameters:

object - Object to append.

style - Styles to be set. (Default implementation ignores this).

Returns:

Self-reference is returned.

append

public HTMLText append(Object object,
 StyledBuilder.Style... styles)

Description copied from interface: StyledBuilder

Append an object with the given style. Default implementation ignores styles.

Specified by:

append in interface StyledBuilder

Parameters:

object - Object to append.

styles - Styles to be set.

Returns:

Self-reference is returned.

appendHTML

public HTMLText appendHTML(String html)

Appends the provided HTML string to the current content. If the HTML string contains top-level elements such as HTML, BODY, HEAD, SCRIPT, or STYLE, an exception will be thrown unless top-level HTML elements are explicitly allowed.

Parameters:

html - The HTML string to be appended.

Returns:

The current instance of HTMLText for method chaining.

Throws:

SORuntimeException - If the HTML contains top-level elements or prohibited tags and top-level HTML is not allowed.

clearContent

public HTMLText clearContent()

Description copied from interface: StyledBuilder

Clear the content.

Specified by:

clearContent in interface StyledBuilder

Returns:

Self-reference is returned.

clear

public HTMLText clear()

Clear the content.

Returns:

Self-reference is returned.

isEmpty

public boolean isEmpty()

Description copied from interface: StyledBuilder

Check if the content is empty or not.

Specified by:

isEmpty in interface StyledBuilder

Returns:

True or false.

isNewLine

public boolean isNewLine()

Description copied from interface: StyledBuilder

Check if the last add was a new line or not.

Specified by:

isNewLine in interface StyledBuilder

Returns:

True/false

space

public HTMLText space(int count)

Add spaces.

Parameters:

count - Number of spaces to be added.

Returns:

Self-reference is returned.

append

public HTMLText append(Object object)

Description copied from interface: StyledBuilder

Append an object.

Specified by:

append in interface StyledBuilder

Parameters:

object - Object to append.

Returns:

Self-reference is returned.

setAllowTopLevelHTML

public static void setAllowTopLevelHTML()

If this method is invoked ever, top-leve HTML elements will be allowed while building the HTML content. This could cause unexpected changes to the existing HTML on the page.

isAllowTopLevelHTML

public static boolean isAllowTopLevelHTML()

Whether top-level HTML elements are allowed or not.

Returns:

True/false.