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

    ServletResponse response = new ServletResponse();
    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.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(@NotNull ApiElement root, @NotNull HtmlConfig config, @NotNull Appendable writer) Create new instance with empty html headers
HtmlElement(@NotNull HtmlConfig config, @NotNull Appendable writer) Create new instance with empty html headers

Method Summary

Modifier and Type	Method and Description
@NotNull Element	addBody() Returns a 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	addCssBodies(@NotNull CharSequence lineSeparator, CharSequence... css) Create a new CSS element and return it.
Element	addCssBody(@NotNull CharSequence css) Create a new CSS element and return it
Element	addCssLink(@NotNull CharSequence css) Create a new CSS element and return it
void	addCssLinks(CharSequence... css) Create a new CSS element and return it
@NotNull Element	addElement(@NotNull String name) Create new Element
Element	addHead() Returns a head element
Element	addJavascriptBody(CharSequence... javascript) Create a new Javascript element and return it.
Element	addJavascriptLink(boolean defer, @NotNull 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(@NotNull CharSequence template, Object... values) Message template
void	close() Close the element
@NotNull Element	getBody() Returns a body element
@NotNull HtmlConfig	getConfig() Get config
Element	getHead() Returns a head element
@NotNull String	getName() Get an element name
CharSequence	getTitle() Get title of configuration
@NotNull ExceptionProvider	next(@NotNull Consumer<HtmlElement> builder) Add nested elements to the element.
static @NotNull HtmlElement	niceOf(@NotNull CharSequence title, @NotNull Appendable response, CharSequence... cssLinks) Create new instance with empty html headers
static @NotNull HtmlElement	niceOf(@NotNull CharSequence title, @NotNull Appendable response, @NotNull Charset charset, CharSequence... cssLinks) Create new instance with empty html headers
static @NotNull HtmlElement	niceOf(@NotNull String title, @NotNull Appendable response, CharSequence... cssLinks) Create new instance with empty html headers
static @NotNull HtmlElement	niceOf(@NotNull String title, @NotNull RContext context, CharSequence... cssLinks) Create new instance with empty html headers
static @NotNull HtmlElement	niceOfResponse(@NotNull Object httpServletResponse, CharSequence... cssLinks) Create new instance with empty html headers
static @NotNull HtmlElement	niceOfResponse(@NotNull String title, @NotNull Object httpServletResponse, CharSequence... cssLinks) Create new instance with empty html headers
static @NotNull HtmlElement	of(@NotNull Appendable writer, @NotNull HtmlConfig myConfig) Create root element for a required element name.
static @NotNull HtmlElement	of(@Nullable HtmlConfig config) Create new instance with empty html headers
static @NotNull HtmlElement	of(@NotNull CharSequence title, @NotNull Appendable response, CharSequence... cssLinks) Create new instance with empty html headers
static @NotNull HtmlElement	of(@NotNull CharSequence title, @NotNull Appendable response, @NotNull Charset charset, CharSequence... cssLinks) Create new instance with empty html headers
static @NotNull HtmlElement	of(@NotNull RContext context, @NotNull HtmlConfig myConfig) Create root element for a required element name.
static @NotNull HtmlElement	ofServlet(@NotNull Object htmlServletResponse, @Nullable HtmlConfig config) Create new instance with empty html headers, The MAIN servlet factory method.
static @NotNull HtmlElement	ofServlet(@NotNull String title, @NotNull Object htmlServletResponse, CharSequence... cssLinks) Create new instance with empty html headers
@NotNull Element	original() Get an original root element
Element	setAttribute(String name, Object value) Set an attribute
@NotNull ExceptionProvider	then(@NotNull Consumer<HtmlElement> builder) Deprecated. Use the method next(Consumer) rather.
@NotNull 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(@NotNull
                   @NotNull HtmlConfig config,
                   @NotNull
                   @NotNull Appendable writer)

Create new instance with empty html headers

HtmlElement

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

Create new instance with empty html headers

Method Detail

getName

@NotNull
public @NotNull 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 AbstractWriter.writeValue(Object, ApiElement, String) 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 AbstractWriter.writeValue(Object, ApiElement, String) } method, where the default implementation calls a toString() only.

Returns:

This instance

addTextTemplated

public Element addTextTemplated(@NotNull
                                @NotNull CharSequence template,
                                @NotNull
                                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

public Element addCDATA(CharSequence charData)

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

@NotNull
public final @NotNull Element addElement(@NotNull
                                                  @NotNull 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

@NotNull
public @NotNull Element getBody()

Returns a body element

addBody

@NotNull
public @NotNull Element addBody()

Returns a body element

addJavascriptLinks

public void addJavascriptLinks(boolean defer,
                               @NotNull
                               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,
                                 @NotNull
                                 @NotNull 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:

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(@NotNull
                        CharSequence... css)

Create a new CSS element and return it

Parameters:

css - Add a CSS link

addCssLink

public Element addCssLink(@NotNull
                          @NotNull CharSequence css)

Create a new CSS element and return it

Parameters:

css - Add a CSS link

Returns:

New CSS element

addCssBody

public Element addCssBody(@NotNull
                          @NotNull CharSequence css)

Create a new CSS element and return it

Parameters:

css - CSS content

Returns:

New CSS element

addCssBodies

public Element addCssBodies(@NotNull
                            @NotNull CharSequence lineSeparator,
                            @NotNull
                            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

@NotNull
public @NotNull Element original()

Get an original root element

toString

@NotNull
public @NotNull 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

@NotNull
public @NotNull HtmlConfig getConfig()

Get config

getTitle

public CharSequence getTitle()

Get title of configuration

of

@NotNull
public static @NotNull HtmlElement of(@NotNull
                                               @NotNull Appendable writer,
                                               @NotNull
                                               @NotNull HtmlConfig myConfig)
                                        throws IllegalStateException

Create root element for a required element name. The MAIN factory method.

Throws:

IllegalStateException

of

@NotNull
public static @NotNull HtmlElement of(@NotNull
                                               @NotNull RContext context,
                                               @NotNull
                                               @NotNull HtmlConfig myConfig)

Create root element for a required element name. The MAIN factory method.

ofServlet

@NotNull
public static @NotNull HtmlElement ofServlet(@NotNull
                                                      @NotNull Object htmlServletResponse,
                                                      @Nullable
                                                      @Nullable HtmlConfig config)

Create new instance with empty html headers, The MAIN servlet factory method.

Throws:

IllegalStateException - IO exceptions

See Also:

Appendable

ofServlet

@NotNull
public static @NotNull HtmlElement ofServlet(@NotNull
                                                      @NotNull String title,
                                                      @NotNull
                                                      @NotNull Object htmlServletResponse,
                                                      @NotNull
                                                      CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

Appendable

of

@NotNull
public static @NotNull HtmlElement of(@NotNull
                                               @NotNull CharSequence title,
                                               @NotNull
                                               @NotNull Appendable response,
                                               @NotNull
                                               CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

Appendable

of

@NotNull
public static @NotNull HtmlElement of(@NotNull
                                               @NotNull CharSequence title,
                                               @NotNull
                                               @NotNull Appendable response,
                                               @NotNull
                                               @NotNull Charset charset,
                                               @NotNull
                                               CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

Appendable

niceOf

@NotNull
public static @NotNull HtmlElement niceOf(@NotNull
                                                   @NotNull CharSequence title,
                                                   @NotNull
                                                   @NotNull Appendable response,
                                                   @NotNull
                                                   CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

Appendable

niceOf

@NotNull
public static @NotNull HtmlElement niceOf(@NotNull
                                                   @NotNull CharSequence title,
                                                   @NotNull
                                                   @NotNull Appendable response,
                                                   @NotNull
                                                   @NotNull Charset charset,
                                                   @NotNull
                                                   CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

Appendable

niceOfResponse

@NotNull
public static @NotNull HtmlElement niceOfResponse(@NotNull
                                                           @NotNull String title,
                                                           @NotNull
                                                           @NotNull Object httpServletResponse,
                                                           @NotNull
                                                           CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

Appendable

niceOfResponse

@NotNull
public static @NotNull HtmlElement niceOfResponse(@NotNull
                                                           @NotNull Object httpServletResponse,
                                                           @NotNull
                                                           CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

Appendable

niceOf

@NotNull
public static @NotNull HtmlElement niceOf(@NotNull
                                                   @NotNull String title,
                                                   @NotNull
                                                   @NotNull RContext context,
                                                   @NotNull
                                                   CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

Appendable

niceOf

@NotNull
public static @NotNull HtmlElement niceOf(@NotNull
                                                   @NotNull String title,
                                                   @NotNull
                                                   @NotNull Appendable response,
                                                   @NotNull
                                                   CharSequence... cssLinks)

Create new instance with empty html headers

Throws:

IllegalStateException - IO exceptions

See Also:

Appendable

of

@NotNull
public static @NotNull HtmlElement of(@Nullable
                                               @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

then

@NotNull
public final @NotNull ExceptionProvider then(@NotNull
                                                      @NotNull Consumer<HtmlElement> builder)

Deprecated. Use the method next(Consumer) rather.

Apply body of element by a lambda expression.

next

@NotNull
public @NotNull ExceptionProvider next(@NotNull
                                                @NotNull Consumer<HtmlElement> builder)

Add nested elements to the element.

Usage

  HtmlElement.of(config, writer).addBody()
      .next(body -> {
         body.addHeading(config.getTitle());
      })
      .catche(e -> {
          logger.log(Level.SEVERE, "An error", e);
      });