Package com.storedobject.vaadin

Interface HTMLGenerator

All Known Subinterfaces:

GridCellText, StyledBuilder

All Known Implementing Classes:

Alert, CSVUploadProcessorView, ELabel, ELabelField, ELabels, ExcelDataUpload, HTMLText, ProcessView, StyledString, StyledText, TextView, UploadProcessorView, ZipUploadProcessorView

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface HTMLGenerator

An interface that generate HTML text.

Author:

Syam

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	CHAR_ENTITIES	HTML character entities

Method Summary

Modifier and Type	Method	Description
static String	encodeHTML(String string)	Encode a string so that HTML character entities and newline characters are properly replaced.
String	getHTML()	Get the HTML text generated.
default Object	getPrintText()	Get a printable object that can be used for creating a printable representation of the HTML text.

Field Details

CHAR_ENTITIES

static final String[] CHAR_ENTITIES

HTML character entities

Method Details

getHTML

String getHTML()

Get the HTML text generated. (The generated HTML may not contain outer tags. So, span or div tag may be used to bracket it in order to make it a valid HTML text).

Returns:

HTML text generated.

getPrintText

default Object getPrintText()

Get a printable object that can be used for creating a printable representation of the HTML text.

Returns:

The default implementation returns the HTML text getHTML() returns after handling line-breaks and simple ampersand coded characters.

encodeHTML

static String encodeHTML(String string)

Encode a string so that HTML character entities and newline characters are properly replaced.

Parameters:

string - String to encode

Returns:

Encoded string.