Package io.jmix.ui.component

Interface DateField<V>

Type Parameters:

V - type of value

All Superinterfaces:

Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Field<V>, HasContextHelp, HasDatatype<V>, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasRange<V>, HasValidator<V>, HasValue<V>, HasValueSource<V>, Requirable, Validatable

All Known Implementing Classes:

DateFieldImpl

@StudioComponent(caption="DateField",
                 category="Components",
                 xmlElement="dateField",
                 icon="io/jmix/ui/icon/component/dateField.svg",
                 canvasBehaviour=DATE_FIELD,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/vcl/components/date-field.html")
public interface DateField<V>
extends Field<V>, HasDatatype<V>, Buffered, Component.Focusable, HasRange<V>

A date entry component, which displays the actual date selector or date with time.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	DateField.Resolution

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final org.springframework.core.ParameterizedTypeReference<DateField<Date>>	TYPE_DATE
static final org.springframework.core.ParameterizedTypeReference<DateField<Date>>	TYPE_DATETIME
static final org.springframework.core.ParameterizedTypeReference<DateField<Date>>	TYPE_DEFAULT
static final org.springframework.core.ParameterizedTypeReference<DateField<LocalDate>>	TYPE_LOCALDATE
static final org.springframework.core.ParameterizedTypeReference<DateField<LocalDateTime>>	TYPE_LOCALDATETIME
static final org.springframework.core.ParameterizedTypeReference<DateField<OffsetDateTime>>	TYPE_OFFSETDATETIME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
String	getDateFormat()
DateField.Resolution	getResolution()
TimeField.TimeMode	getTimeMode()
TimeZone	getTimeZone()	Use getZoneId()
ZoneId	getZoneId()
boolean	isAutofill()
void	setAutofill(boolean autofill)	Sets whether autofill feature is enabled.
void	setDateFormat(String dateFormat)
void	setResolution(DateField.Resolution resolution)
void	setTimeMode(TimeField.TimeMode timeMode)	Sets time mode to use (12h AM/PM or 24h).
void	setTimeZone(TimeZone timeZone)	Use setZoneId(ZoneId)
void	setZoneId(ZoneId zoneId)

Methods inherited from interface io.jmix.ui.component.Buffered

commit, discard, isBuffered, isModified, setBuffered

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasDatatype

getDatatype, setDatatype

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasRange

getRangeEnd, getRangeStart, setRangeEnd, setRangeStart

Methods inherited from interface io.jmix.ui.component.HasValidator

addValidator, addValidators, getValidators, removeValidator

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

TYPE_DEFAULT

static final org.springframework.core.ParameterizedTypeReference<DateField<Date>> TYPE_DEFAULT

TYPE_DATE

static final org.springframework.core.ParameterizedTypeReference<DateField<Date>> TYPE_DATE

TYPE_DATETIME

static final org.springframework.core.ParameterizedTypeReference<DateField<Date>> TYPE_DATETIME

TYPE_LOCALDATE

static final org.springframework.core.ParameterizedTypeReference<DateField<LocalDate>> TYPE_LOCALDATE

TYPE_LOCALDATETIME

static final org.springframework.core.ParameterizedTypeReference<DateField<LocalDateTime>> TYPE_LOCALDATETIME

TYPE_OFFSETDATETIME

static final org.springframework.core.ParameterizedTypeReference<DateField<OffsetDateTime>> TYPE_OFFSETDATETIME

Method Details

getResolution

@Nullable
DateField.Resolution getResolution()

setResolution

@StudioProperty(type=ENUMERATION,
                options={"YEAR","MONTH","DAY","HOUR","MIN","SEC"})
void setResolution(DateField.Resolution resolution)

getDateFormat

@Nullable
String getDateFormat()

setDateFormat

@StudioProperty(type=LOCALIZED_STRING)
void setDateFormat(String dateFormat)

getTimeZone

@Nullable
TimeZone getTimeZone()

Use getZoneId()

setTimeZone

void setTimeZone(@Nullable
 TimeZone timeZone)

Use setZoneId(ZoneId)

setZoneId

void setZoneId(@Nullable
 ZoneId zoneId)

getZoneId

@Nullable
ZoneId getZoneId()

setAutofill

@StudioProperty(defaultValue="false")
void setAutofill(boolean autofill)

Sets whether autofill feature is enabled.

When enabled uses current month and year.

Parameters:

autofill - whether autofill is enabled

isAutofill

boolean isAutofill()

Returns:

whether autofill is enabled

setTimeMode

@StudioProperty(name="timeMode",
                type=ENUMERATION,
                defaultValue="H_24",
                options={"H_12","H_24"})
void setTimeMode(TimeField.TimeMode timeMode)

Sets time mode to use (12h AM/PM or 24h).

By default the 24h mode is used.

Parameters:

timeMode - time mode

getTimeMode

@Nullable
TimeField.TimeMode getTimeMode()

Returns:

TimeField.TimeMode that is used by component