FormEntryCaption (javarosa 4.1.0 API)

java.lang.Object
- org.javarosa.form.api.FormEntryCaption

All Implemented Interfaces:

FormElementStateListener

Direct Known Subclasses:

FormEntryPrompt
```
public class FormEntryCaption
extends Object
implements FormElementStateListener
```
This class gives you all the information you need to display a caption when your current FormIndex references a GroupEvent, RepeatPromptEvent, or RepeatEvent.

Author:

Simon Kelly

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class FormEntryCaption.RepeatOptions

Nested Classes
Modifier and Type	Class and Description
`class`	`FormEntryCaption.RepeatOptions`

Field Summary

Fields
Modifier and Type	Field and Description
`protected IFormElement`	`element`
`static String`	`TEXT_FORM_AUDIO`
`static String`	`TEXT_FORM_IMAGE`
`static String`	`TEXT_FORM_LONG`
`static String`	`TEXT_FORM_SHORT`
`static String`	`TEXT_FORM_VIDEO`
`protected IQuestionWidget`	`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
Constructor and Description
`FormEntryCaption()` This empty constructor exists for convenience of any supertypes of this prompt
`FormEntryCaption(FormDef form, FormIndex index)` Creates a FormEntryCaption for the element at the given index in the form.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`formElementStateChanged(IFormElement element, int changeFlags)`
`void`	`formElementStateChanged(TreeElement instanceNode, int changeFlags)`
`String`	`getAppearanceHint()`
`String`	`getAudioText()` Convenience method Get audio URI from Text form for THIS element (if available)
`IFormElement`	`getFormElement()`
`String`	`getImageText()` Convenience method Get image URI form of text for THIS element (if available)
`FormIndex`	`getIndex()`
`protected String`	`getIText(String textID, String form)`
`String`	`getLongText()` Convenience method Get longText form of text for THIS element (if available) !!Falls back to default form if 'long' form does not exist.!! Use getSpecialFormQuestionText() if you want short form only.
`int`	`getMultiplicity()`
`int`	`getNumRepetitions()`
`String`	`getQuestionText()` Same as getQuestionText(String textID), but for the current element textID;
`String`	`getQuestionText(String textID)` Attempts to return question text for this element.
`FormEntryCaption.RepeatOptions`	`getRepeatOptions()`
`String`	`getRepeatText(String typeKey)`
`List<String>`	`getRepetitionsText()`
`String`	`getRepetitionText(boolean newrep)`
`String`	`getShortText()` Convenience method Get shortText form of text for THIS element (if available) !!Falls back to default form if 'short' form does not exist.!! Use getSpecialFormQuestionText() if you want short form only.
`String`	`getSpecialFormQuestionText(String form)` Same as getSpecialFormQuestionText(String textID,String form) except that the textID defaults to the textID of the current element.
`String`	`getSpecialFormQuestionText(String textID, String form)` This method is generally used to retrieve special forms of a textID, e.g.
`protected String`	`getTextID()`
`protected Localizer`	`localizer()`
`void`	`register(IQuestionWidget viewWidget)`
`boolean`	`repeats()`
`protected String`	`substituteStringArgs(String templateStr)`
`void`	`unregister()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - element
```
protected IFormElement element
```
  - TEXT_FORM_LONG
```
public static final String TEXT_FORM_LONG
```
    See Also:
    
    Constant Field Values
  - TEXT_FORM_SHORT
```
public static final String TEXT_FORM_SHORT
```
    See Also:
    
    Constant Field Values
  - TEXT_FORM_AUDIO
```
public static final String TEXT_FORM_AUDIO
```
    See Also:
    
    Constant Field Values
  - TEXT_FORM_IMAGE
```
public static final String TEXT_FORM_IMAGE
```
    See Also:
    
    Constant Field Values
  - TEXT_FORM_VIDEO
```
public static final String TEXT_FORM_VIDEO
```
    See Also:
    
    Constant Field Values
  - viewWidget
```
protected IQuestionWidget viewWidget
```
- Constructor Detail
  - FormEntryCaption
```
public FormEntryCaption()
```
    This empty constructor exists for convenience of any supertypes of this prompt
  - FormEntryCaption
```
public FormEntryCaption(FormDef form,
                        FormIndex index)
```
    Creates a FormEntryCaption for the element at the given index in the form.
    
    Parameters:
    
    form -
    
    index -
- Method Detail
  - getLongText
```
public String getLongText()
```
    Convenience method Get longText form of text for THIS element (if available) !!Falls back to default form if 'long' form does not exist.!! Use getSpecialFormQuestionText() if you want short form only.
    
    Returns:
    
    longText form
  - getShortText
