public class ComboElement extends OnChangeResetElement
Constructor and Description |
---|
ComboElement(java.lang.String variableName,
UC4ObjectName reference) |
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.
|
java.lang.String |
getXmlKey()
Returns the key for XML Variables in the data reference.
|
java.lang.String |
getXPath()
Returns the XPath expression if XML variables are used as data reference.
|
boolean |
hasFocus()
Returns
true if the focus is set. |
boolean |
isDynamic()
Returns
true if the "dynamic" property 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 |
setDynamic(boolean value)
Sets the "dynamic" property.
|
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(java.lang.String key)
Sets the key in case XML Variables are used as data reference.
|
void |
setXPath(java.lang.String xpath)
Sets the XPath expression if XML variables are used as data reference.
|
addOnChangeResetElement, getAllOnChangeResetElementIterator, onChangeResetElementIterator, removeAllOnChangeResetElements, removeOnChangeResetElement, resetAllSubValues, sizeOfOnChangeResetElements
getCustomField, getMessageInsert, getMessageNumber, getProperty, getTooltip, getValue, getValues, getVariable, hasList, setCustomField, setTooltip, setValue, setValues, setVariable, toString, updateDefaultValue
public ComboElement(java.lang.String variableName, UC4ObjectName reference)
variableName
- Name of the script variablereference
- Name of the referencepublic void setQuoteCharacter(char c)
c
- Characterpublic char getQuoteCharacter()
public void setXmlKey(java.lang.String key)
key
- Keypublic java.lang.String getXmlKey()
public void setXPath(java.lang.String xpath)
xpath
- XPath/Query expressionpublic java.lang.String getXPath()
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.public java.util.List<java.lang.String> getItemList()
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.value
- true if the cursor should be set in this Prompt Element, false otherwisepublic boolean isLocked()
true
if this Prompt Element is locked.
In this case a user cannot change the default value in the Prompt-Screen.public void setLocked(boolean locked)
locked
- true if locked, false if the user can change the value of the Prompt Elementpublic java.lang.String getCaption()
public void setCaption(java.lang.String caption)
caption
- Captionpublic boolean isDynamic()
true
if the "dynamic" property is set.public void setDynamic(boolean value)
value
- true if this combo uses other variables in the same or previous prompts for its value list, false if the value list is not
depended on other variables.public void setDataReference(UC4ObjectName vara)
vara
- Name of a Variable Objectpublic UC4ObjectName getDataReference()