public class DateElement extends PromptElement implements PromptInterfaces.Caption, PromptInterfaces.Focus, PromptInterfaces.OutputFormat, PromptInterfaces.DataReference, PromptInterfaces.Locked, PromptInterfaces.Constraints<DateTime>
Constructor and Description |
---|
DateElement(String variableName,
UC4ObjectName reference)
Creates a new
DateElement . |
Modifier and Type | Method and Description |
---|---|
@Nullable CalendarCondition |
getCalendarCondition() |
String |
getCaption() |
UC4ObjectName |
getDataReference() |
DateTime |
getMaximumValue()
Deprecated.
use getMaxValue instead
|
DateTime |
getMaxValue() |
DateTime |
getMinimumValue()
Deprecated.
use getMinValue instead
|
DateTime |
getMinValue() |
String |
getOutputFormat() |
boolean |
hasFocus()
Returns
true if the focus is set. |
boolean |
isLocked()
Returns
true if this Prompt Element is locked. |
void |
setCalendarCondition(@Nullable CalendarCondition cond)
Sets the calendar and keyword for valid inputs.
|
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 |
setMaximumValue(DateTime value)
Deprecated.
use setMaxValue instead
|
void |
setMaxValue(DateTime maxValue) |
void |
setMinimumValue(DateTime value)
Deprecated.
use setMinValue instead
|
void |
setMinValue(DateTime minValue) |
void |
setOutputFormat(@Nullable String outputformat)
Sets the output format.
|
void |
setValue(DateTime value)
Sets the default value.
|
getCustomField, getMessageInsert, getMessageNumber, getProperty, getTooltip, getValue, getValues, getVariable, hasList, isAltView, setAltView, setCustomField, setTooltip, setValue, setValues, setVariable, toString, updateDefaultValue
public DateElement(String variableName, UC4ObjectName reference)
DateElement
.variableName
- Name of the script variablereference
- Name of the reference variablepublic 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 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
@Deprecated public void setMinimumValue(DateTime value)
value
- Min value@Deprecated public DateTime getMinimumValue()
@Deprecated public void setMaximumValue(DateTime value)
value
- Max value@Deprecated public DateTime getMaximumValue()
public String getOutputFormat()
getOutputFormat
in interface PromptInterfaces.OutputFormat
public void setOutputFormat(@Nullable String outputformat)
setOutputFormat
in interface PromptInterfaces.OutputFormat
outputformat
- Output formatpublic void setCalendarCondition(@Nullable CalendarCondition cond)
cond
- the calendar condition, may be nullpublic @Nullable CalendarCondition getCalendarCondition()
public void setValue(DateTime value)
value
- Valuepublic void setMaxValue(DateTime maxValue)
setMaxValue
in interface PromptInterfaces.Constraints<DateTime>
maxValue
- set maximum value @nullablepublic void setMinValue(DateTime minValue)
setMinValue
in interface PromptInterfaces.Constraints<DateTime>
minValue
- set minimum value @nullablepublic DateTime getMaxValue()
getMaxValue
in interface PromptInterfaces.Constraints<DateTime>
public DateTime getMinValue()
getMinValue
in interface PromptInterfaces.Constraints<DateTime>
Copyright © 2021. All rights reserved.