public class RadioGroupElement extends PromptElement implements PromptInterfaces.Caption, PromptInterfaces.DataReference, PromptInterfaces.Focus, PromptInterfaces.QuoteCharacter, PromptInterfaces.ItemList, PromptInterfaces.Locked, PromptInterfaces.XPath, PromptInterfaces.XmlKey
Constructor and Description |
---|
RadioGroupElement(String variableName,
UC4ObjectName reference)
Creates a new
RadioGroupElement . |
Modifier and Type | Method and Description |
---|---|
String |
getCaption() |
UC4ObjectName |
getDataReference() |
List<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.
|
String |
getXmlKey()
Returns the key for XML Variables in the data reference.
|
String |
getXPath()
Returns the XPath expression if XML variables are used as data reference.
|
boolean |
hasFocus()
Returns
true if the focus is set. |
boolean |
isLocked()
Returns
true if this Prompt Element is locked. |
void |
setCaption(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 ".
|
void |
setXmlKey(String key)
Sets the key in case XML Variables are used as data reference.
|
void |
setXPath(String xpath)
Sets the XPath expression if XML variables are used as data reference.
|
getCustomField, getMessageInsert, getMessageNumber, getProperty, getTooltip, getValue, getValues, getVariable, hasList, isAltView, setAltView, setCustomField, setTooltip, setValue, setValues, setVariable, toString, updateDefaultValue
public RadioGroupElement(String variableName, UC4ObjectName reference)
RadioGroupElement
.variableName
- Name of the script variablereference
- Referencepublic void setQuoteCharacter(char c)
setQuoteCharacter
in interface PromptInterfaces.QuoteCharacter
c
- Characterpublic char getQuoteCharacter()
getQuoteCharacter
in interface PromptInterfaces.QuoteCharacter
public boolean hasFocus()
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.hasFocus
in interface PromptInterfaces.Focus
public void setFocus(boolean value)
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.setFocus
in interface PromptInterfaces.Focus
value
- true if the cursor should be set in this Prompt Element, false otherwisepublic List<String> getItemList()
getItemList
in interface PromptInterfaces.ItemList
public boolean isLocked()
true
if this Prompt Element is locked.
In this case a user cannot change the default value in the Prompt-Screen.isLocked
in interface PromptInterfaces.Locked
public void setLocked(boolean locked)
setLocked
in interface PromptInterfaces.Locked
locked
- true if locked, false if the user can change the value of the Prompt Elementpublic String getCaption()
getCaption
in interface PromptInterfaces.Caption
public void setCaption(String caption)
setCaption
in interface PromptInterfaces.Caption
caption
- Captionpublic void setDataReference(UC4ObjectName vara)
setDataReference
in interface PromptInterfaces.DataReference
vara
- Name of a Variable Objectpublic UC4ObjectName getDataReference()
getDataReference
in interface PromptInterfaces.DataReference
public void setXmlKey(String key)
setXmlKey
in interface PromptInterfaces.XmlKey
key
- Keypublic String getXmlKey()
getXmlKey
in interface PromptInterfaces.XmlKey
public void setXPath(String xpath)
setXPath
in interface PromptInterfaces.XPath
xpath
- XPath/Query expressionpublic String getXPath()
getXPath
in interface PromptInterfaces.XPath
Copyright © 2021. All rights reserved.