```
public String getShortText()
```
    Convenience method Get shortText form of text for THIS element (if available) !!Falls back to default form if 'short' form does not exist.!! Use getSpecialFormQuestionText() if you want short form only.
    
    Returns:
    
    shortText form
  - getAudioText
```
public String getAudioText()
```
    Convenience method Get audio URI from Text form for THIS element (if available)
    
    Returns:
    
    audio URI form stored in current locale of Text, returns null if not available
  - getImageText
```
public String getImageText()
```
    Convenience method Get image URI form of text for THIS element (if available)
    
    Returns:
    
    URI of image form stored in current locale of Text, returns null if not available
  - getQuestionText
```
public String getQuestionText(String textID)
```
    Attempts to return question text for this element. Will check for text in the following order:
    Localized Text (long form) -> Localized Text (no special form)
    If no textID is specified, method will return THIS element's labelInnerText.
    
    Parameters:
    
    textID - - The textID of the text you're trying to retrieve. if textID == null will get LabelInnerText for current element
    
    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
  - getQuestionText
```
public String getQuestionText()
```
    Same as getQuestionText(String textID), but for the current element textID;
    
    Returns:
    
    Question Text
    
    See Also:
    
    getQuestionText(String textID)
  - getSpecialFormQuestionText
```
public String getSpecialFormQuestionText(String textID,
                                         String form)
```
    This method is generally used to retrieve special forms of a textID, e.g. "audio", "video", etc.
    
    Parameters:
    
    textID - - The textID of the text you're trying to retrieve.
    
    form - - special text form of textID you're trying to retrieve.
    
    Returns:
    
    Special Form Question 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
  - getSpecialFormQuestionText
```
public String getSpecialFormQuestionText(String form)
```
    Same as getSpecialFormQuestionText(String textID,String form) except that the textID defaults to the textID of the current element.
    
    Parameters:
    
    form - - special text form of textID you're trying to retrieve.
    
    Returns:
    
    Special Form Question 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
  - getIText
```
protected String getIText(String textID,
                          String form)
```
    Parameters:
    
    textID - - the textID of the text you'd like to retrieve
    
    form - - the special form (e.g. "audio","long", etc) of the text
    
    Returns:
    
    the IText for the parameters specified.
  - getRepeatText
```
public String getRepeatText(String typeKey)
```
  - getNumRepetitions
```
public int getNumRepetitions()
```
  - getRepetitionText
```
public String getRepetitionText(boolean newrep)
```
  - getRepetitionsText
```
public List<String> getRepetitionsText()
```
  - getRepeatOptions
```
public FormEntryCaption.RepeatOptions getRepeatOptions()
```
  - getAppearanceHint
```
public String getAppearanceHint()
```
  - substituteStringArgs
```
protected String substituteStringArgs(String templateStr)
```
  - getMultiplicity
```
public int getMultiplicity()
```
  - getFormElement
```
public IFormElement getFormElement()
```
  - repeats
```
public boolean repeats()
```
    Returns:
    
    true if this represents a element
  - getIndex
```
public FormIndex getIndex()
```
  - localizer
```
protected Localizer localizer()
```
  - register
```
public void register(IQuestionWidget viewWidget)
```
  - unregister
```
public void unregister()
```
  - formElementStateChanged
```
public void formElementStateChanged(IFormElement element,
                                    int changeFlags)
```
    Specified by:
    
    formElementStateChanged in interface FormElementStateListener
  - formElementStateChanged
```
public void formElementStateChanged(TreeElement instanceNode,
                                    int changeFlags)
```
    Specified by:
    
    formElementStateChanged in interface FormElementStateListener
  - getTextID
```
protected String getTextID()
```

Class FormEntryCaption

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

element

TEXT_FORM_LONG

TEXT_FORM_SHORT

TEXT_FORM_AUDIO

TEXT_FORM_IMAGE

TEXT_FORM_VIDEO

viewWidget

Constructor Detail

FormEntryCaption

FormEntryCaption

Method Detail

getLongText

getShortText

getAudioText

getImageText

getQuestionText

getQuestionText

getSpecialFormQuestionText

getSpecialFormQuestionText

getIText

getRepeatText

getNumRepetitions

getRepetitionText

getRepetitionsText

getRepeatOptions

getAppearanceHint

substituteStringArgs

getMultiplicity

getFormElement

repeats

getIndex

localizer

register

unregister

formElementStateChanged

formElementStateChanged

getTextID