uk.ac.ed.epcc.webapp.content

Interface XMLContentBuilder

All Superinterfaces:

ContentBuilder, ExtendedXMLBuilder, SimpleXMLBuilder

All Known Implementing Classes:

HtmlBuilder, HtmlBuilder.Heading, HtmlBuilder.Panel, HtmlBuilder.SpanText, HtmlBuilder.Text, HtmlWriter

public interface XMLContentBuilder
extends ContentBuilder, ExtendedXMLBuilder

Interface for combined ContentBuilder and ExtendedXMLBuilder for a web context where ContentBuilder is implemented as html. most of the ContentBuilder methods (those that only rely on the ExtendedXMLBuilder interface) are implemented as default methods so different ExtendedXMLBuilder sub-classes can share a single implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static Feature	STREAM_BUILDER_FEATURE

Method Summary

Modifier and Type	Method and Description
default void	addActionButtons(Form f, java.lang.String legend, java.util.Set<java.lang.String> actions) A a set of action buttons to the content
default void	addButton(AppContext conn, java.lang.String text, FormResult action) Add an action button to the Content
default void	addButton(AppContext conn, java.lang.String text, java.lang.String hover, FormResult action) Add an action button to the Content
default <C,R> void	addColumn(AppContext conn, Table<C,R> t, C col) Add the data from a single column of a Table formatted in 2 columns (key and data).
default <I,T> void	addFormInput(AppContext conn, Field<I> f, T item) Add the input for a form Field If the input is a RadioButtonInput then the item parameter selects which item the input is for.
default <I,T> void	addFormLabel(AppContext conn, Field<I> f, T item) Add the label for a form Field
default void	addFormTable(AppContext conn, java.lang.Iterable<Field> form) Add a set of Fields as a table of labels and inputs.
default void	addHeading(int level, java.lang.String text) Convenience routine to add a heading containing unformatted text.
default void	addImage(AppContext conn, java.lang.String alt, java.lang.String hover, java.lang.Integer width, java.lang.Integer height, ServeDataResult image) Add an image served by a ServeDataResult
default void	addLink(AppContext conn, java.lang.String text, FormResult action) Add an action link to the Content
default void	addLink(AppContext conn, java.lang.String text, java.lang.String hover, FormResult action) Add an action link to the Content
default <X> void	addList(java.lang.Iterable<X> list) add a bullet list of objects to the content.
default <X> void	addList(java.util.Map<java.lang.String,java.lang.String> attr, java.lang.Iterable<X> list) add a bullet list of objects to the content.
default <X> void	addList(X[] list) add a bullet list of objects to the content.
default <X> void	addNumberedList(int start, java.lang.Iterable<X> list) add a numbered list of objects to the content.
default <X> void	addObject(X target) Add an object depending on its type.
default <C,R> void	addTable(AppContext conn, java.text.NumberFormat nf, Table<C,R> t) Add a table to the content.
default <C,R> void	addTable(AppContext conn, Table<C,R> t) Add a table to the content.
default <C,R> void	addTable(AppContext conn, Table<C,R> t, java.text.NumberFormat nf, java.lang.String style) Add a table to the content.
default <C,R> void	addTable(AppContext conn, Table<C,R> t, java.lang.String style) Add a table to the content.
default void	addText(java.lang.String text) Add unformatted text.
void	append(XMLPrinter target)
default <X> boolean	canAdd(X target) Does this ContentBuilder have special handling for the object beyond adding the string representation.
default void	closeDetails() finish a section started by ContentBuilder.getDetails(Object) this may be a no-op if expended section are not supported
default 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()
Logger	getLogger(AppContext conn)
boolean	setNewTab(boolean new_tab)
boolean	useNewTab()

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

addActionButtons, addFormLabel, addParent, cleanFormatted, getHeading, getPanel, getSpan, getSpan, getText

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

STREAM_BUILDER_FEATURE

static final Feature STREAM_BUILDER_FEATURE

Method Detail

addFormLabel

default <I,T> void addFormLabel(AppContext conn,
                                Field<I> f,
                                T item)

Description copied from interface: ContentBuilder

Add the label for a form Field

Specified by:

addFormLabel in interface ContentBuilder

f - Field

item - item (only used by RadioInputs)

addFormInput

default <I,T> void addFormInput(AppContext conn,
                                Field<I> f,
                                T item)

Description copied from interface: ContentBuilder

Add the input for a form Field If the input is a RadioButtonInput then the item parameter selects which item the input is for. If item is null then a RadioButtonInput will output all inputs in a block.

Specified by:

addFormInput in interface ContentBuilder

Parameters:

conn - AppContext

f - Field

item - item (only used by RadioInputs)

addList

default <X> void addList(java.lang.Iterable<X> list)

Description copied from interface: ContentBuilder

add a bullet list of objects to the content. Any UIGenerators will generate their content otherwise a suitable text representation will be used.

