com.uc4.api.prompt

Class DateElement

java.lang.Object

com.uc4.api.objects.PromptElement

com.uc4.api.prompt.DateElement

Direct Known Subclasses:

TimeStampElement

public class DateElement
extends PromptElement

This class represents a date prompt element.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CalendarCondition	getCalendarCondition()
java.lang.String	getCaption()
UC4ObjectName	getDataReference()
DateTime	getMaximumValue() Returns the maximum value.
DateTime	getMinimumValue() Returns the minimum value.
java.lang.String	getOutputFormat()
boolean	hasFocus() Returns true if the focus is set.
boolean	isLocked() Returns true if this Prompt Element is locked.
void	setCalendarCondition(CalendarCondition cond) Sets the calendar and keyword for valid inputs.
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(DateTime value) Sets the maximum value.
void	setMinimumValue(DateTime value) Sets the minimum value.
void	setOutputFormat(java.lang.String outputformat) Sets the output format.
void	setValue(DateTime value) Sets the default value.

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

DateElement

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

Creates a new DateElement.

Parameters:

variableName - Name of the script variable

reference - Name of the reference variable

Method Detail

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

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

setMinimumValue

public void setMinimumValue(DateTime value)

Sets the minimum value.

Parameters:

value - Min value

getMinimumValue

public DateTime getMinimumValue()

Returns the minimum value.

Returns:

Min value

setMaximumValue

public void setMaximumValue(DateTime value)

Sets the maximum value.

Parameters:

value - Max value

getMaximumValue

public DateTime getMaximumValue()

Returns the maximum value.

Returns:

Max value

getOutputFormat

public java.lang.String getOutputFormat()

Returns:

Output format

setOutputFormat

public void setOutputFormat(java.lang.String outputformat)

Sets the output format.

Parameters:

outputformat - Output format

setCalendarCondition

public void setCalendarCondition(CalendarCondition cond)

Sets the calendar and keyword for valid inputs.

Parameters:

cond - Calendar condition

getCalendarCondition

public CalendarCondition getCalendarCondition()

Returns:

Calendar condition

setValue

public void setValue(DateTime value)

Sets the default value.

Parameters:

value - Value