org.javarosa.core.model

Interface IFormElement

All Superinterfaces:

Externalizable, Localizable

All Known Implementing Classes:

FormDef, GroupDef, QuestionDef, RangeQuestion

public interface IFormElement
extends Localizable, Externalizable

An IFormDataElement is an element of the physical interaction for a form, an example of an implementing element would be the definition of a Question.

Author:

Drew Roos

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()
int	getDeepChildCount()
int	getID()
String	getLabelInnerText() This method returns the regular innertext betweem label tags (if present) (<label>innertext</label>).
String	getTextID() get the TextID for this element used for localization purposes
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	setChildren(List<IFormElement> v)
void	setID(int id)
void	setTextID(String id) Set the textID for this element for use with localization.
void	unregisterStateObserver(FormElementStateListener qsl) Unregisters a state observer for this element.

Methods inherited from interface org.javarosa.core.services.locale.Localizable

localeChanged

Methods inherited from interface org.javarosa.core.util.externalizable.Externalizable

readExternal, writeExternal

Method Detail

getID

int getID()

Returns:

The unique ID of this element

setID

void setID(int id)

Parameters:

id - The new unique ID of this element

getTextID

String getTextID()

get the TextID for this element used for localization purposes

Returns:

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

setTextID

void setTextID(String id)

Set the textID for this element for use with localization.

Parameters:

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

getChildren

List<IFormElement> getChildren()

Returns:

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

setChildren

void setChildren(List<IFormElement> v)

Parameters:

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

Throws:

IllegalStateException - if the element is incapable of having children.

addChild

void addChild(IFormElement fe)

Parameters:

fe - The child element to be added

Throws:

IllegalStateException - if the element is incapable of having children.

getChild

IFormElement getChild(int i)

getDeepChildCount

int getDeepChildCount()

Returns:

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

getBind

IDataReference getBind()

Returns:

The data reference for this element

registerStateObserver

void registerStateObserver(FormElementStateListener qsl)

Registers a state observer for this element.

Parameters:

qsl -

unregisterStateObserver

void unregisterStateObserver(FormElementStateListener qsl)

Unregisters a state observer for this element.

Parameters:

qsl -

getLabelInnerText

String getLabelInnerText()

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

Returns:

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

getAppearanceAttr

String getAppearanceAttr()

Returns:

setAppearanceAttr

void setAppearanceAttr(String appearanceAttr)

getActionController

ActionController getActionController()

setAdditionalAttribute

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

Capture additional attributes on a Question or Group

Parameters:

namespace -

name -

value -

getAdditionalAttribute

String getAdditionalAttribute(String namespace,
                              String name)

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

Parameters:

namespace -

name -

Returns:

getAdditionalAttributes

List<TreeElement> getAdditionalAttributes()

Retrieve all additional attributes on a Question or Group

Returns: