uk.ac.ed.epcc.webapp.forms.swing

Class SwingContentBuilder

java.lang.Object

uk.ac.ed.epcc.webapp.forms.swing.SwingContentBuilder

All Implemented Interfaces:

ContentBuilder

public class SwingContentBuilder
extends java.lang.Object
implements ContentBuilder

builds a swing version of content.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SwingContentBuilder.XMLPanel

Constructor Summary

Constructors

Constructor and Description
SwingContentBuilder(AppContext conn, javax.swing.JComponent content, javax.swing.JFrame frame)
SwingContentBuilder(AppContext conn, javax.swing.JFrame frame)

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
void	addButton(AppContext c, java.lang.String text, FormResult action) Add an action button to the Content
void	addButton(AppContext c, 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 radio_selector) Add the input for a form Field If the input is a RadioButtonInput then the item parameter selects which item the input is for.
<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	addFormTable(AppContext conn, java.lang.Iterable<Field> f, boolean validate)
void	addHeading(int level, java.lang.String text) Convenience routine to add a heading containing unformatted text.
void	addHtml(java.lang.String 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 c, java.lang.String text, FormResult action) Add an action link to the Content
void	addLink(AppContext c, 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 ContentBuilder.getDetails(Object) this may be a no-op if expended section are not supported
int	getAlign()
javax.swing.border.Border	getBorder()
javax.swing.JComponent	getComponent()
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.
java.awt.Font	getFont()
ContentBuilder	getHeading(int level) create a ContentBuilder that appends its contents as a heading when the ContentBuilder.addParent() method is called.
Logger	getLogger()
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.
ExtendedXMLBuilder	getText() create a ExtendedXMLBuilder that appends its contents as XML text when the SimpleXMLBuilder.appendParent() method is called.
void	setAlign(int align)
void	setBorder(javax.swing.border.Border border)
void	setComponentValues()
void	setFont(java.awt.Font f)
boolean	validate(Form form)

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

addActionButtons, addFormLabel, getSpan

Constructor Detail

SwingContentBuilder

public SwingContentBuilder(AppContext conn,
                           javax.swing.JFrame frame)

SwingContentBuilder

public SwingContentBuilder(AppContext conn,
                           javax.swing.JComponent content,
                           javax.swing.JFrame frame)

Method Detail

setFont

public void setFont(java.awt.Font f)

getFont

public java.awt.Font getFont()

setAlign

public void setAlign(int align)

getAlign

public int getAlign()

setBorder

public void setBorder(javax.swing.border.Border border)

getBorder

public javax.swing.border.Border getBorder()

getComponent

public javax.swing.JComponent getComponent()

addButton

public void addButton(AppContext c,
                      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:

c - AppContext

addButton

public void addButton(AppContext c,
                      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:

c - AppContext

hover - tooltip text

addLink

public void addLink(AppContext c,
                    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:

c - AppContext

text - link text

action - FormResult to navigate to.

addLink

public void addLink(AppContext c,
                    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:

c - AppContext

text - link text

hover - tooltip text

action - FormResult to navigate to.

addTable

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

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

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

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

addColumn

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

public 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

addHtml

public void addHtml(java.lang.String text)

addHeading

public 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

cleanFormatted

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

Description copied from interface: ContentBuilder

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.

Specified by:

cleanFormatted in interface ContentBuilder

Parameters:

max - max line length

Returns:

true if lines are long

addTable

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

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

addFormTable

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

Description copied from interface: ContentBuilder

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

Specified by:

addFormTable in interface ContentBuilder

addFormTable

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

addFormLabel

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

public <I,T> void addFormInput(AppContext conn,
                               Field<I> f,
                               T radio_selector)

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

radio_selector - item (only used by RadioInputs)

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

Parameters:

f - Form

legend - optional legend for the button set

actions - Set of action names

setComponentValues

public void setComponentValues()

validate

public boolean validate(Form form)
                 throws ValidateException

Throws:

ValidateException

addList

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

addObject

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

canAdd

public <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:

addList

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

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

getDetails

public 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

public 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

addNumberedList

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

addImage

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

getLogger

public Logger getLogger()

Returns: