com.uc4.api.prompt

Class TimeElement

java.lang.Object

com.uc4.api.objects.PromptElement

com.uc4.api.prompt.TimeElement

All Implemented Interfaces:

PromptInterfaces.Caption, PromptInterfaces.Constraints<Time>, PromptInterfaces.DataReference, PromptInterfaces.Focus, PromptInterfaces.Locked

public class TimeElement
extends PromptElement
implements PromptInterfaces.Caption, PromptInterfaces.DataReference, PromptInterfaces.Focus, PromptInterfaces.Locked, PromptInterfaces.Constraints<Time>

This class represents a time prompt element.

Field Summary

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

aliasMap, list, properties

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCaption()
UC4ObjectName	getDataReference()
java.lang.String	getMaximumValue() Deprecated. use getMaxValue instead
Time	getMaxValue()
java.lang.String	getMinimumValue() Deprecated. use getMinValue instead
Time	getMinValue()
protected java.lang.String	getTagName()
boolean	hasFocus() Returns true if the focus is set.
boolean	isLocked() Returns true if this Prompt Element is locked.
protected java.lang.String	listParam()
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	setMaximumValue(java.lang.String value) Deprecated. use setMaxValue instead
void	setMaxValue(Time maxValue)
void	setMinimumValue(java.lang.String value) Deprecated. use setMinValue instead
void	setMinValue(Time minValue)
protected void	validateForExecute(java.lang.String value) Sub classes implement this method

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

getCustomField, getMessageInsert, getMessageNumber, getMode, getProperty, getTooltip, getValue, getValues, getVariable, hasList, isAltView, setAltView, setCustomField, setRawValue, setTooltip, setValue, setValues, setVariable, store, storeAdditionalPromptData, storeDefaultValues, toString, updateDefaultValue, validateId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeElement

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

Creates a new TimeElement.

Parameters:

variableName - Name of the script variable

reference - Reference

Method Detail

listParam

protected java.lang.String listParam()

Overrides:

listParam in class PromptElement

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.

Specified by:

isLocked in interface PromptInterfaces.Locked

Overrides:

isLocked in class PromptElement

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.

Specified by:

setLocked in interface PromptInterfaces.Locked

Overrides:

setLocked in class PromptElement

Parameters:

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

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.

Specified by:

hasFocus in interface PromptInterfaces.Focus

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.

Specified by:

setFocus in interface PromptInterfaces.Focus

Parameters:

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

getCaption

public java.lang.String getCaption()

Specified by:

getCaption in interface PromptInterfaces.Caption

Returns:

Caption of this prompt element

setCaption

public void setCaption(java.lang.String caption)

Sets the caption of this prompt element.

Specified by:

setCaption in interface PromptInterfaces.Caption

Parameters:

caption - Caption

setDataReference

public void setDataReference(UC4ObjectName vara)

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

Specified by:

setDataReference in interface PromptInterfaces.DataReference

Parameters:

vara - Name of a Variable Object

getDataReference

public UC4ObjectName getDataReference()

Specified by:

getDataReference in interface PromptInterfaces.DataReference

Returns:

Name of a Variable Object

setMinimumValue

@Deprecated
public void setMinimumValue(java.lang.String value)

Deprecated. use setMinValue instead

Sets the minimum value.

Parameters:

value - Min value

getMinimumValue

@Deprecated
public java.lang.String getMinimumValue()

Deprecated. use getMinValue instead

Returns the minimum value.

Returns:

Min value

setMaximumValue

@Deprecated
public void setMaximumValue(java.lang.String value)

Deprecated. use setMaxValue instead

Sets the maximum value.

Parameters:

value - Max value

getMaximumValue

@Deprecated
public java.lang.String getMaximumValue()

Deprecated. use getMaxValue instead

Returns the maximum value.

Returns:

Max value

validateForExecute

protected void validateForExecute(java.lang.String value)

Description copied from class: PromptElement

Sub classes implement this method

Overrides:

validateForExecute in class PromptElement

Parameters:

value - Value

getTagName

protected java.lang.String getTagName()

Specified by:

getTagName in class PromptElement

getMaxValue

public Time getMaxValue()

Specified by:

getMaxValue in interface PromptInterfaces.Constraints<Time>

Returns:

maximum value @nullable

setMaxValue

public void setMaxValue(Time maxValue)

Specified by:

setMaxValue in interface PromptInterfaces.Constraints<Time>

Parameters:

maxValue - set maximum value @nullable

getMinValue

public Time getMinValue()

Specified by:

getMinValue in interface PromptInterfaces.Constraints<Time>

Returns:

minimum value @nullable

setMinValue

public void setMinValue(Time minValue)

Specified by:

setMinValue in interface PromptInterfaces.Constraints<Time>

Parameters:

minValue - set minimum value @nullable