org.ujorm.tools.web

Class Element

java.lang.Object

org.ujorm.tools.web.Element

All Implemented Interfaces:

Closeable, AutoCloseable, Html, ApiElement<Element>

public final class Element
extends Object
implements ApiElement<Element>, Html

A HTML Element implements some methods for frequently used elements and attributes A proxy class in the current release

See Also:

HtmlElement.of(org.ujorm.tools.xml.config.HtmlConfig)

Field Summary

Fields

Modifier and Type	Field and Description
protected ApiElement	internalElement An original XML element

Fields inherited from interface org.ujorm.tools.web.Html

A, A_ACTION, A_ALT, A_CELLPADDING, A_CELLSPACING, A_CLASS, A_COLS, A_COLSPAN, A_CONTENT, A_FOR, A_HREF, A_HTTP_EQUIV, A_CHARSET, A_CHECKED, A_ID, A_LANG, A_LANGUAGE, A_MAXLENGTH, A_MEDIA, A_METHOD, A_NAME, A_READONLY, A_REL, A_ROWS, A_ROWSPAN, A_SELECTED, A_SRC, A_TARGET, A_TYPE, A_VALUE, BODY, BR, BUTTON, DIV, FIELDSET, FORM, H1, H2, H3, HEAD, HEADING_PREFIX, HR, HTML, IMAGE, INPUT, LABEL, LEGEND, LI, LINK, META, OL, OPTION, P, PRE, SCRIPT, SELECT, SPAN, STYLE, TABLE, TD, TEXT_AREA, TH, THEAD, TITLE, TR, UL, V_BLANK, V_GET, V_HIDDEN, V_CHECKBOX, V_PASSWORD, V_POST, V_RESET, V_STYLESHEET, V_SUBMIT, V_TEXT, V_TEXT_CSS

Constructor Summary

Constructors

Constructor and Description
Element(ApiElement original) New element with a parent

Method Summary

