com.uc4.api.prompt

Class RadioGroupElement

java.lang.Object

com.uc4.api.objects.PromptElement

com.uc4.api.prompt.RadioGroupElement

public class RadioGroupElement
extends PromptElement

This class represents a radio group element.

Constructor Summary

Constructors

Constructor and Description
RadioGroupElement(java.lang.String variableName, UC4ObjectName reference) Creates a new RadioGroupElement.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCaption()
UC4ObjectName	getDataReference()
java.util.List<java.lang.String>	getItemList() When a Prompt is executed (see request TaskPromptSetContent) this method returns a list of valid items.
char	getQuoteCharacter() Returns the character for a quote.
boolean	hasFocus() Returns true if the focus is set.
boolean	isLocked() Returns true if this Prompt Element is locked.
void	setCaption(java.lang.String caption) Sets the caption of this prompt element.
void	setDataReference(UC4ObjectName vara) Sets a VARA Object which contains a list of valid entries for this prompt element.
void	setFocus(boolean value) Sets the cursor focus: The cursor is placed at this control if the value is true.
void	setLocked(boolean locked) Lock or unlocks this element.
void	setQuoteCharacter(char c) Sets the character for a quote, for example ' or ".

Methods inherited from class com.uc4.api.objects.PromptElement

getCustomField, getMessageInsert, getMessageNumber, getProperty, getTooltip, getValue, getValues, getVariable, hasList, setCustomField, setTooltip, setValue, setValues, setVariable, toString, updateDefaultValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RadioGroupElement

public RadioGroupElement(java.lang.String variableName,
                 UC4ObjectName reference)

Creates a new RadioGroupElement.

Parameters:

variableName - Name of the script variable

reference - Reference

Method Detail

setQuoteCharacter

public void setQuoteCharacter(char c)

Sets the character for a quote, for example ' or ".

Parameters:

c - Character

getQuoteCharacter

public char getQuoteCharacter()

Returns the character for a quote.

Returns:

for example ' or "

hasFocus

public boolean hasFocus()

Returns true if the focus is set. The cursor is placed at this control if the value is true. It may only be defined for one control in the PromptSet. If this flag is defined for several Controls of a PromptSet the last Control that got the flag wins.

Returns:

true if the cursor should be set in this Prompt Element, false otherwise

setFocus

public void setFocus(boolean value)

Sets the cursor focus: The cursor is placed at this control if the value is true. It may only be defined for one control in the PromptSet. If this flag is defined for several Controls of a PromptSet the last Control that got the flag wins.

Parameters:

value - true if the cursor should be set in this Prompt Element, false otherwise

getItemList

public java.util.List<java.lang.String> getItemList()

When a Prompt is executed (see request TaskPromptSetContent) this method returns a list of valid items.

Returns:

List of items

isLocked

public boolean isLocked()

Returns true if this Prompt Element is locked. In this case a user cannot change the default value in the Prompt-Screen.

Returns:

true if locked, false if the user can change the value of the Prompt Element

setLocked

public void setLocked(boolean locked)

Lock or unlocks this element. A user cannot change the default value in the Prompt-Screen if a control is locked.

Parameters:

locked - true if locked, false if the user can change the value of the Prompt Element

getCaption

public java.lang.String getCaption()

Returns:

Caption of this prompt element

setCaption

public void setCaption(java.lang.String caption)

Sets the caption of this prompt element.

Parameters:

caption - Caption

setDataReference

public void setDataReference(UC4ObjectName vara)

Sets a VARA Object which contains a list of valid entries for this prompt element.

Parameters:

vara - Name of a Variable Object

getDataReference

public UC4ObjectName getDataReference()

Returns:

Name of a Variable Object