uk.ac.ed.epcc.webapp.content

Interface ContentBuilder

All Known Subinterfaces:

XMLContentBuilder

All Known Implementing Classes:

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

public interface ContentBuilder

Interface used to add content to a user interface. These operations are intended to be sufficiently generic to be implemented by both HTML and GUI interfaces

Method Summary

Modifier and Type	Method and Description
default void	addActionButtons(Form f) Add the action buttons for a form.
void	addActionButtons(Form f, java.lang.String legend, java.util.Set<java.lang.String> names) A a set of action buttons to the content
void	addButton(AppContext conn, java.lang.String text, FormResult action) Add an action button to the Content
void	addButton(AppContext conn, java.lang.String text, java.lang.String hover, FormResult action) Add an action button to the Content
<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).
<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) Add the label for a form Field
<I,T> void	addFormLabel(AppContext conn, Field<I> f, T item) Add the label for a form Field
void	addFormTable(AppContext conn, java.lang.Iterable<Field> f) Add a set of Fields as a table of labels and inputs.
void	addHeading(int level, java.lang.String text) Convenience routine to add a heading containing unformatted text.
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
void	addLink(AppContext conn, java.lang.String text, FormResult action) Add an action link to the Content
void	addLink(AppContext conn, java.lang.String text, java.lang.String hover, FormResult action) Add an action link to the Content
<X> void	addList(java.lang.Iterable<X> list) add a bullet list of objects to the content.
<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.
<X> void	addList(X[] list) add a bullet list of objects to the content.
<X> void	addNumberedList(int start, java.lang.Iterable<X> list) add a numbered list of objects to the content.
<X> void	addObject(X target) Add an object depending on its type.
ContentBuilder	addParent() append a nested panel to its parent content.
<C,R> void	addTable(AppContext conn, java.text.NumberFormat nf, Table<C,R> t) Add a table to the content.
<C,R> void	addTable(AppContext conn, Table<C,R> t) Add a table to the content.
<C,R> void	addTable(AppContext conn, Table<C,R> t, java.text.NumberFormat nf, java.lang.String style) Add a table to the content.
<C,R> void	addTable(AppContext conn, Table<C,R> t, java.lang.String style) Add a table to the content.
void	addText(java.lang.String text) Add unformatted text.
<X> boolean	canAdd(X target) Does this ContentBuilder have special handling for the object beyond adding the string representation.
boolean	cleanFormatted(int max, java.lang.String s) add a pre-formatted string as a text section.
void	closeDetails() finish a section started by 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.
ContentBuilder	getHeading(int level) create a ContentBuilder that appends its contents as a heading when the addParent() method is called.
ContentBuilder	getPanel(java.lang.String... type) create a nested content panel
ExtendedXMLBuilder	getSpan() create a ExtendedXMLBuilder that appends its contents as XML text when the SimpleXMLBuilder.appendParent() method is called.
default ExtendedXMLBuilder	getSpan(java.lang.String... type) convenience method to generate a span with defined class/types
ExtendedXMLBuilder	getText() create a ExtendedXMLBuilder that appends its contents as XML text when the SimpleXMLBuilder.appendParent() method is called.

Method Detail

getText

ExtendedXMLBuilder getText()

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 getSpan() where this does not make sense for example where the ContentBuilder represents a heading or table cell.

Returns:

ExtendedXMLBuilder

getSpan

ExtendedXMLBuilder getSpan()

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.

Returns:

ExtendedXMLBuilder

getSpan

default ExtendedXMLBuilder getSpan(java.lang.String... type)

convenience method to generate a span with defined class/types

Parameters:

type -

Returns:

addText

void addText(java.lang.String text)

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

Parameters:

text - string to add to content

cleanFormatted

boolean cleanFormatted(int max,
                       java.lang.String s)

add a pre-formatted string as a text section. In HTML this is either as a pre-formated section or a paragraph containing a series of explicitly broken lines (if any of the lines are longer than the specified threshold.

Parameters:

max - max line length

s -

Returns:

true if lines are long

getHeading

ContentBuilder getHeading(int level)

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

Parameters:

level - level of heading

Returns:

ContentBuilder for header

addHeading

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

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

Parameters:

level -

text -

getPanel

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

create a nested content panel

Parameters:

type - Strings specifying a formatting types for the panel.

Returns:

ContentBuilder for panel

Throws:

java.lang.UnsupportedOperationException

getDetails

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. Once content has been added the 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 addObject(Object) on the summary text and the current ContentBuilder will be returned.

Parameters:

summary_text -

Returns:

closeDetails

void closeDetails()

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

addParent

ContentBuilder addParent()
                  throws java.lang.UnsupportedOperationException

append a nested panel to its parent content.

Returns:

parent ContentBuilder

Throws:

java.lang.UnsupportedOperationException

addObject

<X> void addObject(X target)

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

Parameters:

target -

canAdd

<X> boolean canAdd(X target)

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

Type Parameters:

X -

Parameters:

target -

Returns:

addList

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

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

Parameters:

list -

addNumberedList

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

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

Parameters:

list -

addList

<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. Any UIGenerators will generate their content otherwise a suitable text representation will be used.

Parameters:

attr -

list -

addList

<X> void addList(X[] list)

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

Parameters:

list -

addButton

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

Add an action button to the Content

Parameters:

conn - AppContext

text -

action -

addButton

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

Add an action button to the Content

Parameters:

conn - AppContext

text -

hover - tooltip text

action -

addLink

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

Add an action link to the Content

Parameters:

conn - AppContext

text - link text

action - FormResult to navigate to.

addLink

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

Add an action link to the Content

Parameters:

conn - AppContext

text - link text

hover - tooltip text

action - FormResult to navigate to.

addImage

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

Parameters:

conn -

alt -

hover -

width - (optional, ignored if <= 0)

height - (optional, ignored if <= 0)

image -

addTable

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

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

Parameters:

conn -

t -

addTable

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

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

Parameters:

conn -

t -

style -

addTable

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

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

Parameters:

conn -

nf -

t -

addTable

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

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

Parameters:

conn -

t -

nf -

style -

addColumn

<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).

Parameters:

conn -

t -

col -

addFormTable

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

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

Parameters:

conn -

f -

addFormLabel

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

Add the label for a form Field

Parameters:

conn -

f - Field

item - item (only used by RadioInputs)

addFormLabel

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

Add the label for a form Field

Parameters:

conn -

f - Field

addFormInput

<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. If item is null then a RadioButtonInput will output all inputs in a block.

Parameters:

conn - AppContext

f - Field

item - item (only used by RadioInputs)

addActionButtons

default void addActionButtons(Form f)

Add the action buttons for a form.

Parameters:

f -

addActionButtons

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

A a set of action buttons to the content

Parameters:

f - Form

legend - optional legend for the button set

names - Set of action names