org.ujorm.tools.web

Class Element

java.lang.Object

org.ujorm.tools.xml.AbstractElement<Element>

org.ujorm.tools.web.Element

All Implemented Interfaces:

Closeable, AutoCloseable, Html

Direct Known Subclasses:

HtmlPage

public class Element
extends AbstractElement<Element>
implements Html

A proxy for a HTML element

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractElement	origElement An original XML element

Fields inherited from class org.ujorm.tools.xml.AbstractElement

DEFAULT_INTENDATION, HTML_DOCTYPE, name, REQUIRED_MSG, XML_HEADER

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

A, A_ACTION, A_CELLPADDING, A_CELLSPACING, A_CLASS, A_COLS, A_COLSPAN, A_CONTENT, A_FOR, A_HREF, 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, HTML, 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(AbstractElement original) New element with a parent

Method Summary

Modifier and Type	Method and Description
<T extends Element> T	addAnchor(String url, CharSequence... cssClasses) Add an anchor element with URL and CSS classes
<T extends Element> T	addAnchoredText(String url, Object... text) Add an anchor element with texts
<T extends Element> T	addBody(CharSequence... cssClasses) Add new body element
<T extends Element> T	addBreak(CharSequence... cssClasses) Add a line break
<T extends Element> T	addButton(CharSequence... cssClasses) Add new body element
<T extends Element> T	addCDATA(CharSequence charData)
<T extends Element> T	addComment(CharSequence comment)
<T extends Element> T	addDiv(CharSequence... cssClasses) Add new body element
<T extends Element> T	addElement(String name) Create new Element
<T extends Element> T	addElement(String name, CharSequence... cssClasses) Add a new Element with optional CSS classes
<T extends Element> T	addFieldset(String title, CharSequence... cssClasses) Add new fieldset element including a title
<T extends Element> T	addForm(CharSequence... cssClasses) Add new body element
<T extends Element> T	addHeading(CharSequence title, CharSequence... cssClasses) Add a top heading (level one)
<T extends Element> T	addHeading(int level, CharSequence title, CharSequence... cssClasses) Add new heading with the required level where the first level is the one,
<T extends Element> T	addInput(CharSequence... cssClasses) Add new input element
<T extends Element> T	addLabel(CharSequence... cssClasses) Add new body element
<T extends Element> T	addLink(CharSequence... cssClasses) Add new body element
<T extends Element> T	addListItem(CharSequence... cssClasses)
<T extends Element> T	addOption(CharSequence... cssClasses) Add new body element
<T extends Element> T	addOrderedList(CharSequence... cssClasses) Add new body element
<T extends Element> T	addParagraph(CharSequence... cssClasses) Add new body element
<T extends Element> T	addPasswordInput(CharSequence... cssClasses) Add new input element type of password
<T extends Element> T	addPreformatted(CharSequence... cssClasses) Add new body element
<T extends Element> T	addRawText(Object data)
<T extends Element> T	addScript(CharSequence... cssClasses) Add new body element
<T extends Element> T	addSelect(CharSequence... cssClasses) Add new select element
<T extends Element> T	addSelectOptions(Object value, Map<?,?> options, CharSequence... cssClasses) Add options from map to current select element
<T extends Element> T	addSpan(CharSequence... cssClasses) Add new body element
<T extends Element> T	addStyle(CharSequence... cssClasses) Add new body element
<T extends Element> T	addSubmitButton(CharSequence... cssClasses) Add a submit button
<T extends Element> T	addTable(CharSequence... cssClasses) Add new Table with cellpadding a cellspacing values to zero.
<T extends Element> T	addTable(List<Object[]> data, CharSequence... cssClass) Create a HTML table according to data
<T extends Element> T	addTable(Object[][] data, CharSequence... cssClass) Create a HTML table according to data
<T extends Element> T	addTableDetail(CharSequence... cssClasses) Add new body element
<T extends Element> T	addTableHead(CharSequence... cssClasses) Add new body element
<T extends Element> T	addTableRow(CharSequence... cssClasses) Add new body element
<T extends Element> T	addText(Object... data) Add many texts with no separator
<T extends Element> T	addText(Object data) Add simple text
<T extends Element> T	addTextArea(CharSequence... cssClasses) Add new body element
<T extends Element> T	addTextInput(CharSequence... cssClasses) Add new input element type of text
<T extends Element> T	addTextSeparted(Object separator, Object... data) Add many words separated by the separator
<T extends Element> T	addTitle(CharSequence... cssClasses) Add new body element
<T extends Element> T	addUnorderedlist(CharSequence... cssClasses) Add new body element
void	close()
static Element	createHtmlRoot(Object title, CharSequence... cssLinks) Crate a root element
static Element	createHtmlRoot(Object title, Charset charset, CharSequence... cssLinks) Crate a root element
<T extends Element> T	setAction(Object value) Set an action type of from
<T extends Element> T	setAttrib(String name, Object value) Set an attribute
<T extends Element> T	setCellPadding(int value) Set a CSS class attribute
<T extends Element> T	setCellSpacing(int value) Set a CSS class attribute
<T extends Element> T	setClass(CharSequence... cssClasses) Set a CSS class attribute optionally, the empty attribute is ignored.
<T extends Element> T	setCols(Object value) Column count of a text area
<T extends Element> T	setColSpan(int value) Column span inside the table
<T extends Element> T	setFor(CharSequence value) Set an value of input element
<T extends Element> T	setHref(CharSequence value) Set hyperlink reference
<T extends Element> T	setId(CharSequence value) Set an identifier of the element
<T extends Element> T	setMethod(Object value) Set a method of form
<T extends Element> T	setName(CharSequence value) Set an name of input element
<T extends Element> T	setRows(int value) Row count of a text area
<T extends Element> T	setRowSpan(int value) Row span inside the table
<T extends Element> T	setType(Object value) Set a type of input element
<T extends Element> T	setValue(Object value) Set an value of input element
String	toString() String value

