uk.ac.ed.epcc.webapp.content

Class HtmlWriter

java.lang.Object

uk.ac.ed.epcc.webapp.content.AbstractXMLBuilder

uk.ac.ed.epcc.webapp.content.XMLWriter

uk.ac.ed.epcc.webapp.content.HtmlWriter

All Implemented Interfaces:

ContentBuilder, ExtendedXMLBuilder, SimpleXMLBuilder, XMLContentBuilder, Contexed

public class HtmlWriter
extends XMLWriter
implements Contexed, XMLContentBuilder

A streaming version of the XMLContentBuilder

See Also:

HtmlBuilder

Field Summary

Fields inherited from interface uk.ac.ed.epcc.webapp.content.XMLContentBuilder

STREAM_BUILDER_FEATURE

Constructor Summary

Constructors

Constructor and Description
HtmlWriter(AppContext c, java.io.Writer w)

Method Summary

Modifier and Type	Method and Description
ContentBuilder	addParent() append a nested panel to its parent content.
AppContext	getContext()
HtmlFormPolicy	getFormPolicy()
ContentBuilder	getHeading(int level) create a ContentBuilder that appends its contents as a heading when the ContentBuilder.addParent() method is called.
Logger	getLogger(AppContext conn)
ContentBuilder	getPanel(java.lang.String... type) create a nested content panel
ContentBuilder	getPanel(java.lang.String type)
ExtendedXMLBuilder	getSpan() create a ExtendedXMLBuilder that appends its contents as XML text when the SimpleXMLBuilder.appendParent() method is called.
ExtendedXMLBuilder	getText() create a ExtendedXMLBuilder that appends its contents as XML text when the SimpleXMLBuilder.appendParent() method is called.
boolean	setNewTab(boolean new_tab)
boolean	useNewTab()

Methods inherited from class uk.ac.ed.epcc.webapp.content.XMLWriter

append, append, appendParent, getNested, getParent, setWriter

Methods inherited from class uk.ac.ed.epcc.webapp.content.AbstractXMLBuilder

addClass, append, attr, attr, badAttribute, br, clean, clean, clean, cleanFormatted, clear, close, closeElement, doClean, doClean, endOpen, getAttribute, getEscapeUnicode, getTags, getValidXML, isInOpen, longLines, matched, nbs, open, open, openElement, setEscapeUnicode, setValidXML

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.content.XMLContentBuilder

addActionButtons, addButton, addButton, addColumn, addFormInput, addFormLabel, addFormTable, addHeading, addImage, addLink, addLink, addList, addList, addList, addNumberedList, addObject, addTable, addTable, addTable, addTable, addText, append, canAdd, closeDetails, getDetails

Methods inherited from interface uk.ac.ed.epcc.webapp.content.ContentBuilder

addActionButtons, addFormLabel, cleanFormatted, getSpan

Methods inherited from interface uk.ac.ed.epcc.webapp.content.ExtendedXMLBuilder

addClass, br, nbs

Methods inherited from interface uk.ac.ed.epcc.webapp.content.SimpleXMLBuilder

appendParent, attr, attr, clean, clean, clean, close, getNested, getParent, open, open, setEscapeUnicode

Constructor Detail

HtmlWriter

public HtmlWriter(AppContext c,
                  java.io.Writer w)

Parameters:

w -

Method Detail

getText

public ExtendedXMLBuilder getText()

Description copied from interface: ContentBuilder

create a ExtendedXMLBuilder that appends its contents as XML text when the SimpleXMLBuilder.appendParent() method is called. Normally this represents a separate paragraph of text but this can be mapped onto ContentBuilder.getSpan() where this does not make sense for example where the ContentBuilder represents a heading or table cell.

Specified by:

getText in interface ContentBuilder

Returns:

ExtendedXMLBuilder

getSpan

public ExtendedXMLBuilder getSpan()

Description copied from interface: ContentBuilder

create a ExtendedXMLBuilder that appends its contents as XML text when the SimpleXMLBuilder.appendParent() method is called. This is intended for in-line text rather than creating a paragraph.

Specified by:

getSpan in interface ContentBuilder

Returns:

ExtendedXMLBuilder

getHeading

public ContentBuilder getHeading(int level)

Description copied from interface: ContentBuilder

create a ContentBuilder that appends its contents as a heading when the ContentBuilder.addParent() method is called. If the heading is to only contain text use the ContentBuilder.addHeading(int, String) method.

Specified by:

getHeading in interface ContentBuilder

Parameters:

level - level of heading

Returns:

ContentBuilder for header

getPanel

public ContentBuilder getPanel(java.lang.String... type)
                        throws java.lang.UnsupportedOperationException

Description copied from interface: ContentBuilder

create a nested content panel

Specified by:

getPanel in interface ContentBuilder

Parameters:

type - Strings specifying a formatting types for the panel.

Returns:

ContentBuilder for panel

Throws:

java.lang.UnsupportedOperationException

getPanel

public ContentBuilder getPanel(java.lang.String type)
                        throws java.lang.UnsupportedOperationException

Throws:

java.lang.UnsupportedOperationException

addParent

public ContentBuilder addParent()
                         throws java.lang.UnsupportedOperationException

Description copied from interface: ContentBuilder

append a nested panel to its parent content.

Specified by:

addParent in interface ContentBuilder

Returns:

parent ContentBuilder

Throws:

java.lang.UnsupportedOperationException

getLogger

public Logger getLogger(AppContext conn)

Specified by:

getLogger in interface XMLContentBuilder

useNewTab

public boolean useNewTab()

Specified by:

useNewTab in interface XMLContentBuilder

setNewTab

public boolean setNewTab(boolean new_tab)

Specified by:

setNewTab in interface XMLContentBuilder

getContext

public AppContext getContext()

Specified by:

getContext in interface Contexed

getFormPolicy

public HtmlFormPolicy getFormPolicy()

Specified by:

getFormPolicy in interface XMLContentBuilder