org.ujorm.tools.web

Class HtmlElement

java.lang.Object

org.ujorm.tools.web.HtmlElement

All Implemented Interfaces:

Closeable, AutoCloseable, Html, ApiElement<Element>

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

The root of HTML elements

Usage

    MockServletResponse response = new MockServletResponse();
    try (HtmlElement html = HtmlElement.of(response)) {
        html.addBody().addHeading("Hello!");
    }
    assertTrue(response.toString().contains("<h1>Hello!</h1>"));
 

For more information see the next sample.

Field Summary

Fields inherited from interface org.ujorm.tools.xml.ApiElement

HIDDEN_NAME

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_ONCLICK, A_PLACEHOLDER, A_READONLY, A_REL, A_ROWS, A_ROWSPAN, A_SELECTED, A_SRC, A_STYLE, A_TARGET, A_TITLE, 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, TBODY, 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
HtmlElement(ApiElement root, HtmlConfig config, Appendable writer) Create new instance with empty html headers
HtmlElement(HtmlConfig config, Appendable writer) Create new instance with empty html headers

Method Summary

Modifier and Type	Method and Description
Element	addBody() Returns a body element
Element	addCDATA(CharSequence charData) Deprecated.
Element	addComment(CharSequence comment) Add a comment text.
Element	addCssBodies(CharSequence lineSeparator, CharSequence... css) Create a new CSS element and return it.
Element	addCssBody(CharSequence css) Create a new CSS element and return it
Element	addCssLink(CharSequence css) Create a new CSS element and return it
void	addCssLinks(CharSequence... css) Create a new CSS element and return it
Element	addElement(String name) Create new Element
Element	addHead() Returns a head element
Element	addJavascriptBody(CharSequence... javascript) Create a new Javascript element and return it.
Element	addJavascriptContents(CharSequence javascript) Deprecated.
Element	addJavascriptLink(boolean defer, CharSequence javascriptLink) Create a new Javascript element and return it
void	addJavascriptLinks(boolean defer, CharSequence... javascriptLinks) Create a new Javascript element and return it
Element	addRawText(Object value) Add an native text with no escaped characters, for example: XML code, JavaScript, CSS styles
Element	addText(Object value) Add a text and escape special character
Element	addTextTemplated(CharSequence template, Object... values) Message template
void	close() Close the element
Element	getBody() Returns a body element
HtmlConfig	getConfig() Get config
Element	getHead() Returns a head element
String	getName() Get an element name
CharSequence	getTitle() Get title of configuration
static HtmlElement	niceOf(javax.servlet.http.HttpServletResponse response, CharSequence... cssLinks) Create new instance with empty html headers
static HtmlElement	niceOf(CharSequence title, javax.servlet.http.HttpServletResponse response, CharSequence... cssLinks) Create new instance with empty html headers
static HtmlElement	niceOf(CharSequence title, javax.servlet.http.HttpServletResponse response, Charset charset, CharSequence... cssLinks) Create new instance with empty html headers
static HtmlElement	of(HtmlConfig config) Create new instance with empty html headers
static HtmlElement	of(HtmlConfig config, Appendable writer) Create root element for a required element name
static HtmlElement	of(HtmlConfig config, javax.servlet.http.HttpServletResponse response) A base method to create new instance with empty html headers
static HtmlElement	of(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) A base method to create new instance
static HtmlElement	of(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, HtmlConfig config) A base method to create new instance
static HtmlElement	of(javax.servlet.http.HttpServletResponse response, HtmlConfig config) Deprecated. Use the method of(org.ujorm.tools.xml.config.HtmlConfig, javax.servlet.http.HttpServletResponse) rather.
static HtmlElement	of(javax.servlet.http.HttpServletResponse response, CharSequence... cssLinks) Create new instance with empty html headers
static HtmlElement	of(CharSequence title, javax.servlet.http.HttpServletResponse response, CharSequence... cssLinks) Create new instance with empty html headers
static HtmlElement	of(CharSequence title, javax.servlet.http.HttpServletResponse response, Charset charset, CharSequence... cssLinks) Create new instance with empty html headers
Element	original() Get an original root element
Element	setAttribute(String name, Object value) Set an attribute
String	toString() Returns an Render the HTML code including header.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ujorm.tools.xml.ApiElement

