com.vaadin.ui

Class DateTimeField

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractField<T>

com.vaadin.ui.AbstractDateField<LocalDateTime,DateTimeResolution>

com.vaadin.ui.AbstractLocalDateTimeField

com.vaadin.ui.DateTimeField

All Implemented Interfaces:

HasValue<LocalDateTime>, ContextClickEvent.ContextClickNotifier, FieldEvents.BlurNotifier, FieldEvents.FocusNotifier, MethodEventSource, ClientConnector, Sizeable, Connector, Component, Component.Focusable, Serializable

public class DateTimeField
extends AbstractLocalDateTimeField

A date time entry component, which displays the actual date selector as a popup.

Since:

8.0

Author:

Vaadin Ltd.

See Also:

AbstractLocalDateTimeField, InlineDateTimeField, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.data.HasValue

HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<V>

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Sizeable.Unit

Field Summary

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
DateTimeField() Constructs an empty DateTimeField with no caption.
DateTimeField(HasValue.ValueChangeListener<LocalDateTime> valueChangeListener) Constructs a new DateTimeField with a value change listener.
DateTimeField(String caption) Constructs an empty DateTimeField with caption.
DateTimeField(String caption, HasValue.ValueChangeListener<LocalDateTime> valueChangeListener) Constructs a new DateTimeField with the given caption and a value change listener.
DateTimeField(String caption, LocalDateTime value) Constructs a new DateTimeField with the given caption and initial text contents.
DateTimeField(String caption, LocalDateTime value, HasValue.ValueChangeListener<LocalDateTime> valueChangeListener) Constructs a new DateTimeField with the given caption, initial text contents and a value change listener.

Method Summary

Modifier and Type	Method and Description
String	getAssistiveText() Get the description that explains the usage of the Widget for users of assistive devices.
String	getPlaceholder() Returns the current placeholder text.
protected LocalDateTimeFieldState	getState() Returns the shared state bean with information to be sent from the server to the client.
protected LocalDateTimeFieldState	getState(boolean markAsDirty) Returns the shared state for this connector.
boolean	isTextFieldEnabled() Checks whether the text field is enabled (default) or not.
void	setAssistiveText(String description) Set a description that explains the usage of the Widget for users of assistive devices.
void	setPlaceholder(String placeholder) Sets the placeholder text.
void	setTextFieldEnabled(boolean state) Enables or disables the text field.

Methods inherited from class com.vaadin.ui.AbstractLocalDateTimeField

adjustToResolution, buildDate, convertFromDate, convertToDate, formatDate, getDatePart, getRangeValidator, toType

Methods inherited from class com.vaadin.ui.AbstractDateField

addBlurListener, addFocusListener, afterDate, beforeClientResponse, convertFromDateString, convertToDateString, doSetValue, getAssistiveLabel, getDateFormat, getDateOutOfRangeMessage, getDateStyle, getDateStyles, getDefaultValidator, getDefaultValue, getParseErrorMessage, getRangeEnd, getRangeStart, getResolution, getValue, getZoneId, handleUnparsableDateString, isLenient, isPreventInvalidInput, isShowISOWeekNumbers, readDesign, reconstructDateFromFields, setAssistiveLabel, setDateFormat, setDateOutOfRangeMessage, setDateStyle, setDaylightSavingTimeRange, setDefaultValue, setLenient, setLocale, setParseErrorMessage, setPreventInvalidInput, setRangeEnd, setRangeStart, setResolution, setShowISOWeekNumbers, setValue, setZoneId, writeDesign

Methods inherited from class com.vaadin.ui.AbstractField

addValueChangeListener, createValueChange, focus, getCustomAttributes, getTabIndex, isDifferentValue, isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible, setTabIndex, setValue

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.data.HasValue

clear, getEmptyValue, getOptionalValue, isEmpty

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

Constructor Detail

DateTimeField

public DateTimeField()

Constructs an empty DateTimeField with no caption.

DateTimeField

public DateTimeField(String caption,
                     LocalDateTime value)

Constructs a new DateTimeField with the given caption and initial text contents.

Parameters:

caption - the caption String for the editor.

value - the LocalDateTime value.

DateTimeField

public DateTimeField(String caption)

Constructs an empty DateTimeField with caption.

Parameters:

caption - the caption of the datefield.

DateTimeField

public DateTimeField(HasValue.ValueChangeListener<LocalDateTime> valueChangeListener)

Constructs a new DateTimeField with a value change listener.

The listener is called when the value of this DateTimeField is changed either by the user or programmatically.

Parameters:

valueChangeListener - the value change listener, not null

DateTimeField

public DateTimeField(String caption,
                     HasValue.ValueChangeListener<LocalDateTime> valueChangeListener)

Constructs a new DateTimeField with the given caption and a value change listener.

The listener is called when the value of this DateTimeField is changed either by the user or programmatically.

Parameters:

caption - the caption for the field

valueChangeListener - the value change listener, not null

DateTimeField

public DateTimeField(String caption,
                     LocalDateTime value,
                     HasValue.ValueChangeListener<LocalDateTime> valueChangeListener)

Constructs a new DateTimeField with the given caption, initial text contents and a value change listener.

The listener is called when the value of this DateTimeField is changed either by the user or programmatically.

Parameters:

caption - the caption for the field

value - the value for the field, not null

valueChangeListener - the value change listener, not null

Method Detail

getPlaceholder

public String getPlaceholder()

Returns the current placeholder text.

Returns:

the placeholder text

See Also:

setPlaceholder(String)

setPlaceholder

public void setPlaceholder(String placeholder)

Sets the placeholder text. The placeholder is text that is displayed when the field would otherwise be empty, to prompt the user for input.

Parameters:

placeholder - the placeholder text to set

getState

protected LocalDateTimeFieldState getState()

Description copied from class: AbstractComponent

Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().

Overrides:

getState in class AbstractLocalDateTimeField

Returns:

updated component shared state

getState

protected LocalDateTimeFieldState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class AbstractLocalDateTimeField

Parameters:

markAsDirty - true if the connector should automatically be marked dirty, false otherwise

Returns:

The shared state for this connector. Never null.

See Also:

AbstractClientConnector.getState()

isTextFieldEnabled

public boolean isTextFieldEnabled()

Checks whether the text field is enabled (default) or not.

Returns:

true if the text field is enabled, false otherwise.

See Also:

setTextFieldEnabled(boolean)

setTextFieldEnabled

public void setTextFieldEnabled(boolean state)

Enables or disables the text field. By default the text field is enabled. Disabling it causes only the button for date selection to be active, thus preventing the user from entering invalid dates. See issue 6790.

Parameters:

state - true to enable text field, false to disable it.

setAssistiveText

public void setAssistiveText(String description)

Set a description that explains the usage of the Widget for users of assistive devices.

Parameters:

description - String with the description

getAssistiveText

public String getAssistiveText()

Get the description that explains the usage of the Widget for users of assistive devices.

Returns:

String with the description