com.uc4.api.objects

Class PromptElement

java.lang.Object

com.uc4.api.objects.PromptElement

Direct Known Subclasses:

DateElement, LabelElement, NumberElement, OnChangeResetElement, RadioGroupElement, TimeElement

public abstract class PromptElement
extends Object

Basis class of all prompt elements.

Constructor Summary

Constructors

Constructor and Description
PromptElement()

Method Summary

Modifier and Type	Method and Description
String	getCustomField() Returns the custom field of this Prompt Element.
String	getMessageInsert() This method returns a message insert for the message number returned by getMessageNumber.
int	getMessageNumber() This method returns a message number in case a Prompt is executed but its value is not valid.
String	getProperty(String name) Returns the value of a property by its name.
String	getTooltip() Returns the tooltip of this Prompt Element.
String	getValue() Returns the default value of this prompt element.
String[]	getValues() Returns the list of values if the "Array" property is set.
String	getVariable() Returns the variable name that can be used in the Automation Engine Script.
boolean	hasList() Returns true if the prompt element contains a list of values.
boolean	isAltView() Is this prompt using a variable as default value.
void	setAltView(boolean altview) Is this prompt using a variable as default value
void	setCustomField(String customField) Sets the custom field of this Prompt Element.
void	setTooltip(String tooltip) Sets the tooltip of this Prompt Element.
void	setValue(String value) Sets the default value of this prompt element.
void	setValues(String[] values) Sets the list of values if the "Array" property is set.
void	setVariable(String variable) Sets the variable name that can be used in the Automation Engine Script.
String	toString()
void	updateDefaultValue(Element element) Internal use.

Methods inherited from class java.lang.Object

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

Constructor Detail

PromptElement

public PromptElement()

Method Detail

getTooltip

public String getTooltip()

Returns the tooltip of this Prompt Element.

Returns:

Tooltip

setTooltip

public void setTooltip(String tooltip)

Sets the tooltip of this Prompt Element.

Parameters:

tooltip - Tooltip text

getCustomField

public String getCustomField()

Returns the custom field of this Prompt Element.

Returns:

Custom field

setCustomField

public void setCustomField(String customField)

Sets the custom field of this Prompt Element.

Parameters:

customField - Custom field

getVariable

public String getVariable()

Returns the variable name that can be used in the Automation Engine Script.

Returns:

Name of the Script variable

setValue

public void setValue(String value)

Sets the default value of this prompt element.

Parameters:

value - Default value

setValues

public void setValues(String[] values)

Sets the list of values if the "Array" property is set.

Parameters:

values - Array of Strings containing the values

getValues

public String[] getValues()

Returns the list of values if the "Array" property is set.

Returns:

Array of Strings containing the values

getValue

public String getValue()

Returns the default value of this prompt element.

Returns:

Default value

setVariable

public void setVariable(String variable)

Sets the variable name that can be used in the Automation Engine Script.

Parameters:

variable - Name of the Script variable

hasList

public boolean hasList()

Returns true if the prompt element contains a list of values.

Returns:

Has list?

getProperty

public String getProperty(String name)

Returns the value of a property by its name. The following names can be used:

• tooltip
• enabled
• id

Sub class may add additional properties, for example "required", "focus", "upper".

Parameters:

name - Name of the property

Returns:

Value or null if not found

updateDefaultValue

public void updateDefaultValue(Element element)

Internal use.

Parameters:

element - DOM element

toString

public String toString()

Overrides:

toString in class Object

getMessageNumber

public int getMessageNumber()

This method returns a message number in case a Prompt is executed but its value is not valid. A return value of 0 means that there was no error.

Returns:

Message Number

getMessageInsert

public String getMessageInsert()

This method returns a message insert for the message number returned by getMessageNumber.

Returns:

Message Insert, can be null or an empty String

setAltView

public void setAltView(boolean altview)

Is this prompt using a variable as default value

Parameters:

altview - true to allow variables as input

isAltView

public boolean isAltView()

Is this prompt using a variable as default value.

Returns:

true if alternative view is enabled.