Specified by:

addList in interface ContentBuilder

addList

default <X> void addList(java.util.Map<java.lang.String,java.lang.String> attr,
                         java.lang.Iterable<X> list)

Description copied from interface: ContentBuilder

add a bullet list of objects to the content. Any UIGenerators will generate their content otherwise a suitable text representation will be used.

Specified by:

addList in interface ContentBuilder

addNumberedList

default <X> void addNumberedList(int start,
                                 java.lang.Iterable<X> list)

Description copied from interface: ContentBuilder

add a numbered list of objects to the content. Any UIGenerators will generate their content otherwise a suitable text representation will be used.

Specified by:

addNumberedList in interface ContentBuilder

addObject

default <X> void addObject(X target)

Description copied from interface: ContentBuilder

Add an object depending on its type. This should always map to ContentBuilder.addParent() on child objects.

Specified by:

addObject in interface ContentBuilder

Specified by:

addObject in interface SimpleXMLBuilder

Parameters:

target -

canAdd

default <X> boolean canAdd(X target)

Description copied from interface: ContentBuilder

Does this ContentBuilder have special handling for the object beyond adding the string representation.

Specified by:

canAdd in interface ContentBuilder

Returns:

append

void append(XMLPrinter target)

getLogger

Logger getLogger(AppContext conn)

useNewTab

boolean useNewTab()

setNewTab

boolean setNewTab(boolean new_tab)

getFormPolicy

HtmlFormPolicy getFormPolicy()

addList

default <X> void addList(X[] list)

Description copied from interface: ContentBuilder

add a bullet list of objects to the content. Any UIGenerators will generate their content otherwise a suitable text representation will be used.

Specified by:

addList in interface ContentBuilder

addButton

default void addButton(AppContext conn,
                       java.lang.String text,
                       FormResult action)

Description copied from interface: ContentBuilder

Add an action button to the Content

Specified by:

addButton in interface ContentBuilder

Parameters:

conn - AppContext

addButton

default void addButton(AppContext conn,
                       java.lang.String text,
                       java.lang.String hover,
                       FormResult action)

Description copied from interface: ContentBuilder

Add an action button to the Content

Specified by:

addButton in interface ContentBuilder

Parameters:

conn - AppContext

hover - tooltip text

addLink

default void addLink(AppContext conn,
                     java.lang.String text,
                     FormResult action)

Description copied from interface: ContentBuilder

Add an action link to the Content

Specified by:

addLink in interface ContentBuilder

Parameters:

conn - AppContext

text - link text

action - FormResult to navigate to.

addLink

default void addLink(AppContext conn,
                     java.lang.String text,
                     java.lang.String hover,
                     FormResult action)

Description copied from interface: ContentBuilder

Add an action link to the Content

Specified by:

addLink in interface ContentBuilder

Parameters:

conn - AppContext

text - link text

hover - tooltip text

action - FormResult to navigate to.

addImage

default void addImage(AppContext conn,
                      java.lang.String alt,
                      java.lang.String hover,
                      java.lang.Integer width,
                      java.lang.Integer height,
                      ServeDataResult image)

Description copied from interface: ContentBuilder

Add an image served by a ServeDataResult

Specified by:

addImage in interface ContentBuilder

width - (optional, ignored if <= 0)

height - (optional, ignored if <= 0)

addTable

default <C,R> void addTable(AppContext conn,
                            Table<C,R> t,
                            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

addColumn

default <C,R> void addColumn(AppContext conn,
                             Table<C,R> t,
                             C col)

Description copied from interface: ContentBuilder

Add the data from a single column of a Table formatted in 2 columns (key and data).

Specified by:

addColumn in interface ContentBuilder

addText

default void addText(java.lang.String text)

Description copied from interface: ContentBuilder

Add unformatted text. Equivalent to ContentBuilder.getText().clean(text).appendParent().

Specified by:

addText in interface ContentBuilder

Parameters:

text - string to add to content

addHeading

default void addHeading(int level,
                        java.lang.String text)

Description copied from interface: ContentBuilder

Convenience routine to add a heading containing unformatted text. This is equivalent to ContentBuilder.getHeading(int).addText(text).

Specified by:

addHeading in interface ContentBuilder

addTable

default <C,R> void addTable(AppContext conn,
                            Table<C,R> t)

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

addTable

default <C,R> void addTable(AppContext conn,
                            java.text.NumberFormat nf,
                            Table<C,R> t)

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

addTable

default <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

addFormTable

default void addFormTable(AppContext conn,
                          java.lang.Iterable<Field> form)

Description copied from interface: ContentBuilder

Add a set of Fields as a table of labels and inputs.

Specified by:

addFormTable in interface ContentBuilder

addActionButtons

default 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

Parameters:

f - Form

legend - optional legend for the button set

actions - Set of action names

getDetails

default 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

Returns:

closeDetails

default 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