org.josef.web.html

Class HtmlElement

java.lang.Object

org.josef.web.html.HtmlEmptyElement

org.josef.web.html.HtmlElement

Direct Known Subclasses:

HtmlRow, HtmlTable

public class HtmlElement
extends HtmlEmptyElement

Utility class to create HTML output created from HtmlElement instances.
It can be used to create an entire HTML page but it is also possible to create fragments, like a paragraph for example. Use it for example in combination with the HtmlTable class to create tables.
For any serious work consider using the "org.w3c.dom.html" package.
Example 1: Create a simple html page with a title and single paragraph.

 HtmlElement root = new HtmlElement();
 root.findElement("head").addChild(new HtmlElement("title", "The title"));
 root.findElement("body").addChild(new HtmlElement("p", "The paragraph's text"));
 System.out.println(root.toHtml());
 

Example 2: Create an HTML page with a simple form that has some attributes.

 HtmlElement root = new HtmlElement();
 root.findElement("body").addChild(new HtmlElement("form",
 new HtmlAttribute("id", "loginForm"), new HtmlAttribute("onclick", "alert(\"hello\"")));
 System.out.println(root.toHtml());
 

Version:

1.0 $Revision: 5772 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
HtmlElement() Constructs the root "html" element with nested "head" and "body" tags.
HtmlElement(String name) Constructs this HTML element from the supplied (element) name.
HtmlElement(String name, HtmlAttribute... attributes) Constructs this HTML element from the supplied (element) name and attributes.
HtmlElement(String name, String content) Constructs this HTML element from the supplied (element) name and content.
HtmlElement(String name, String content, HtmlAttribute... attributes) Constructs this HTML element from the supplied (element) name, content and attributes.

Method Summary

Modifier and Type	Method and Description
HtmlElement	addChild(HtmlElement element) Adds the supplied element as a child element of this HTML element.
HtmlElement	addContent(String content) Adds the supplied content to the content of this HTML element.
HtmlElement	findElement(String name) Finds the HTML element with the supplied name (case insensitive).
String	getContent() Gets the content of this HtmlElement.
String	toFormattedHtml() Creates a formatted HTML representation of this HTML element, including its attributes, content and children.
String	toHtml() Creates an HTML representation of this HTML element, including its attributes, content and children.

Methods inherited from class org.josef.web.html.HtmlEmptyElement

getName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlElement

public HtmlElement()

Constructs the root "html" element with nested "head" and "body" tags.

HtmlElement

public HtmlElement(String name)

Constructs this HTML element from the supplied (element) name.

Parameters:

name - Name of this HTML element.

Throws:

NullPointerException - When the supplied name is null.

IllegalArgumentException - When the supplied name is empty.

HtmlElement

public HtmlElement(String name,
                   String content)

Constructs this HTML element from the supplied (element) name and content.

Parameters:

name - Name of this HTML element.

content - The content of this HTML element.

Throws:

NullPointerException - When the supplied name is null.

IllegalArgumentException - When the supplied name is empty.

HtmlElement

public HtmlElement(String name,
                   HtmlAttribute... attributes)

Constructs this HTML element from the supplied (element) name and attributes.

Parameters:

name - Name of this HTML element.

attributes - The optional attributes of this HTML element.

Throws:

NullPointerException - When the supplied name is null.

IllegalArgumentException - When the supplied name is empty.

HtmlElement

public HtmlElement(String name,
                   String content,
                   HtmlAttribute... attributes)

Constructs this HTML element from the supplied (element) name, content and attributes.

Parameters:

name - Name of this HTML element.

content - The content of this HTML element.

attributes - The optional attributes of this HTML element.

Throws:

NullPointerException - When the supplied name is null.

IllegalArgumentException - When the supplied name is empty.

Method Detail

addContent

public HtmlElement addContent(String content)

Adds the supplied content to the content of this HTML element.

Parameters:

content - The content to add to the content of this HTML element.

Returns:

This element.

Throws:

NullPointerException - When the supplied content is null.

getContent

public String getContent()

Gets the content of this HtmlElement.

Returns:

The content of this HtmlElement or null when this HtmlElement has no content.

addChild

public HtmlElement addChild(HtmlElement element)

Adds the supplied element as a child element of this HTML element.

Parameters:

element - The element to add as a child of this HTML element.

Returns:

The supplied child element.

Throws:

NullPointerException - When the supplied element is null.

findElement

public HtmlElement findElement(String name)

Finds the HTML element with the supplied name (case insensitive).

Parameters:

name - The name of the HTML element to find.

Returns:

The HTML element with the supplied name or null when no such HTML element could be found.

toHtml

public String toHtml()

Creates an HTML representation of this HTML element, including its attributes, content and children.

Overrides:

toHtml in class HtmlEmptyElement

Returns:

An HTML representation of this HTML element, including its attributes, content and children.

toFormattedHtml

public String toFormattedHtml()

Creates a formatted HTML representation of this HTML element, including its attributes, content and children.

Returns:

A formatted HTML representation of this HTML element, including its attributes, content and children.