Methods inherited from class org.ujorm.tools.xml.AbstractElement

getName

Methods inherited from class java.lang.Object

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

Field Detail

origElement

protected final AbstractElement origElement

An original XML element

Constructor Detail

Element

public Element(@Nonnull
               AbstractElement original)

New element with a parent

Method Detail

addElement

@Nonnull
public final <T extends Element> T addElement(@Nonnull
                                                       String name)
                                                throws IllegalStateException

Create new Element

Specified by:

addElement in class AbstractElement<Element>

Parameters:

name - The element name

Returns:

New instance of the Element

Throws:

IllegalStateException - An envelope for IO exceptions

setAttrib

public final <T extends Element> T setAttrib(@Nonnull
                                             String name,
                                             @Nullable
                                             Object value)

Set an attribute

Specified by:

setAttrib in class AbstractElement<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.dom.XmlElement, java.lang.String, java.io.Writer) method, where the default implementation calls a toString() only.

Returns:

The original element

addText

public <T extends Element> T addText(Object data)
                              throws IllegalStateException

Add simple text

Specified by:

addText in class AbstractElement<Element>

Parameters:

data - Text item

Returns:

A parent element.

Throws:

IllegalStateException

See Also:

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

addText

public <T extends Element> T 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...)

addTextSeparted

public <T extends Element> T addTextSeparted(@Nonnull
                                             Object separator,
                                             @Nonnull
                                             Object... data)
                                      throws IllegalStateException

Add many words separated by the separator

Throws:

IllegalStateException

addRawText

public <T extends Element> T addRawText(Object data)
                                 throws IllegalStateException

Specified by:

addRawText in class AbstractElement<Element>

Throws:

IllegalStateException

addComment

public <T extends Element> T addComment(CharSequence comment)
                                 throws IllegalStateException

Specified by:

addComment in class AbstractElement<Element>

Throws:

IllegalStateException

addCDATA

public <T extends Element> T addCDATA(CharSequence charData)
                               throws IllegalStateException

Specified by:

addCDATA in class AbstractElement<Element>

Throws:

IllegalStateException

close

public void close()
           throws IllegalStateException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IllegalStateException

addElement

public <T extends Element> T 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

public <T extends Element> T addTable(@Nonnull
                                      CharSequence... cssClasses)

Add new Table with cellpadding a cellspacing values to zero.

addTable

public <T extends Element> T addTable(Object[][] data,
                                      CharSequence... cssClass)

Create a HTML table according to data

addTable

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

Create a HTML table according to data

addBody

public <T extends Element> T addBody(@Nonnull
                                     CharSequence... cssClasses)

Add new body element

addTitle

public <T extends Element> T addTitle(@Nonnull
                                      CharSequence... cssClasses)

Add new body element

addLink

public <T extends Element> T addLink(@Nonnull
                                     CharSequence... cssClasses)

Add new body element

addStyle

public <T extends Element> T addStyle(@Nonnull
                                      CharSequence... cssClasses)

Add new body element

addScript

public <T extends Element> T addScript(@Nonnull
                                       CharSequence... cssClasses)

Add new body element

addDiv

public <T extends Element> T addDiv(@Nonnull
                                    CharSequence... cssClasses)

Add new body element

addFieldset

public <T extends Element> T 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

public <T extends Element> T addPreformatted(@Nonnull
                                             CharSequence... cssClasses)

Add new body element

addSpan

public <T extends Element> T addSpan(@Nonnull
                                     CharSequence... cssClasses)

Add new body element

addParagraph

