Package com.storedobject.common

Interface StyledBuilder

All Known Subinterfaces:

GridCellText, StyledBuilder

All Known Implementing Classes:

Alert, CSVUploadProcessorView, ELabel, ELabelField, ELabels, ErrorText, ExcelDataUpload, HTMLText, HTMLText, PDF.Text, ProcessView, StyledString, StyledString, TextView, TransactionControl, UploadProcessorView, ZipUploadProcessorView

public interface StyledBuilder

Build something with "styles".

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	StyledBuilder.Style	Representation of HTML style.

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	EMPTY_STRINGS

Method Summary

Modifier and Type	Method	Description
StyledBuilder	append(Object object)	Append an object.
default StyledBuilder	append(Object object, StyledBuilder.Style... styles)	Append an object with the given style.
default StyledBuilder	append(Object object, String color)	Append an object with the given color.
default StyledBuilder	append(Object object, String... styles)	Append an object with the given style.
static void	apply(String styles, Consumer<StyledBuilder.Style> element)	Apply styles to a consumer.
StyledBuilder	clearContent()	Clear the content.
boolean	isEmpty()	Check if the content is empty or not.
boolean	isNewLine()	Check if the last add was a new line or not.
default StyledBuilder	newLine()	Adds a new line.
StyledBuilder	newLine(boolean forceIt)	Adds a new line.
default void	setValue(Object object)	Set a value.
default void	setValue(Object object, StyledBuilder.Style... styles)	Set a value with the given styles.
default void	setValue(Object object, String... styles)	Set a value with the given styles.
default StyledBuilder	update()	Update internals if required.

Field Details

EMPTY_STRINGS

static final String[] EMPTY_STRINGS

Method Details

append

StyledBuilder append(Object object)

Append an object.

Parameters:

object - Object to append.

Returns:

Self-reference is returned.

append

default StyledBuilder append(Object object,
 String color)

Append an object with the given color.

Parameters:

object - Object to append.

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

Returns:

Self-reference is returned.

setValue

default void setValue(Object object)

Set a value. (Previous content if any will be cleared).

Parameters:

object - Object (value) to set.

setValue

default void setValue(Object object,
 String... styles)

Set a value with the given styles. (Previous content if any will be cleared).

Parameters:

object - Object (value) to set.

styles - Styles to be set.

setValue

default void setValue(Object object,
 StyledBuilder.Style... styles)

Set a value with the given styles. (Previous content if any will be cleared).

Parameters:

object - Object (value) to set.

styles - Styles to be set.

append

default StyledBuilder append(Object object,
 String... styles)

Append an object with the given style.

Parameters:

object - Object to append.

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

Returns:

Self-reference is returned.

append

default StyledBuilder append(Object object,
 StyledBuilder.Style... styles)

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

Parameters:

object - Object to append.

styles - Styles to be set.

Returns:

Self-reference is returned.

isEmpty

boolean isEmpty()

Check if the content is empty or not.

Returns:

True or false.

newLine

default StyledBuilder newLine()

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

Returns:

Self-reference is returned.

newLine

StyledBuilder newLine(boolean forceIt)

Adds a new line.

Parameters:

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

Returns:

Self-reference is returned.

isNewLine

boolean isNewLine()

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

Returns:

True/false

update

default StyledBuilder update()

Update internals if required. (Default implementation does nothing).

Returns:

Self-reference is returned.

clearContent

StyledBuilder clearContent()

Clear the content.

Returns:

Self-reference is returned.

apply

static void apply(String styles,
 Consumer<StyledBuilder.Style> element)

Apply styles to a consumer.

Parameters:

styles - Styles text. It will be parsed create styles.

element - Element that accepts the styles.