org.javarosa.form.api

Class FormEntryPrompt

java.lang.Object

org.javarosa.form.api.FormEntryCaption

org.javarosa.form.api.FormEntryPrompt

All Implemented Interfaces:

FormElementStateListener

public class FormEntryPrompt
extends FormEntryCaption

This class gives you all the information you need to display a question when your current FormIndex references a QuestionEvent.

Author:

Yaw Anokwa

Nested Class Summary

Nested classes/interfaces inherited from class org.javarosa.form.api.FormEntryCaption

FormEntryCaption.RepeatOptions

Field Summary

Fields inherited from class org.javarosa.form.api.FormEntryCaption

element, TEXT_FORM_AUDIO, TEXT_FORM_IMAGE, TEXT_FORM_LONG, TEXT_FORM_SHORT, TEXT_FORM_VIDEO, viewWidget

Fields inherited from interface org.javarosa.core.model.FormElementStateListener

CHANGE_DATA, CHANGE_ENABLED, CHANGE_INIT, CHANGE_LOCALE, CHANGE_OTHER, CHANGE_RELEVANT, CHANGE_REQUIRED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FormEntryPrompt() This empty constructor exists for convenience of any supertypes of this prompt
	FormEntryPrompt(FormDef form, FormIndex index) Creates a FormEntryPrompt for the element at the given index in the form.

Method Summary

Modifier and Type	Method and Description
void	formElementStateChanged(TreeElement instanceNode, int changeFlags)
String	getAnswerText()
IAnswerData	getAnswerValue()
List<TreeElement>	getBindAttributes()
String	getConstraintText()
String	getConstraintText(IAnswerData attemptedValue)
String	getConstraintText(String textForm, IAnswerData attemptedValue)
int	getControlType()
int	getDataType()
String	getHelpText() ONLY RELEVANT to Question elements! Will throw runTimeException if this is called for anything that isn't a Question.
String	getPromptAttributes()
QuestionDef	getQuestion()
List<SelectChoice>	getSelectChoices()
String	getSelectChoiceText(SelectChoice selection)
String	getSelectItemText(Selection sel) Attempts to return the specified item text from a select or select1.
String	getSpecialFormSelectChoiceText(SelectChoice sel, String form)
String	getSpecialFormSelectItemText(Selection sel, String form) This method is generally used to retrieve special forms for a (select or 1select) item, e.g.
boolean	isReadOnly()
boolean	isRequired()
void	register(IQuestionWidget viewWidget)
void	requestConstraintHint(ConstraintHint hint)
void	unregister()

Methods inherited from class org.javarosa.form.api.FormEntryCaption

formElementStateChanged, getAppearanceHint, getAudioText, getFormElement, getImageText, getIndex, getIText, getLongText, getMultiplicity, getNumRepetitions, getQuestionText, getQuestionText, getRepeatOptions, getRepeatText, getRepetitionsText, getRepetitionText, getShortText, getSpecialFormQuestionText, getSpecialFormQuestionText, getTextID, localizer, repeats, substituteStringArgs

Methods inherited from class java.lang.Object

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

Constructor Detail

FormEntryPrompt

protected FormEntryPrompt()

This empty constructor exists for convenience of any supertypes of this prompt

FormEntryPrompt

public FormEntryPrompt(FormDef form,
                       FormIndex index)

Creates a FormEntryPrompt for the element at the given index in the form.

Parameters:

form -

index -

Method Detail

getControlType

public int getControlType()

getDataType

public int getDataType()

getPromptAttributes

public String getPromptAttributes()

getAnswerValue

@Nullable
public IAnswerData getAnswerValue()

getAnswerText

public String getAnswerText()

getConstraintText

public String getConstraintText()

getConstraintText

public String getConstraintText(IAnswerData attemptedValue)

getConstraintText

public String getConstraintText(String textForm,
                                IAnswerData attemptedValue)

getBindAttributes

public List<TreeElement> getBindAttributes()

getSelectChoices

public List<SelectChoice> getSelectChoices()

isRequired

public boolean isRequired()

isReadOnly

public boolean isReadOnly()

getQuestion

public QuestionDef getQuestion()

register

public void register(IQuestionWidget viewWidget)

Overrides:

register in class FormEntryCaption

unregister

public void unregister()

Overrides:

unregister in class FormEntryCaption

formElementStateChanged

public void formElementStateChanged(TreeElement instanceNode,
                                    int changeFlags)

Specified by:

formElementStateChanged in interface FormElementStateListener

Overrides:

formElementStateChanged in class FormEntryCaption

getHelpText

public String getHelpText()

ONLY RELEVANT to Question elements! Will throw runTimeException if this is called for anything that isn't a Question. Returns null if no help text is available

Returns:

getSelectItemText

public String getSelectItemText(Selection sel)

Attempts to return the specified item text from a select or select1. Will check for text in the following order:
Localized Text (long form) -> Localized Text (no special form)
If no textID is available, method will return this item's labelInnerText.

Parameters:

sel - the selection (item), if null will throw a IllegalArgumentException

Returns:

Question Text. null if no text for this element exists (after all fallbacks).

Throws:

RuntimeException - if this method is called on an element that is NOT a QuestionDef

IllegalArgumentException - if Selection is null

getSelectChoiceText

public String getSelectChoiceText(SelectChoice selection)

See Also:

getSelectItemText(Selection sel)

getSpecialFormSelectItemText

public String getSpecialFormSelectItemText(Selection sel,
                                           String form)

This method is generally used to retrieve special forms for a (select or 1select) item, e.g. "audio", "video", etc.

Parameters:

sel - - The Item whose text you're trying to retrieve.

form - - Special text form of Item you're trying to retrieve.

Returns:

Special Form Text. null if no text for this element exists (with the specified special form).

Throws:

RuntimeException - if this method is called on an element that is NOT a QuestionDef

IllegalArgumentException - if sel == null

getSpecialFormSelectChoiceText

public String getSpecialFormSelectChoiceText(SelectChoice sel,
                                             String form)

requestConstraintHint

public void requestConstraintHint(ConstraintHint hint)
                           throws UnpivotableExpressionException

Throws:

UnpivotableExpressionException