uk.ac.ed.epcc.webapp.content

Class HtmlBuilder

java.lang.Object

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

uk.ac.ed.epcc.webapp.content.XMLPrinter

uk.ac.ed.epcc.webapp.content.HtmlPrinter

uk.ac.ed.epcc.webapp.content.HtmlBuilder

All Implemented Interfaces:

ContentBuilder, ExtendedXMLBuilder, SimpleXMLBuilder, XMLContentBuilder

Direct Known Subclasses:

HtmlBuilder.Panel

public class HtmlBuilder
extends HtmlPrinter
implements XMLContentBuilder

A HtmlPrinter that also implements ContentBuilder in terms of web based interfaces.

See Also:

HtmlWriter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	HtmlBuilder.Heading
static class	HtmlBuilder.Panel A nested HtmlBuilder representing an element.
protected static class	HtmlBuilder.SpanText A HtmlBuilder.Panel for in-line text.
protected static class	HtmlBuilder.Text

Field Summary

Fields

Modifier and Type	Field and Description
static Feature	HTML_TABLE_HEADER_SCOPE_FEATURE
static Feature	HTML_TABLE_SECTIONS_FEATURE

Fields inherited from class uk.ac.ed.epcc.webapp.content.XMLPrinter

sb

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

STREAM_BUILDER_FEATURE

Constructor Summary

Constructors

Constructor and Description
HtmlBuilder()
HtmlBuilder(AbstractXMLBuilder parent)

Method Summary

Modifier and Type	Method and Description
void	addActionButtons(Form f, java.lang.String legend, java.util.Set<java.lang.String> actions) A a set of action buttons to the content
ContentBuilder	addParent() append a nested panel to its parent content.
void	addScript(java.lang.String script) Add a script element to HTML.
void	addScriptFile(java.lang.String path)
<C,R> void	addTable(AppContext conn, Table<C,R> t, java.text.NumberFormat nf, java.lang.String style) Add a table to the content.
void	closeDetails() finish a section started by ContentBuilder.getDetails(Object) this may be a no-op if expended section are not supported
ContentBuilder	getDetails(java.lang.Object summary_text) get an expanding/folding section if supported This method can either return a new ContentBuilder or the current object.
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.
void	paragraph(java.lang.String text)
boolean	setNewTab(boolean new_tab)
void	setTableSections(boolean value)
static java.lang.String	strip(java.lang.String input)
boolean	useNewTab()

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

append, append, appendParent, appendTo, clear, getNested, getParent, hasContent, toString

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

addClass, append, attr, attr, badAttribute, br, clean, clean, clean, cleanFormatted, 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, wait, wait, wait

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

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

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

Field Detail

HTML_TABLE_SECTIONS_FEATURE

public static final Feature HTML_TABLE_SECTIONS_FEATURE

HTML_TABLE_HEADER_SCOPE_FEATURE

public static final Feature HTML_TABLE_HEADER_SCOPE_FEATURE

Constructor Detail

HtmlBuilder

public HtmlBuilder()

HtmlBuilder

public HtmlBuilder(AbstractXMLBuilder parent)

Method Detail

addTable

public <C,R> void addTable(AppContext conn,
                           Table<C,R> t,
                           java.text.NumberFormat nf,
                           java.lang.String style)

Description copied from interface: ContentBuilder

Add a table to the content. Table content that implements UIGenerator should be added via UIGenerator.addContent(ContentBuilder)

Specified by:

addTable in interface ContentBuilder

Specified by:

addTable in interface XMLContentBuilder

paragraph

public void paragraph(java.lang.String text)

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

addActionButtons

public void addActionButtons(Form f,
                             java.lang.String legend,
                             java.util.Set<java.lang.String> actions)

Description copied from interface: ContentBuilder

A a set of action buttons to the content

Specified by:

addActionButtons in interface ContentBuilder

Specified by:

addActionButtons in interface XMLContentBuilder

Parameters:

f - Form

legend - optional legend for the button set

actions - Set of action names

setTableSections

public void setTableSections(boolean value)

getDetails

public final ContentBuilder getDetails(java.lang.Object summary_text)

Description copied from interface: ContentBuilder

get an expanding/folding section if supported This method can either return a new ContentBuilder or the current object. Once content has been added the ContentBuilder.closeDetails() method should be called on whichever object was returned which will perform any additional actions necessary. If expanded/folding sections are not supported this will map to ContentBuilder.addObject(Object) on the summary text and the current ContentBuilder will be returned.

Specified by:

getDetails in interface ContentBuilder

Specified by:

getDetails in interface XMLContentBuilder

Returns:

closeDetails

public final void closeDetails()

Description copied from interface: ContentBuilder

finish a section started by ContentBuilder.getDetails(Object) this may be a no-op if expended section are not supported

Specified by:

closeDetails in interface ContentBuilder

Specified by:

closeDetails in interface XMLContentBuilder

addScript

public void addScript(java.lang.String script)

Add a script element to HTML. This only works for html so classes that want to add script elements will need to check the class of the content builder.

Parameters:

script -

addScriptFile

public void addScriptFile(java.lang.String path)

getLogger

public final Logger getLogger(AppContext conn)

Specified by:

getLogger in interface XMLContentBuilder

useNewTab

public boolean useNewTab()

Specified by:

useNewTab in interface XMLContentBuilder

getFormPolicy

public HtmlFormPolicy getFormPolicy()

Specified by:

getFormPolicy in interface XMLContentBuilder

setNewTab

public boolean setNewTab(boolean new_tab)

Specified by:

setNewTab in interface XMLContentBuilder

strip

public static java.lang.String strip(java.lang.String input)