Modifier and Type	Method and Description
Element	addAnchor(String url, CharSequence... cssClasses) Add an anchor element with URL and CSS classes
Element	addAnchoredText(String url, Object... text) Add an anchor element with texts
Element	addBody(CharSequence... cssClasses) Add new body element
Element	addBreak(CharSequence... cssClasses) Add a line break
Element	addButton(CharSequence... cssClasses) Add new body element
Element	addCDATA(CharSequence charData) Add a character data in CDATA format to XML only.
Element	addComment(CharSequence comment) Add a comment text.
Element	addDiv(CharSequence... cssClasses) Add new body element
Element	addElement(String name) Create new Element
Element	addElement(String name, CharSequence... cssClasses) Add a new Element with optional CSS classes
Element	addFieldset(String title, CharSequence... cssClasses) Add new fieldset element including a title
Element	addForm(CharSequence... cssClasses) Add new body element
Element	addHeading(CharSequence title, CharSequence... cssClasses) Add a top heading (level one)
Element	addHeading(int level, CharSequence title, CharSequence... cssClasses) Add new heading with the required level where the first level is the one,
Element	addImage(CharSequence imageLink, CharSequence alt, CharSequence... cssClasses) Add a link to an image
Element	addImage(InputStream imageStream, CharSequence alt, CharSequence... cssClasses) Add an embeded image
Element	addInput(CharSequence... cssClasses) Add new input element
Element	addLabel(CharSequence... cssClasses) Add new body element
Element	addLink(CharSequence... cssClasses) Add new body element
Element	addListItem(CharSequence... cssClasses)
Element	addOption(CharSequence... cssClasses) Add new body element
Element	addOrderedList(CharSequence... cssClasses) Add new body element
Element	addParagraph(CharSequence... cssClasses) Add new body element
Element	addPasswordInput(CharSequence... cssClasses) Add new input element type of password
Element	addPreformatted(CharSequence... cssClasses) Add new body element
Element	addRawText(Object data) Add an native text with no escaped characters, for example: XML code, JavaScript, CSS styles
Element	addScript(CharSequence... cssClasses) Add new body element
Element	addSelect(CharSequence... cssClasses) Add new select element
Element	addSelectOptions(Object value, Map<?,?> options, CharSequence... cssClasses) Add options from map to current select element
Element	addSpan(CharSequence... cssClasses) Add new body element
Element	addStyle(CharSequence... cssClasses) Add new body element
Element	addSubmitButton(CharSequence... cssClasses) Add a submit button
Element	addTable(CharSequence... cssClasses) Add new Table
Element	addTable(List<Object[]> data, CharSequence... cssClass) Create a HTML table according to data
Element	addTable(Object[][] data, CharSequence... cssClass) Create a HTML table according to data
Element	addTableDetail(CharSequence... cssClasses) Add new body element
Element	addTableHead(CharSequence... cssClasses) Add new body element
Element	addTableNoSpaces(CharSequence... cssClasses) Deprecated. Use a CSS style rather.
Element	addTableRow(CharSequence... cssClasses) Add new body element
Element	addTemplate(String template, Object... data) Add a template based text with parameters
Element	addText(Object... data) Add many texts with no separator
Element	addText(Object data) Add simple text
Element	addTextArea(CharSequence... cssClasses) Add new body element
Element	addTextInput(CharSequence... cssClasses) Add new input element type of text
Element	addTextSeparted(CharSequence separator, Object... data) Add many words separated by the separator
Element	addTitle(CharSequence... cssClasses) Add new body element
Element	addUnorderedlist(CharSequence... cssClasses) Add new body element
void	close() Close the element
protected CharSequence	createEmbededImage(InputStream imageStream, StringBuilder result) Create a content of an embeded image
static Element	createHtmlRoot(Object title, CharSequence... cssLinks) Crate a root element
static Element	createHtmlRoot(Object title, Charset charset, CharSequence... cssLinks) Crate a root element
String	getName() Get an element name
Element	setAction(Object value) Set an action type of from
Element	setAttrib(String name, Object value) A shortcut for the method setAttribute(java.lang.String, java.lang.Object).
Element	setAttribute(String name, Object value) Set an attribute
Element	setCellPadding(int value) Deprecated.
Element	setCellSpacing(int value) Deprecated.
Element	setClass(CharSequence... cssClasses) Set a CSS class attribute optionally, the empty attribute is ignored.
Element	setCols(Object value) Column count of a text area
Element	setColSpan(int value) Column span inside the table
Element	setFor(CharSequence value) Set an value of input element
Element	setHref(CharSequence value) Set hyperlink reference
Element	setId(CharSequence value) Set an identifier of the element
Element	setMethod(Object value) Set a method of form
Element	setName(CharSequence value) Set an name of input element
Element	setRows(int value) Row count of a text area
Element	setRowSpan(int value) Row span inside the table
Element	setType(Object value) Set a type of input element
Element	setValue(Object value) Set an value of input element
String	toString() String value

Methods inherited from class java.lang.Object

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

Field Detail

internalElement

protected final ApiElement internalElement

An original XML element

Constructor Detail

Element

public Element(@Nonnull
               ApiElement original)

New element with a parent

Method Detail

getName

@Nonnull
public String getName()

Description copied from interface: ApiElement

Get an element name

Specified by:

getName in interface ApiElement<Element>

setAttribute

@Nonnull
public final Element setAttribute(@Nonnull
                                           String name,
                                           @Nullable
                                           Object value)

Set an attribute

Specified by:

setAttribute in interface ApiElement<Element>

Parameters:

name - Required element name

value - The null value is silently ignored. Formatting is performed by the XmlWriter#writeValue(java.lang.Object, org.ujorm.tools.model.XmlModel, java.lang.String, java.io.Writer) method, where the default implementation calls a toString() only.

Returns:

The original element

setAttrib

@Nonnull
public final Element setAttrib(@Nonnull
                                        String name,
                                        @Nullable
                                        Object value)

A shortcut for the method setAttribute(java.lang.String, java.lang.Object).

Specified by:

setAttrib in interface ApiElement<Element>

Parameters:

name - Required element name

value - The null value is silently ignored. Formatting is performed by the XmlWriter#writeValue(java.lang.Object, org.ujorm.tools.model.XmlModel, java.lang.String, java.io.Writer) method, where the default implementation calls a toString() only.

