Package com.googlecode.jatl

Class HtmlWriter

java.lang.Object

com.googlecode.jatl.MarkupBuilder<T>

com.googlecode.jatl.GeneratedHtmlBuilder<T>

com.googlecode.jatl.HtmlBuilder<HtmlWriter>

com.googlecode.jatl.HtmlWriter

All Implemented Interfaces:

MarkupBuilderWriter, MarkupWriter

public abstract class HtmlWriter
extends HtmlBuilder<HtmlWriter>
implements MarkupBuilderWriter

Writes HTML using an HtmlBuilder by calling write(Writer).

Example:

        html = new HtmlWriter() {
                protected void build() {
                        html().head().end().body();
                        text("Hello");
                        done();
                }
        };
        //Now write.
        String actual = html.write(writer).getBuffer().toString();
 

See Also:

MarkupWriter

Nested Class Summary

Nested classes/interfaces inherited from class com.googlecode.jatl.MarkupBuilder

MarkupBuilder.TagClosingPolicy

Field Summary

Fields inherited from class com.googlecode.jatl.MarkupBuilder

indentOff, indentOn, indentSameLine

Constructor Summary

Constructors

Constructor	Description
HtmlWriter()

Method Summary

Modifier and Type	Method	Description
protected abstract void	build()	Should build the markup and is called by write(Writer).
protected HtmlWriter	getSelf()	Needed for fluent style and Java parameterization limitations.
<W extends java.io.Writer> W	write(W writer)	Writes using the given writer.
<W extends java.io.Writer> W	write(W writer, int depth)	Writes using the given writer at the given depth.

Methods inherited from class com.googlecode.jatl.HtmlBuilder

checkbox, checkbox, escapeMarkup, option

Methods inherited from class com.googlecode.jatl.GeneratedHtmlBuilder

a, abbr, abbr, accept, acceptCharset, accesskey, acronym, action, address, align, alink, alt, applet, archive, area, axis, b, background, base, basefont, bdo, bgcolor, big, blockquote, body, border, br, button, caption, cellpadding, cellspacing, center, charAttr, charoff, charset, checked, cite, cite, classAttr, classid, clear, code, code, codebase, codetype, col, colgroup, color, cols, colspan, compact, content, coords, data, datetime, dd, declare, defer, del, dfn, dir, dir, disabled, div, dl, dt, em, enctype, face, fieldset, font, forAttr, form, frame, frameborder, h1, h2, h3, h4, h5, h6, head, headers, height, hr, href, hreflang, hspace, html, httpEquiv, i, id, iframe, img, input, ins, isindex, ismap, kbd, label, label, lang, language, legend, li, link, link, longdesc, map, marginheight, marginwidth, maxlength, media, menu, meta, method, multiple, name, noframes, nohref, noscript, noshade, nowrap, object, object, ol, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onload, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onreset, onselect, onsubmit, onunload, optgroup, option, p, param, pre, profile, prompt, q, readonly, rel, rev, rows, rowspan, rules, s, samp, scheme, scope, script, scrolling, select, selected, shape, size, small, span, span, src, standby, startAttr, strike, strong, style, style, sub, summary, sup, tabindex, table, target, tbody, td, textarea, textAttr, tfoot, th, thead, title, title, tr, tt, type, u, ul, usemap, valign, value, valuetype, var, vlink, vspace, width

Methods inherited from class com.googlecode.jatl.MarkupBuilder

attr, bind, bind, done, end, end, endAll, escapeAttributeMarkup, escapeElementMarkup, indent, ns, ns, raw, raw, setDepth, setWriter, start, start, text, unbind, write, xmlns, xmlns

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlWriter

public HtmlWriter()

Method Detail

getSelf

protected HtmlWriter getSelf()

Description copied from class: MarkupBuilder

Needed for fluent style and Java parameterization limitations. Almost all public methods should return whatever this method returns.

Most implementations only have to do:

 return this;
 

Specified by:

getSelf in class MarkupBuilder<HtmlWriter>

Returns:

the current builder which is usually this object.

write

public <W extends java.io.Writer> W write(W writer)

Description copied from interface: MarkupWriter

Writes using the given writer. The writer should not be closed and will not be closed by implementations. Its up to the caller to close the writer.

Specified by:

write in interface MarkupWriter

Type Parameters:

W - writer type.

Parameters:

writer - not null.

Returns:

the writer used for fluent style.

write

public <W extends java.io.Writer> W write(W writer,
                                          int depth)

Description copied from interface: MarkupBuilderWriter

Writes using the given writer at the given depth. The writer should not be closed and will not be closed by implementations. Its up to the caller to close the writer.

Specified by:

write in interface MarkupBuilderWriter

Type Parameters:

W - writer type.

Parameters:

writer - not null.

depth - the indent depth to start at.

Returns:

the writer used for fluent style.

See Also:

MarkupBuilder.write(MarkupWriter...)

build

protected abstract void build()

Should build the markup and is called by write(Writer).

See Also:

MarkupBuilder