public class GxOptionsDateTime
The class defines the common date time options shared between components which manipulate dates , times & timestamps
Modifier and Type | Field and Description |
---|---|
BBjNumber | AllowInput! When true then accepts direct user's input from the input field. |
BBjNumber | DefaultHour! Initial value of the hour element. |
BBjNumber | DefaultMinute! Initial value of the minute element. |
BBjNumber | DisableMobile! Set disableMobile to true to always use the non-native picker. |
BBjNumber | Enable24HR! Enable / disable time 24 format. |
BBjNumber | EnableCalendar! Enable / disable Calendar input. |
BBjNumber | EnableSeconds! Enable / disable seconds selection |
BBjNumber | EnableTime! Enable / disable time selection |
BBjNumber | EnableWeekNumber! Enables display of week numbers in calendar. |
GxExpressionInterface | FormatterExpression! A valid expression which validates the datetime |
BBjString | Locale! The locale used to format and display dates and times. default to the System settings |
BBjString | Mask! The Date mask for calender input |
BBjString | Max! A valid iso 8601 datetime which defines the max allowed value in the calender |
BBjString | Min! A valid iso 8601 datetime which defines the min allowed value in the calender |
Modifier and Type | Method and Description |
---|---|
BBjNumber | getAllowInput() |
JsonObject | getAsJsonObject() Transform the options object to json |
void | setAllowInput(BBjNumber allow!) |
void | setDefaultHour(BBjNumber hour!) Set the initial value of the hour element. |
void | setDefaultMinute(BBjNumber minute!) Set the initial value of the minute element. |
void | setEnable24HR(BBjNumber enabled!) Enable / disable time 24 format. |
void | setFormatterExpression(BBjString expression!) Create a GxExpression from string and set it as FormatterExpression |
public BBjNumber AllowInput!
When true then accepts direct user's input from the input field.
since version 0.101.0, GxOptionsDateTime.AllowInput is deprecated. Direct input is always disabled.
public BBjNumber DefaultHour!
Initial value of the hour element.
public BBjNumber DefaultMinute!
Initial value of the minute element.
public BBjNumber DisableMobile!
Set disableMobile to true to always use the non-native picker.
public BBjNumber Enable24HR!
Enable / disable time 24 format.
public BBjNumber EnableCalendar!
Enable / disable Calendar input.
public BBjNumber EnableSeconds!
Enable / disable seconds selection
public BBjNumber EnableTime!
Enable / disable time selection
public BBjNumber EnableWeekNumber!
Enables display of week numbers in calendar.
public GxExpressionInterface FormatterExpression!
A valid expression which validates the datetime
public BBjString Locale!
The locale used to format and display dates and times. default to the System settings
public BBjString Mask!
The Date mask for calender input
public BBjString Max!
A valid iso 8601 datetime which defines the max allowed value in the calender
public BBjString Min!
A valid iso 8601 datetime which defines the min allowed value in the calender
public BBjNumber getAllowInput()
since version 0.101.0, GxOptionsDateTime.getAllowInput() is deprecated. Direct input is always disabled.
public JsonObject getAsJsonObject()
Transform the options object to json
public void setAllowInput(BBjNumber allow!)
since version 0.101.0, GxOptionsDateTime.setAllowInput(BBjNumber allow!) is deprecated. Direct input is always disabled.
public void setDefaultHour(BBjNumber hour!)
Set the initial value of the hour element.
hour!
- if Enable24HR is true , the hour must be between 0 & 24 , otherwise between 0 & 12public void setDefaultMinute(BBjNumber minute!)
Set the initial value of the minute element.
minute!
- value in range 0 ~ 60public void setEnable24HR(BBjNumber enabled!)
Enable / disable time 24 format.
hour!
- 1 for enabled , 0 for disabledpublic void setFormatterExpression(BBjString expression!)
Create a GxExpression from string and set it as FormatterExpression
BBjString
expression! Javascript expression