org.josef.web.html

Class AbstractHtmlWriter

java.lang.Object

org.josef.web.html.AbstractHtmlWriter

Direct Known Subclasses:

HtmlStringWriter

public abstract class AbstractHtmlWriter
extends Object

Abstract Writer to write HTML code.
This is a rather simple implementation to sequentially write out HTML code. It supports simple methods to add text, as-is and some higher level methods that will take some generation of HTML code out of your hands. Both type of methods can be mixed.

Version:

1.0 $Revision: 6298 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
AbstractHtmlWriter()

Method Summary

Modifier and Type	Method and Description
abstract AbstractHtmlWriter	write(Object text) The single abstract method that must be implemented by concrete sub classes.
AbstractHtmlWriter	writeAttributes(String... attributeNameValues) Writes the supplied attributeNameValues.
AbstractHtmlWriter	writeDocType(String docType) Writes a doc type plus a line separator.
AbstractHtmlWriter	writeEnclose(String tag, Object text, String... attributeNameValues) Writes the supplied text, enclosed within the supplied tag.
AbstractHtmlWriter	writeEndTag(String tag) Writes an HTML end tag plus a line separator.
AbstractHtmlWriter	writeln() Writes a line separator.
AbstractHtmlWriter	writeln(Object text) Writes the supplied text and adds a line separator.
AbstractHtmlWriter	writeStartEndTag(String tag, String... attributeNameValues) Writes an HTML start/end tag plus a line separator.
AbstractHtmlWriter	writeStartTag(String tag, String... attributeNameValues) Writes an HTML start tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHtmlWriter

public AbstractHtmlWriter()

Method Detail

write

public abstract AbstractHtmlWriter write(Object text)

The single abstract method that must be implemented by concrete sub classes.
This is the method that actually write HTML code.

Parameters:

text - The text to write.
The supplied text will be converted to a String by calling Object.toString().

Returns:

This AbstractHtmlWriter to support chaining of method calls.

writeDocType

public AbstractHtmlWriter writeDocType(String docType)

Writes a doc type plus a line separator.

Parameters:

docType - The doc type to write or null to write a default doc type.

Returns:

This AbstractHtmlWriter to support chaining of method calls.

writeln

public AbstractHtmlWriter writeln(Object text)

Writes the supplied text and adds a line separator.

Parameters:

text - The text to write.

Returns:

This AbstractHtmlWriter to support chaining of method calls.

writeln

public AbstractHtmlWriter writeln()

Writes a line separator.

Returns:

This AbstractHtmlWriter to support chaining of method calls.

writeStartTag

public AbstractHtmlWriter writeStartTag(String tag,
                                        String... attributeNameValues)

Writes an HTML start tag.
Example: writeStartTag("table", "cols='3'");
Would result in: <table cols='3'> to be written.

Parameters:

tag - The tag to write.

attributeNameValues - Optional attributes, consisting of name=value pairs.

Returns:

This AbstractHtmlWriter to support chaining of method calls.

Throws:

IllegalArgumentException - When the supplied tag is empty.

NullPointerException - When the supplied tag is null.

writeStartEndTag

public AbstractHtmlWriter writeStartEndTag(String tag,
                                           String... attributeNameValues)

Writes an HTML start/end tag plus a line separator.
Example: writeStartEndTag("panelGroup");
Would result in: <panelGroup/> to be written.

Parameters:

tag - The start/end tag to write.

attributeNameValues - Optional attributes, consisting of name=value pairs.

Returns:

This AbstractHtmlWriter to support chaining of method calls.

Throws:

IllegalArgumentException - When the supplied tag is empty.

NullPointerException - When the supplied tag is null.

writeEndTag

public AbstractHtmlWriter writeEndTag(String tag)

Writes an HTML end tag plus a line separator.
Example: writeEndTag("table");
Would result in: &lt;/table&gt; to be written.

Parameters:

tag - The end tag to write.

Returns:

This AbstractHtmlWriter to support chaining of method calls.

Throws:

IllegalArgumentException - When the supplied tag is empty.

NullPointerException - When the supplied tag is null.

writeAttributes

public AbstractHtmlWriter writeAttributes(String... attributeNameValues)

Writes the supplied attributeNameValues.

Parameters:

attributeNameValues - Attributes, consisting of name=value pairs.

Returns:

This AbstractHtmlWriter to support chaining of method calls.

writeEnclose

public AbstractHtmlWriter writeEnclose(String tag,
                                       Object text,
                                       String... attributeNameValues)

Writes the supplied text, enclosed within the supplied tag.
The written line ends with a line separator.
Example: writelnEnclose("td", "Red");
Would result in: <td>Red</td> to be written.

Parameters:

tag - The HTML tag.

text - The text to enclose within the supplied tag.

attributeNameValues - Optional attributes, consisting of name=value pairs.

Returns:

This AbstractHtmlWriter to support chaining of method calls.

Throws:

IllegalArgumentException - When the supplied tag is empty.

NullPointerException - When the supplied tag is null.