org.javarosa.core.model

Class GroupDef

java.lang.Object

org.javarosa.core.model.GroupDef

All Implemented Interfaces:

IFormElement, Localizable, Externalizable

public class GroupDef
extends Object
implements IFormElement, Localizable

The definition of a group in a form or questionaire.

Author:

Daniel Kayiwa

Field Summary

Fields

Modifier and Type	Field and Description
String	addCaption
String	addEmptyCaption
String	chooseCaption
IDataReference	count
String	delCaption
String	delHeader
String	doneCaption
String	doneEmptyCaption
String	entryHeader
String	mainHeader
boolean	noAddRemove

Constructor Summary

Constructors

Constructor and Description
GroupDef()
GroupDef(int id, List<IFormElement> children, boolean repeat)

Method Summary

Modifier and Type	Method and Description
void	addChild(IFormElement fe)
ActionController	getActionController()
String	getAdditionalAttribute(String namespace, String name) Retrieve the value of an additional attribute on a Question or Group
List<TreeElement>	getAdditionalAttributes() Retrieve all additional attributes on a Question or Group
String	getAppearanceAttr()
IDataReference	getBind()
IFormElement	getChild(int i)
List<IFormElement>	getChildren()
TreeReference	getConextualizedCountReference(TreeReference context)
IDataReference	getCountReference()
int	getDeepChildCount()
int	getID()
String	getLabelInnerText() This method returns the regular innertext betweem label tags (if present) (<label>innertext</label>).
boolean	getRepeat()
String	getTextID() get the TextID for this element used for localization purposes
void	localeChanged(String locale, Localizer localizer) Updates the current object with the locate given.
void	readExternal(DataInputStream dis, PrototypeFactory pf) Reads a group definition object from the supplied stream.
void	registerStateObserver(FormElementStateListener qsl) Registers a state observer for this element.
void	setAdditionalAttribute(String namespace, String name, String value) Capture additional attributes on a Question or Group
void	setAppearanceAttr(String appearanceAttr)
void	setBind(IDataReference binding)
void	setChildren(List<IFormElement> children)
void	setID(int id)
void	setLabelInnerText(String lit)
void	setRepeat(boolean repeat)
void	setTextID(String textID) Set the textID for this element for use with localization.
String	toString()
void	unregisterStateObserver(FormElementStateListener qsl) Unregisters a state observer for this element.
void	writeExternal(DataOutputStream dos) Write the group definition object to the supplied stream.

Methods inherited from class java.lang.Object

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

Field Detail

chooseCaption

public String chooseCaption

addCaption

public String addCaption

delCaption

public String delCaption

doneCaption

public String doneCaption

addEmptyCaption

public String addEmptyCaption

doneEmptyCaption

public String doneEmptyCaption

entryHeader

public String entryHeader

delHeader

public String delHeader

mainHeader

public String mainHeader

noAddRemove

public boolean noAddRemove

count

public IDataReference count

Constructor Detail

GroupDef

public GroupDef()

GroupDef

public GroupDef(int id,
                List<IFormElement> children,
                boolean repeat)

Method Detail

getID

public int getID()

Specified by:

getID in interface IFormElement

Returns:

The unique ID of this element

setID

public void setID(int id)

Specified by:

setID in interface IFormElement

Parameters:

id - The new unique ID of this element

getBind

public IDataReference getBind()

Specified by:

getBind in interface IFormElement

Returns:

The data reference for this element

setBind

public void setBind(IDataReference binding)

setAdditionalAttribute

public void setAdditionalAttribute(String namespace,
                                   String name,
                                   String value)

Description copied from interface: IFormElement

Capture additional attributes on a Question or Group

Specified by:

setAdditionalAttribute in interface IFormElement

getAdditionalAttribute

public String getAdditionalAttribute(String namespace,
                                     String name)

Description copied from interface: IFormElement

Retrieve the value of an additional attribute on a Question or Group

Specified by:

getAdditionalAttribute in interface IFormElement

Returns:

getAdditionalAttributes

public List<TreeElement> getAdditionalAttributes()

Description copied from interface: IFormElement

Retrieve all additional attributes on a Question or Group

Specified by:

getAdditionalAttributes in interface IFormElement

Returns:

getChildren

public List<IFormElement> getChildren()

Specified by:

getChildren in interface IFormElement

Returns:

A List containing any children that this element might have. Null if the element is not able to have child elements.

setChildren

public void setChildren(List<IFormElement> children)

Specified by:

setChildren in interface IFormElement

Parameters:

children - the children of this element, if it is capable of having child elements.

addChild

public void addChild(IFormElement fe)

Specified by:

addChild in interface IFormElement

Parameters:

fe - The child element to be added

getChild

public IFormElement getChild(int i)

Specified by:

getChild in interface IFormElement

getRepeat

public boolean getRepeat()

Returns:

true if this represents a element

setRepeat

public void setRepeat(boolean repeat)

getLabelInnerText

public String getLabelInnerText()

Description copied from interface: IFormElement

This method returns the regular innertext betweem label tags (if present) (<label>innertext</label>).

Specified by:

getLabelInnerText in interface IFormElement

Returns:

<label> innertext or null (if innertext is not present).

setLabelInnerText

public void setLabelInnerText(String lit)

getAppearanceAttr

public String getAppearanceAttr()

Specified by:

getAppearanceAttr in interface IFormElement

Returns:

setAppearanceAttr

public void setAppearanceAttr(String appearanceAttr)

Specified by:

setAppearanceAttr in interface IFormElement

getActionController

public ActionController getActionController()

Specified by:

getActionController in interface IFormElement

localeChanged

public void localeChanged(String locale,
                          Localizer localizer)

Description copied from interface: Localizable

Updates the current object with the locate given.

Specified by:

localeChanged in interface Localizable

getCountReference

public IDataReference getCountReference()

getConextualizedCountReference

public TreeReference getConextualizedCountReference(TreeReference context)

toString

public String toString()

Overrides:

toString in class Object

getDeepChildCount

public int getDeepChildCount()

Specified by:

getDeepChildCount in interface IFormElement

Returns:

A recursive count of how many elements are ancestors of this element.

readExternal

public void readExternal(DataInputStream dis,
                         PrototypeFactory pf)
                  throws IOException,
                         DeserializationException

Reads a group definition object from the supplied stream.

Specified by:

readExternal in interface Externalizable

Throws:

IOException

DeserializationException

writeExternal

public void writeExternal(DataOutputStream dos)
                   throws IOException

Write the group definition object to the supplied stream.

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

registerStateObserver

public void registerStateObserver(FormElementStateListener qsl)

Description copied from interface: IFormElement

Registers a state observer for this element.

Specified by:

registerStateObserver in interface IFormElement

unregisterStateObserver

public void unregisterStateObserver(FormElementStateListener qsl)

Description copied from interface: IFormElement

Unregisters a state observer for this element.

Specified by:

unregisterStateObserver in interface IFormElement

getTextID

public String getTextID()

Description copied from interface: IFormElement

get the TextID for this element used for localization purposes

Specified by:

getTextID in interface IFormElement

Returns:

the TextID (bare, no ;form appended to it!!)

setTextID

public void setTextID(String textID)

Description copied from interface: IFormElement

Set the textID for this element for use with localization.

Specified by:

setTextID in interface IFormElement

Parameters:

textID - the plain TextID WITHOUT any form specification (e.g. ;long)