setAttrib

Constructor Detail

HtmlElement

public HtmlElement(@Nonnull
                   HtmlConfig config,
                   @Nonnull
                   Appendable writer)

Create new instance with empty html headers

HtmlElement

public HtmlElement(@Nonnull
                   ApiElement root,
                   @Nonnull
                   HtmlConfig config,
                   @Nonnull
                   Appendable writer)

Create new instance with empty html headers

Method Detail

getName

@Nonnull
public String getName()

Description copied from interface: ApiElement

Get an element name

Specified by:

getName in interface ApiElement<Element>

setAttribute

public Element setAttribute(String name,
                            Object value)

Description copied from interface: ApiElement

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

Returns:

The original element

addText

public Element addText(Object value)

Description copied from interface: ApiElement

Add a text and escape special character

Specified by:

addText in interface ApiElement<Element>

Parameters:

value - The null value is allowed. 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:

This instance

addTextTemplated

public Element addTextTemplated(@Nonnull
                                CharSequence template,
                                @Nonnull
                                Object... values)

Description copied from interface: ApiElement

Message template

Specified by:

addTextTemplated in interface ApiElement<Element>

Parameters:

template - Message template where parameters are marked by the {} symbol

values - argument values

Returns:

The original builder

addRawText

public Element addRawText(Object value)

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:

value - The null value is ignored.

Returns:

This instance

addComment

public Element addComment(CharSequence comment)

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

addCDATA

@Deprecated
public Element addCDATA(CharSequence charData)

Deprecated.

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

addElement

@Nonnull
public final 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

getHead

public Element getHead()

Returns a head element

addHead

public Element addHead()

Returns a head element

getBody

@Nonnull
public Element getBody()

Returns a body element

addBody

@Nonnull
public Element addBody()

Returns a body element

addJavascriptLinks

public void addJavascriptLinks(boolean defer,
                               @Nonnull
                               CharSequence... javascriptLinks)

Create a new Javascript element and return it

Parameters:

javascriptLinks - URL list to Javascript

defer - A script that will not run until after the page has loaded

addJavascriptLink

public Element addJavascriptLink(boolean defer,
                                 @Nonnull
                                 CharSequence javascriptLink)

Create a new Javascript element and return it

Parameters:

javascriptLink - URL to Javascript

defer - A script that will not run until after the page has loaded

Returns:

addJavascriptContents

@Deprecated
public Element addJavascriptContents(@Nonnull
                                                 CharSequence javascript)

Deprecated.

User the method addJavascriptBody(java.lang.CharSequence...) rather

addJavascriptBody

public Element addJavascriptBody(@Nullable
                                 CharSequence... javascript)

Create a new Javascript element and return it. Each item is separated by a new line.

Parameters:

javascript - Add a javascriptLink link

Returns:

New CSS element

addCssLinks

public void addCssLinks(@Nonnull
                        CharSequence... css)

Create a new CSS element and return it

Parameters:

css - Add a CSS link

addCssLink

public Element addCssLink(@Nonnull
                          CharSequence css)

Create a new CSS element and return it

Parameters:

css - Add a CSS link

Returns:

New CSS element

addCssBody

public Element addCssBody(@Nonnull
                          CharSequence css)

Create a new CSS element and return it

Parameters:

css - CSS content

Returns:

New CSS element

addCssBodies

public Element addCssBodies(@Nonnull
                            CharSequence lineSeparator,
                            @Nonnull
                            CharSequence... css)

Create a new CSS element and return it. Each item is separated by a new line.

Parameters:

lineSeparator - Row separator

css - CSS content rows

Returns:

New CSS element

original

@Nonnull
public Element original()

Get an original root element

toString

@Nonnull
public String toString()
                         throws IllegalStateException

Returns an Render the HTML code including header. Call the close() method before view

Overrides:

toString in class Object

Throws:

IllegalStateException

close

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

getConfig

@Nonnull
public HtmlConfig getConfig()

Get config

getTitle

public CharSequence getTitle()

Get title of configuration

of

@Nonnull
public static HtmlElement of(@Nonnull
                                      javax.servlet.http.HttpServletResponse response,
                                      @Nonnull
                                      CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

MockServletResponse

of

@Nonnull
public static HtmlElement of(@Nonnull
                                      CharSequence title,
                                      @Nonnull
                                      javax.servlet.http.HttpServletResponse response,
                                      @Nonnull
                                      CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

MockServletResponse

of

@Nonnull
public static HtmlElement of(@Nonnull
                                      CharSequence title,
                                      @Nonnull
                                      javax.servlet.http.HttpServletResponse response,
                                      @Nonnull
                                      Charset charset,
                                      @Nonnull
                                      CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

MockServletResponse

niceOf

@Nonnull
public static HtmlElement niceOf(@Nonnull
                                          CharSequence title,
                                          @Nonnull
                                          javax.servlet.http.HttpServletResponse response,
                                          @Nonnull
                                          CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

MockServletResponse

niceOf

@Nonnull
public static HtmlElement niceOf(@Nonnull
                                          CharSequence title,
                                          @Nonnull
                                          javax.servlet.http.HttpServletResponse response,
                                          @Nonnull
                                          Charset charset,
                                          @Nonnull
                                          CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

MockServletResponse

niceOf

@Nonnull
public static HtmlElement niceOf(@Nonnull
                                          javax.servlet.http.HttpServletResponse response,
                                          @Nonnull
                                          CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

MockServletResponse

of

@Nonnull
public static HtmlElement of(@Nonnull
                                      javax.servlet.http.HttpServletRequest request,
                                      @Nonnull
                                      javax.servlet.http.HttpServletResponse response)
                               throws IllegalStateException,
                                      UnsupportedEncodingException

A base method to create new instance

Parameters:

request - The HttpRequest gets the code page from the context only.

response - HttpResponse to write a result

Returns:

An instance of the HtmlPage

Throws:

IllegalStateException - IO exceptions

UnsupportedEncodingException

See Also:

MockServletResponse

of

@Nonnull
public static HtmlElement of(@Nonnull
                                      javax.servlet.http.HttpServletRequest request,
                                      @Nonnull
                                      javax.servlet.http.HttpServletResponse response,
                                      @Nonnull
                                      HtmlConfig config)
                               throws IllegalStateException,
                                      UnsupportedEncodingException

A base method to create new instance

Parameters:

request - The HttpRequest gets the code page from the context only.

response - HttpResponse to write a result

config - Html configuration

Returns:

An instance of the HtmlPage

Throws:

IllegalStateException - IO exceptions

UnsupportedEncodingException

See Also:

MockServletResponse

of

@Deprecated
 @Nonnull
public static HtmlElement of(@Nonnull
                                                   javax.servlet.http.HttpServletResponse response,
                                                   @Nonnull
                                                   HtmlConfig config)
                                            throws IllegalStateException

Deprecated. Use the method of(org.ujorm.tools.xml.config.HtmlConfig, javax.servlet.http.HttpServletResponse) rather.

A base method to create new instance with empty html headers

Parameters:

response - HttpResponse to write a result

config - Html configuration

Returns:

An instance of the HtmlPage

Throws:

IllegalStateException - IO exceptions

See Also:

MockServletResponse

of

@Nonnull
public static HtmlElement of(@Nonnull
                                      HtmlConfig config,
                                      @Nonnull
                                      javax.servlet.http.HttpServletResponse response)
                               throws IllegalStateException

A base method to create new instance with empty html headers

Parameters:

response - HttpResponse to write a result

config - Html configuration

Returns:

An instance of the HtmlPage

Throws:

IllegalStateException - IO exceptions

See Also:

MockServletResponse

of

@Nonnull
public static HtmlElement of(@Nullable
                                      HtmlConfig config)
                               throws IllegalStateException

Create new instance with empty html headers

Parameters:

config - Html configuration

Returns:

An instance of the HtmlPage

Throws:

IllegalStateException - IO exceptions

of

public static HtmlElement of(@Nonnull
                             HtmlConfig config,
                             @Nonnull
                             Appendable writer)
                      throws IllegalStateException

Create root element for a required element name

Throws:

IllegalStateException