org.javarosa.core.model

Class QuestionDef

java.lang.Object

org.javarosa.core.model.QuestionDef

All Implemented Interfaces:

IFormElement, Localizable, Externalizable

Direct Known Subclasses:

RangeQuestion

public class QuestionDef
extends Object
implements IFormElement, Localizable

The definition of a Question to be presented to users when filling out a form. QuestionDef requires that any IDataReferences that are used are registered with PrototypeManager in order to be properly deserialized. If they aren't, an exception will be thrown at the time of deserialization.

Author:

Daniel Kayiwa/Drew Roos

Constructor Summary

Constructors

Constructor and Description
QuestionDef()
QuestionDef(int id, int controlType)

Method Summary

Modifier and Type	Method and Description
void	addChild(IFormElement fe)
void	addSelectChoice(SelectChoice choice)
void	alertStateObservers(int changeFlags)
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()
SelectChoice	getChoice(int i)
SelectChoice	getChoiceForValue(String value)
List<SelectChoice>	getChoices()
int	getControlType()
int	getDeepChildCount()
ItemsetBinding	getDynamicChoices()
String	getHelpInnerText()
String	getHelpText() Only if there is no localizable version of the <hint> available should this method be used
String	getHelpTextID()
int	getID()
String	getLabelInnerText() This method returns the regular innertext betweem label tags (if present) (<label>innertext</label>).
int	getNumChoices()
List<OSMTag>	getOsmTags()
String	getTextID() get the TextID for this element used for localization purposes
boolean	isComplex() true if the answer to this question yields xml tree data, not a simple string value
void	localeChanged(String locale, Localizer localizer) Updates the current object with the locate given.
void	readExternal(DataInputStream dis, PrototypeFactory pf)
void	registerStateObserver(FormElementStateListener qsl) Registers a state observer for this element.
void	removeSelectChoice(SelectChoice choice)
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> v)
void	setControlType(int controlType)
void	setDynamicChoices(ItemsetBinding ib)
void	setHelpInnerText(String helpInnerText)
void	setHelpText(String helpText) Only if there is no localizable version of the <hint>available should this method be used
void	setHelpTextID(String textID)
void	setID(int id)
void	setLabelInnerText(String labelInnerText)
void	setOsmTags(List<OSMTag> tags)
void	setTextID(String textID) Set the textID for this element for use with localization.
void	unregisterAll()
void	unregisterStateObserver(FormElementStateListener qsl) Unregisters a state observer for this element.
void	writeExternal(DataOutputStream dos)

Methods inherited from class java.lang.Object

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

Constructor Detail

QuestionDef

public QuestionDef()

QuestionDef

public QuestionDef(int id,
                   int controlType)

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)

getControlType

public int getControlType()

setControlType

public void setControlType(int controlType)

setOsmTags

public void setOsmTags(List<OSMTag> tags)

getOsmTags

public List<OSMTag> getOsmTags()

getAppearanceAttr

public String getAppearanceAttr()

Specified by:

getAppearanceAttr in interface IFormElement

Returns:

setAppearanceAttr

public void setAppearanceAttr(String appearanceAttr)

Specified by:

setAppearanceAttr in interface IFormElement

getHelpText

public String getHelpText()

Only if there is no localizable version of the <hint> available should this method be used

setHelpText

public void setHelpText(String helpText)

Only if there is no localizable version of the <hint>available should this method be used

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:

getActionController

public ActionController getActionController()

Specified by:

getActionController in interface IFormElement

getHelpTextID

public String getHelpTextID()

setHelpTextID

public void setHelpTextID(String textID)

addSelectChoice

public void addSelectChoice(SelectChoice choice)

removeSelectChoice

public void removeSelectChoice(SelectChoice choice)

getChoices

public List<SelectChoice> getChoices()

getChoice

public SelectChoice getChoice(int i)

getNumChoices

public int getNumChoices()

getChoiceForValue

public SelectChoice getChoiceForValue(String value)

getDynamicChoices

public ItemsetBinding getDynamicChoices()

setDynamicChoices

public void setDynamicChoices(ItemsetBinding ib)

isComplex

public boolean isComplex()

true if the answer to this question yields xml tree data, not a simple string value

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

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

Specified by:

setChildren in interface IFormElement

Parameters:

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

readExternal

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

Specified by:

readExternal in interface Externalizable

Throws:

IOException

DeserializationException

writeExternal

public void writeExternal(DataOutputStream dos)
                   throws IOException

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

unregisterAll

public void unregisterAll()

alertStateObservers

public void alertStateObservers(int changeFlags)

getDeepChildCount

public int getDeepChildCount()

Specified by:

getDeepChildCount in interface IFormElement

Returns:

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

setLabelInnerText

public void setLabelInnerText(String labelInnerText)

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

setHelpInnerText

public void setHelpInnerText(String helpInnerText)

getHelpInnerText

public String getHelpInnerText()

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)