org.ujorm.tools.xml.dom

Class HtmlElement

java.lang.Object

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

org.ujorm.tools.xml.dom.XmlElement

org.ujorm.tools.xml.dom.HtmlElement

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable

public class HtmlElement
extends XmlElement

XML element model to rendering a HTML file

How to use the class:

 final HtmlElement html = new HtmlElement("Test");
 html.getBody().addElement("div")
               .addText("Hello word!");
 html.toResponse(new MockHttpServletResponse(), false);
 

Since:

1.86

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HtmlElement.Html Some HTML constants

Nested classes/interfaces inherited from class org.ujorm.tools.xml.dom.XmlElement

XmlElement.RawEnvelope

Field Summary

Fields

Modifier and Type	Field and Description
protected Charset	charset Charset

Fields inherited from class org.ujorm.tools.xml.dom.XmlElement

attributes, children

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

DEFAULT_INTENDATION, HTML_DOCTYPE, name, REQUIRED_MSG, XML_HEADER

Constructor Summary

Constructors

Constructor and Description
HtmlElement(Charset charset) Create new instance with empty html headers
HtmlElement(Object title, CharSequence... cssLinks) Constructor buliding default html headers with codepage UTF-8
HtmlElement(Object title, Charset charset, CharSequence... cssLinks) Generic constructor buliding default html headers

Method Summary

Modifier and Type	Method and Description
<T extends XmlElement> T	addCssBody(CharSequence css) Create a new CSS element and return it
<T extends XmlElement> T	addCssLink(CharSequence css) Create a new CSS element and return it
<T extends XmlElement> T	addElementToBody(String name) A shortcut for HtmlList.getBody().addElement(CharSequence)
<T extends XmlElement> T	addElementToHead(String name) A shortcut for HtmlList.getHead().addElement(CharSequence)
<T extends XmlElement> T	addJavascriptContent(CharSequence javascript) Create a new Javascript element and return it
<T extends XmlElement> T	addJavascriptLink(boolean defer, CharSequence... javascriptLink) Create a new Javascript element and return it
<T extends XmlElement> T	getBody() Returns body element
<T extends XmlElement> T	getHead() Deprecated. Use the method addElementToHead(java.lang.String) rather.
void	toNiceResponse(Object httpServletResponse) Render the result with an indentation
void	toResponse(Object httpServletResponse, boolean noCache) Render the component to a HTML response
void	toResponse(Object httpServletResponse, boolean noCache, boolean indentation) Render the result
String	toString() Render the HTML code including header
XmlWriter	toWriter(XmlWriter xmlWriter) Render the component to a XmlWriter

Methods inherited from class org.ujorm.tools.xml.dom.XmlElement

addAttrib, addCDATA, addComment, addElement, addElement, addChild, addRawText, addText, close, getAttribs, getAttributes, getChildren, setAttrib, toWriter

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

charset

@Nonnull
protected final Charset charset

Charset

Constructor Detail

HtmlElement

public HtmlElement(@Nonnull
                   Charset charset)

Create new instance with empty html headers

HtmlElement

public HtmlElement(@Nonnull
                   Object title,
                   @Nullable
                   CharSequence... cssLinks)

Constructor buliding default html headers with codepage UTF-8

HtmlElement

public HtmlElement(@Nonnull
                   Object title,
                   @Nonnull
                   Charset charset,
                   @Nullable
                   CharSequence... cssLinks)

Generic constructor buliding default html headers

Parameters:

title - Htmlpage title

charset - A charset

cssLinks - Nullable CSS link array

Method Detail

getHead

@Nonnull
 @Deprecated
public <T extends XmlElement> T getHead()

Deprecated. Use the method addElementToHead(java.lang.String) rather.

Returns body element

getBody

@Nonnull
public <T extends XmlElement> T getBody()

Returns body element

addElementToHead

public <T extends XmlElement> T addElementToHead(@Nonnull
                                                 String name)

A shortcut for HtmlList.getHead().addElement(CharSequence)

Parameters:

name - A name of the new XmlElement is requred.

Returns:

The new XmlElement!

addElementToBody

public <T extends XmlElement> T addElementToBody(@Nonnull
                                                 String name)

A shortcut for HtmlList.getBody().addElement(CharSequence)

Parameters:

name - A name of the new XmlElement is requred.

Returns:

The new XmlElement!

addJavascriptLink

public <T extends XmlElement> T 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:

addJavascriptContent

public <T extends XmlElement> T addJavascriptContent(@Nonnull
                                                     CharSequence javascript)

Create a new Javascript element and return it

Parameters:

javascript - Add a javascriptLink link

Returns:

New CSS element

addCssLink

public <T extends XmlElement> T addCssLink(@Nonnull
                                           CharSequence css)

Create a new CSS element and return it

Parameters:

css - Add a CSS link

Returns:

New CSS element

addCssBody

public <T extends XmlElement> T addCssBody(@Nonnull
                                           CharSequence css)

Create a new CSS element and return it

Parameters:

css - CSS content

Returns:

New CSS element

toString

@Nonnull
public String toString()
                         throws IllegalStateException

Render the HTML code including header

Overrides:

toString in class XmlElement

Throws:

IllegalStateException

toResponse

public final void toResponse(@Nonnull
                             Object httpServletResponse,
                             boolean noCache)
                      throws IOException,
                             IllegalArgumentException

Render the component to a HTML response

Parameters:

httpServletResponse - Argument type of javax.servlet.http.HttpServletResponse is required.

noCache - Add a header attributes to switch off a cache.

Throws:

IOException - An writting error.

IllegalArgumentException - Wrong argument type

toNiceResponse

public final void toNiceResponse(@Nonnull
                                 Object httpServletResponse)
                          throws IOException,
                                 IllegalArgumentException

Render the result with an indentation

Throws:

IOException

IllegalArgumentException

toResponse

public void toResponse(@Nonnull
                       Object httpServletResponse,
                       boolean noCache,
                       boolean indentation)
                throws IOException,
                       IllegalArgumentException

Render the result

Parameters:

httpServletResponse -

noCache -

indentation -

Throws:

IOException

IllegalArgumentException

toWriter

public XmlWriter toWriter(@Nonnull
                          XmlWriter xmlWriter)
                   throws IOException,
                          IllegalArgumentException

Render the component to a XmlWriter

Parameters:

xmlWriter - An instance of the XmlWriter is required.

Throws:

IOException - An writting error.

IllegalArgumentException - Wrong argument type