Returns:

The original element

addText

@Nonnull
public Element addText(Object data)
                         throws IllegalStateException

Add simple text

Specified by:

addText in interface ApiElement<Element>

Parameters:

data - Text item

Returns:

A parent element.

Throws:

IllegalStateException

See Also:

addAnchoredText(java.lang.String, java.lang.Object...)

addText

@Nonnull
public Element addText(@Nonnull
                                Object... data)
                         throws IllegalStateException

Add many texts with no separator

Parameters:

data - Text items

Returns:

A parent element.

Throws:

IllegalStateException

See Also:

addAnchoredText(java.lang.String, java.lang.Object...)

addTemplate

@Nonnull
public Element addTemplate(@Nonnull
                                    String template,
                                    @Nonnull
                                    Object... data)
                             throws IllegalStateException

Add a template based text with parameters

Parameters:

template - A message template with an ENGLISH locale. See {@link String#format(java.lang.String, java.lang.Object...) for more parameters.

data - A template parameters

Returns:

A parent element.

Throws:

IllegalStateException

addTextSeparted

public Element addTextSeparted(@Nonnull
                               CharSequence separator,
                               @Nonnull
                               Object... data)
                        throws IllegalStateException

Add many words separated by the separator

Parameters:

separator - A raw text separator

data - Data to print

Returns:

The current element

Throws:

IllegalStateException

addRawText

@Nonnull
public Element addRawText(@Nullable
                                   Object data)
                            throws IllegalStateException

Description copied from interface: ApiElement

Add an native text with no escaped characters, for example: XML code, JavaScript, CSS styles

Specified by:

addRawText in interface ApiElement<Element>

Parameters:

data - The null value is ignored.

Returns:

This instance

Throws:

IllegalStateException

addComment

@Nonnull
public Element addComment(CharSequence comment)
                            throws IllegalStateException

Description copied from interface: ApiElement

Add a comment text. The CDATA structure isn't really for HTML at all.

Specified by:

addComment in interface ApiElement<Element>

Parameters:

comment - A comment text must not contain a string --> .

Returns:

This instance

Throws:

IllegalStateException

addCDATA

@Nonnull
public Element addCDATA(CharSequence charData)
                          throws IllegalStateException

Description copied from interface: ApiElement

Add a character data in CDATA format to XML only. The CDATA structure isn't really for HTML at all.

Specified by:

addCDATA in interface ApiElement<Element>

Parameters:

charData - A text including the final DATA sequence. An empty argument is ignored.

Returns:

This instance

Throws:

IllegalStateException

close

@Nonnull
public void close()
                    throws IllegalStateException

Description copied from interface: ApiElement

Close the element

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ApiElement<Element>

Throws:

IllegalStateException

addElement

@Nonnull
public Element addElement(@Nonnull
                                   String name)
                            throws IllegalStateException

Create new Element

Specified by:

addElement in interface ApiElement<Element>

Parameters:

name - The element name

Returns:

New instance of the Element

Throws:

IllegalStateException - An envelope for IO exceptions

addElement

@Nonnull
public final Element addElement(@Nonnull
                                         String name,
                                         @Nonnull
                                         CharSequence... cssClasses)

Add a new Element with optional CSS classes

Parameters:

name - A required name of the element

cssClasses - Optional CSS classes.

Returns:

New instance of the Element

addTable

@Nonnull
public Element addTable(@Nonnull
                                 CharSequence... cssClasses)

Add new Table

addTableNoSpaces

@Deprecated
 @Nonnull
public Element addTableNoSpaces(@Nonnull
                                                      CharSequence... cssClasses)

Deprecated. Use a CSS style rather.

Add new Table with cellpadding a cellspacing values to zero.

addTable

@Nonnull
public Element addTable(Object[][] data,
                                 CharSequence... cssClass)

Create a HTML table according to data

addTable

@Nonnull
public Element addTable(List<Object[]> data,
                                 CharSequence... cssClass)

Create a HTML table according to data

addImage

@Nonnull
public Element addImage(@Nonnull
                                 CharSequence imageLink,
                                 @Nonnull
                                 CharSequence alt,
                                 @Nonnull
                                 CharSequence... cssClasses)
                          throws IllegalStateException

Add a link to an image

Parameters:

imageLink - A link to image

alt - An alternate text

cssClasses - Optional CSS classes

Returns:

Throws:

IllegalStateException

addImage

@Nonnull
public Element addImage(@Nonnull
                                 InputStream imageStream,
                                 @Nonnull
                                 CharSequence alt,
                                 @Nonnull
                                 CharSequence... cssClasses)
                          throws IllegalStateException

Add an embeded image

Parameters:

imageStream - Stream provides a PNG image and it will be closed after reading.

alt - An alternate text

cssClasses - Optional CSS classes

Returns:

Throws:

IllegalStateException

createEmbededImage

@Nonnull
protected CharSequence createEmbededImage(@Nonnull
                                                   InputStream imageStream,
                                                   @Nonnull
                                                   StringBuilder result)

Create a content of an embeded image

addBody

@Nonnull
public Element addBody(@Nonnull
                                CharSequence... cssClasses)

Add new body element

addTitle

@Nonnull
public Element addTitle(@Nonnull
                                 CharSequence... cssClasses)

Add new body element

addLink

@Nonnull
public Element addLink(@Nonnull
                                CharSequence... cssClasses)

Add new body element

addStyle

@Nonnull
public Element addStyle(@Nonnull
                                 CharSequence... cssClasses)

Add new body element

addScript

@Nonnull
public Element addScript(@Nonnull
                                  CharSequence... cssClasses)

Add new body element

addDiv

@Nonnull
public Element addDiv(@Nonnull
                               CharSequence... cssClasses)

Add new body element

addFieldset

@Nonnull
public Element addFieldset(@Nullable
                                    String title,
                                    @Nonnull
                                    CharSequence... cssClasses)

Add new fieldset element including a title

Parameters:

title - An optional title

cssClasses - CSS classes

Returns:

An instance of FieldSet

See Also:

LEGEND

addPreformatted

@Nonnull
public Element addPreformatted(@Nonnull
                                        CharSequence... cssClasses)

Add new body element

addSpan

@Nonnull
public Element addSpan(@Nonnull
                                CharSequence... cssClasses)

Add new body element

addParagraph

@Nonnull
public Element addParagraph(@Nonnull
                                     CharSequence... cssClasses)

Add new body element

addForm

@Nonnull
public Element addForm(@Nonnull
                                CharSequence... cssClasses)

Add new body element

addHeading

@Nonnull
public Element addHeading(@Nonnull
                                   CharSequence title,
                                   @Nonnull
                                   CharSequence... cssClasses)

Add a top heading (level one)

addHeading

@Nonnull
public Element addHeading(int level,
                                   @Nonnull
                                   CharSequence title,
                                   @Nonnull
                                   CharSequence... cssClasses)

Add new heading with the required level where the first level is the one,

addTableHead

@Nonnull
public Element addTableHead(@Nonnull
                                     CharSequence... cssClasses)

Add new body element

addTableRow

@Nonnull
public Element addTableRow(@Nonnull
                                    CharSequence... cssClasses)

Add new body element

addTableDetail

@Nonnull
public Element addTableDetail(@Nonnull
                                       CharSequence... cssClasses)

Add new body element

addLabel

@Nonnull
public Element addLabel(@Nonnull
                                 CharSequence... cssClasses)

Add new body element

addInput

@Nonnull
public Element addInput(@Nonnull
                                 CharSequence... cssClasses)

Add new input element

addTextInput

@Nonnull
public Element addTextInput(@Nonnull
                                     CharSequence... cssClasses)

Add new input element type of text

addPasswordInput

@Nonnull
public Element addPasswordInput(@Nonnull
                                         CharSequence... cssClasses)

Add new input element type of password

addTextArea

@Nonnull
public Element addTextArea(@Nonnull
                                    CharSequence... cssClasses)

Add new body element

addSelect

@Nonnull
public Element addSelect(@Nonnull
                                  CharSequence... cssClasses)

Add new select element

See Also:

addSelectOptions(java.lang.Object, java.util.Map, java.lang.CharSequence...)

addSelectOptions

@Nonnull
public Element addSelectOptions(@Nonnull
                                         Object value,
                                         @Nonnull
                                         Map<?,?> options,
                                         @Nonnull
                                         CharSequence... cssClasses)

Add options from map to current select element

Parameters:

value - Value of a select element

options - Consider an instance of the LinkedHashMap class predictable iteration order of options.

cssClasses -

Returns:

Return this

See Also:

addSelect(java.lang.CharSequence...)

addOption

@Nonnull
public Element addOption(@Nonnull
                                  CharSequence... cssClasses)

Add new body element

addButton

@Nonnull
public Element addButton(@Nonnull
                                  CharSequence... cssClasses)

Add new body element

addSubmitButton

@Nonnull
public Element addSubmitButton(@Nonnull
                                        CharSequence... cssClasses)

Add a submit button

addAnchor

@Nonnull
public Element addAnchor(@Nonnull
                                  String url,
                                  @Nonnull
                                  CharSequence... cssClasses)

Add an anchor element with URL and CSS classes

addAnchoredText

@Nonnull
public Element addAnchoredText(@Nonnull
                                        String url,
                                        @Nonnull
                                        Object... text)

Add an anchor element with texts

addUnorderedlist

@Nonnull
public Element addUnorderedlist(@Nonnull
                                         CharSequence... cssClasses)

Add new body element

addOrderedList

@Nonnull
public Element addOrderedList(@Nonnull
                                       CharSequence... cssClasses)

Add new body element

addListItem

@Nonnull
public Element addListItem(@Nonnull
                                    CharSequence... cssClasses)

setClass

@Nonnull
public Element setClass(@Nonnull
                                 CharSequence... cssClasses)

Set a CSS class attribute optionally, the empty attribute is ignored.

Parameters:

cssClasses - Optional CSS classes. The css item is ignored when the value is empty or null.

Returns:

The current instanlce

addBreak

@Nonnull
public Element addBreak(@Nonnull
                                 CharSequence... cssClasses)

Add a line break

setCellPadding

@Deprecated
 @Nonnull
public Element setCellPadding(int value)

Deprecated.

Set a CSS class attribute rather

setCellSpacing

@Deprecated
 @Nonnull
public Element setCellSpacing(int value)

Deprecated.

Set a CSS class attribute rather

createHtmlRoot

@Nonnull
public static Element createHtmlRoot(@Nonnull
                                              Object title,
                                              @Nullable
                                              CharSequence... cssLinks)

Crate a root element

Parameters:

cssLinks - Nullable CSS link array

createHtmlRoot

@Nonnull
public static Element createHtmlRoot(@Nonnull
                                              Object title,
                                              @Nullable
                                              Charset charset,
                                              @Nullable
                                              CharSequence... cssLinks)

Crate a root element

Parameters:

title - A HTML title

charset - A charset

cssLinks - Nullable CSS link array

setId

@Nonnull
public Element setId(@Nullable
                              CharSequence value)

Set an identifier of the element

setMethod

@Nonnull
public Element setMethod(@Nullable
                                  Object value)

Set a method of form

setAction

@Nonnull
public Element setAction(@Nullable
                                  Object value)

Set an action type of from

setType

@Nonnull
public Element setType(@Nullable
                                Object value)

Set a type of input element

setName

@Nonnull
public Element setName(@Nullable
                                CharSequence value)

Set an name of input element

setValue

@Nonnull
public Element setValue(@Nullable
                                 Object value)

Set an value of input element

setFor

@Nonnull
public Element setFor(@Nullable
                               CharSequence value)

Set an value of input element

setRows

@Nonnull
public Element setRows(@Nullable
                                int value)

Row count of a text area

setCols

@Nonnull
public Element setCols(@Nullable
                                Object value)

Column count of a text area

setColSpan

@Nonnull
public Element setColSpan(@Nullable
                                   int value)

Column span inside the table

setRowSpan

@Nonnull
public Element setRowSpan(@Nullable
                                   int value)

Row span inside the table

setHref

@Nonnull
public Element setHref(@Nullable
                                CharSequence value)

Set hyperlink reference

toString

@Nonnull
public String toString()

String value

Overrides:

toString in class Object