public <T extends Element> T addParagraph(@Nonnull
                                          CharSequence... cssClasses)

Add new body element

addForm

public <T extends Element> T addForm(@Nonnull
                                     CharSequence... cssClasses)

Add new body element

addHeading

public <T extends Element> T addHeading(@Nonnull
                                        CharSequence title,
                                        @Nonnull
                                        CharSequence... cssClasses)

Add a top heading (level one)

addHeading

public <T extends Element> T addHeading(int level,
                                        @Nonnull
                                        CharSequence title,
                                        @Nonnull
                                        CharSequence... cssClasses)

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

addTableHead

public <T extends Element> T addTableHead(@Nonnull
                                          CharSequence... cssClasses)

Add new body element

addTableRow

public <T extends Element> T addTableRow(@Nonnull
                                         CharSequence... cssClasses)

Add new body element

addTableDetail

public <T extends Element> T addTableDetail(@Nonnull
                                            CharSequence... cssClasses)

Add new body element

addLabel

public <T extends Element> T addLabel(@Nonnull
                                      CharSequence... cssClasses)

Add new body element

addInput

public <T extends Element> T addInput(@Nonnull
                                      CharSequence... cssClasses)

Add new input element

addTextInput

public <T extends Element> T addTextInput(@Nonnull
                                          CharSequence... cssClasses)

Add new input element type of text

addPasswordInput

public <T extends Element> T addPasswordInput(@Nonnull
                                              CharSequence... cssClasses)

Add new input element type of password

addTextArea

public <T extends Element> T addTextArea(@Nonnull
                                         CharSequence... cssClasses)

Add new body element

addSelect

public <T extends Element> T addSelect(@Nonnull
                                       CharSequence... cssClasses)

Add new select element

See Also:

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

addSelectOptions

public <T extends Element> T 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

public <T extends Element> T addOption(@Nonnull
                                       CharSequence... cssClasses)

Add new body element

addButton

public <T extends Element> T addButton(@Nonnull
                                       CharSequence... cssClasses)

Add new body element

addSubmitButton

public <T extends Element> T addSubmitButton(@Nonnull
                                             CharSequence... cssClasses)

Add a submit button

addAnchor

public <T extends Element> T addAnchor(@Nonnull
                                       String url,
                                       @Nonnull
                                       CharSequence... cssClasses)

Add an anchor element with URL and CSS classes

addAnchoredText

public <T extends Element> T addAnchoredText(@Nonnull
                                             String url,
                                             @Nonnull
                                             Object... text)

Add an anchor element with texts

addUnorderedlist

public <T extends Element> T addUnorderedlist(@Nonnull
                                              CharSequence... cssClasses)

Add new body element

addOrderedList

public <T extends Element> T addOrderedList(@Nonnull
                                            CharSequence... cssClasses)

Add new body element

addListItem

public <T extends Element> T addListItem(@Nonnull
                                         CharSequence... cssClasses)

setClass

public <T extends Element> T 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

public <T extends Element> T addBreak(@Nonnull
                                      CharSequence... cssClasses)

Add a line break

setCellPadding

public <T extends Element> T setCellPadding(int value)

Set a CSS class attribute

setCellSpacing

public <T extends Element> T setCellSpacing(int value)

Set a CSS class attribute

createHtmlRoot

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

Crate a root element

Parameters:

cssLinks - Nullable CSS link array

createHtmlRoot

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

Crate a root element

Parameters:

charset - A charset

cssLinks - Nullable CSS link array

setId

public <T extends Element> T setId(@Nullable
                                   CharSequence value)

Set an identifier of the element

setMethod

public <T extends Element> T setMethod(@Nullable
                                       Object value)

Set a method of form

setAction

public <T extends Element> T setAction(@Nullable
                                       Object value)

Set an action type of from

setType

public <T extends Element> T setType(@Nullable
                                     Object value)

Set a type of input element

setName

public <T extends Element> T setName(@Nullable
                                     CharSequence value)

Set an name of input element

setValue

public <T extends Element> T setValue(@Nullable
                                      Object value)

Set an value of input element

setFor

public <T extends Element> T setFor(@Nullable
                                    CharSequence value)

Set an value of input element

setRows

public <T extends Element> T setRows(@Nullable
                                     int value)

Row count of a text area

setCols

public <T extends Element> T setCols(@Nullable
                                     Object value)

Column count of a text area

setColSpan

public <T extends Element> T setColSpan(@Nullable
                                        int value)

Column span inside the table

setRowSpan

public <T extends Element> T setRowSpan(@Nullable
                                        int value)

Row span inside the table

setHref

public <T extends Element> T setHref(@Nullable
                                     CharSequence value)

Set hyperlink reference

toString

public String toString()

String value

Overrides:

toString in class Object