org.ujorm.tools.dom

Class HtmlElement

java.lang.Object

org.ujorm.tools.dom.XmlElement

org.ujorm.tools.dom.HtmlElement

All Implemented Interfaces:

Element

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!");
 HttpServletResponse response = new MockHttpServletResponse();
 html.toResponse(response, false);
 

Since:

1.86

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.dom.XmlElement

XmlElement.RawEnvelope

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEADER XML header
protected Charset	charset Charset

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

name

Fields inherited from interface org.ujorm.tools.dom.Element

CDATA_BEG, CDATA_END, COMMENT_BEG, COMMENT_END, CHAR_NEW_LINE, CHAR_SPACE, XML_2QUOT, XML_AMP, XML_GT, XML_LT, XML_QUOT

Constructor Summary

Constructors

Constructor and Description
HtmlElement(CharSequence title) Constructor for codepage UTF-8
HtmlElement(CharSequence title, Charset charset) Generaic Constructor

Method Summary

Modifier and Type	Method and Description
<T extends Element> T	addCssBody(String css) Create a new CSS element and return it
<T extends Element> T	addCssLink(String css) Create a new CSS element and return it
<T extends Element> T	addElementToBody(CharSequence name) A shortcut for HtmlList.getBody().addElement(CharSequence)
<T extends Element> T	addElementToHead(CharSequence name) A shortcut for HtmlList.getHead().addElement(CharSequence)
<T extends Element> T	getBody() Returns body element
<T extends Element> T	getHead() Returns header element
void	toResponse(Object httpServletResponse, boolean noCache) Render the component to a HTML response
String	toString() Render the HTML code including header

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

addAttrib, addCDATA, addComment, addElement, addElement, addRawText, addText, addTextWithSpace, getAttribs, getChildren, toWriter, writeValue

Methods inherited from class java.lang.Object

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

Field Detail

HEADER

public static final String HEADER

XML header

See Also:

Constant Field Values

charset

@Nonnull
protected final Charset charset

Charset

Constructor Detail

HtmlElement

public HtmlElement(@Nonnull
                   CharSequence title)

Constructor for codepage UTF-8

HtmlElement

public HtmlElement(@Nonnull
                   CharSequence title,
                   @Nonnull
                   Charset charset)

Generaic Constructor

Method Detail

getHead

@Nonnull
public <T extends Element> T getHead()

Returns header element

getBody

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

Returns body element

addElementToHead

public <T extends Element> T addElementToHead(@Nonnull
                                              CharSequence 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 Element> T addElementToBody(@Nonnull
                                              CharSequence name)

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

Parameters:

name - A name of the new XmlElement is requred.

Returns:

The new XmlElement!

addCssLink

public <T extends Element> T addCssLink(String css)

Create a new CSS element and return it

Parameters:

css - Add a CSS link

Returns:

New CSS element

addCssBody

public <T extends Element> T addCssBody(@Nullable
                                        String 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 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