com.swfit.core.xhtml
Class XHTMLFieldCollection

java.lang.Object
  |
  +--com.swfit.core.tree.TreeElement
        |
        +--com.swfit.core.tree.TreeBranch
              |
              +--com.swfit.core.xhtml.XHTMLFieldCollection

public class XHTMLFieldCollection

extends TreeBranch

A collection of XHTML form fields.

Since:

SWFIT1.0

Version:

$Revision: 1.2 $ $Date: 2003/03/17 22:53:06 $

Author:

Olaf Havnes

Field Summary

static java.lang.String

TREE_CODE For form rendering.

Fields inherited from class com.swfit.core.tree.TreeElement

CODE, NUM_OWNED, OWNED, SEPARATOR

Constructor Summary

XHTMLFieldCollection()
A XHTMLFieldCollection with "" as name, will normally own the whole form.

XHTMLFieldCollection(java.lang.String name)
A XHTMLFieldCollection with a given name will normally be a sub-collection of fields.

Method Summary

java.lang.String	code() Describe this TreeElement in a way that will make it possible to rebuild the tree
void	copyDataTo(XHTMLFieldCollection copy_to)
void	copyRenderDataTo(XHTMLFieldCollection copy_to)
XHTMLFieldCollection	deepCopy() Copy this XHTMLFieldCollection to various degrees
XHTMLFieldCollection	deepCopy(java.lang.String new_name)
XHTMLFieldCollection	deepCopy(java.lang.String new_name, TreeBranch new_owner)
XHTMLFieldCollection	deepCopy(TreeBranch new_owner)
XHTMLField	getXHTMLField(java.lang.String name)
XHTMLField	getXHTMLField(java.lang.String[] names) Get a XHTMLField from somewhere inside the tree structure
XHTMLFieldCollection	getXHTMLFieldCollection(java.lang.String name)
XHTMLFieldCollection	getXHTMLFieldCollection(java.lang.String[] names) Get a XHTMLFieldCollection from somewhere inside the tree structure
java.lang.String	getXHTMLFieldValue(java.lang.String[] names) Get the first field value of a XHTMLField somewhere inside the tree structure
java.lang.String[]	getXHTMLFieldValues(java.lang.String[] names) Get the field values of a XHTMLField somewhere inside the tree structure
void	setAsList() Should this collection of fields be rendered as a list ?
void	setAsListMember()
void	setAsListStart() Is this collection of fields one of a list of similar collections ? If it is a list element
XHTMLField	toXHTMLField(TreeLeaf leaf) Cast the TreeLeaf to a XHTMLField
XHTMLFieldCollection	toXHTMLFieldCollection(TreeBranch branch) Cast the TreeBranch to a XHTMLFieldCollection

Methods inherited from class com.swfit.core.tree.TreeBranch

add, all, contains, contains, get, getBranch, getBranch, getLeaf, getLeaf, ignoreCaseAll, indexAll, indexAllNames, names

Methods inherited from class com.swfit.core.tree.TreeElement

codeName, explainer, horizontal, index, name, owner, setExplainer, setHorizontal, setIndex, setOwner, toTreeBranch, toTreeElement, toTreeLeaf, treeName

Methods inherited from class java.lang.Object

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

Field Detail

TREE_CODE

public static final java.lang.String TREE_CODE

For form rendering.

Constructor Detail

XHTMLFieldCollection

public XHTMLFieldCollection()

A XHTMLFieldCollection with "" as name, will normally own the whole form.

XHTMLFieldCollection

public XHTMLFieldCollection(java.lang.String name)

A XHTMLFieldCollection with a given name will normally be a sub-collection of fields.

Method Detail

deepCopy

public final XHTMLFieldCollection deepCopy()

Copy this XHTMLFieldCollection to various degrees

deepCopy

public final XHTMLFieldCollection deepCopy(java.lang.String new_name)

deepCopy

public final XHTMLFieldCollection deepCopy(TreeBranch new_owner)

deepCopy

public final XHTMLFieldCollection deepCopy(java.lang.String new_name,
                                           TreeBranch new_owner)

copyDataTo

public final void copyDataTo(XHTMLFieldCollection copy_to)

copyRenderDataTo

public final void copyRenderDataTo(XHTMLFieldCollection copy_to)

getXHTMLFieldCollection

public final XHTMLFieldCollection getXHTMLFieldCollection(java.lang.String[] names)

Get a XHTMLFieldCollection from somewhere inside the tree structure

getXHTMLFieldCollection

public final XHTMLFieldCollection getXHTMLFieldCollection(java.lang.String name)

getXHTMLField

public final XHTMLField getXHTMLField(java.lang.String[] names)

Get a XHTMLField from somewhere inside the tree structure

getXHTMLField

public final XHTMLField getXHTMLField(java.lang.String name)

getXHTMLFieldValues

public final java.lang.String[] getXHTMLFieldValues(java.lang.String[] names)

Get the field values of a XHTMLField somewhere inside the tree structure

getXHTMLFieldValue

public final java.lang.String getXHTMLFieldValue(java.lang.String[] names)

Get the first field value of a XHTMLField somewhere inside the tree structure

toXHTMLFieldCollection

public final XHTMLFieldCollection toXHTMLFieldCollection(TreeBranch branch)

Cast the TreeBranch to a XHTMLFieldCollection

toXHTMLField

public final XHTMLField toXHTMLField(TreeLeaf leaf)

Cast the TreeLeaf to a XHTMLField

code

public final java.lang.String code()

Describe this TreeElement in a way that will make it possible to rebuild the tree

Overrides:

code in class TreeElement

setAsList

public final void setAsList()

Should this collection of fields be rendered as a list ?

setAsListStart

public final void setAsListStart()

Is this collection of fields one of a list of similar collections ? If it is a list element

a) it should be horizontal b) only the first collection in the list should have an explainer, and c) only the fields in the first collection should have explainers rendered as text

setAsListMember

public final void setAsListMember()