We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.ui.
Class DateField
-
All Implemented Interfaces:
HasValue<LocalDate>,ContextClickEvent.ContextClickNotifier,FieldEvents.BlurNotifier,FieldEvents.FocusNotifier,MethodEventSource,ClientConnector,Sizeable,Connector,Component,Component.Focusable,Serializablepublic class DateField extends AbstractLocalDateFieldA date entry component, which displays the actual date selector as a popup.
Since:
8.0
Author:
Vaadin Ltd.
See Also:
-
-
Nested Class Summary
-
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.ui.Component
Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener
-
Nested classes/interfaces inherited from interface com.vaadin.data.HasValue
HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<V>
-
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 Description DateField()Constructs an empty
DateFieldwith no caption.DateField(HasValue.ValueChangeListener<LocalDate> valueChangeListener)Constructs a new
DateFieldwith a value change listener.DateField(String caption)Constructs an empty
DateFieldwith caption.DateField(String caption, HasValue.ValueChangeListener<LocalDate> valueChangeListener)Constructs a new
DateFieldwith the given caption and a value change listener.DateField(String caption, LocalDate value)Constructs a new
DateFieldwith the given caption and initial text contents.DateField(String caption, LocalDate value, HasValue.ValueChangeListener<LocalDate> valueChangeListener)Constructs a new
DateFieldwith the given caption, initial text contents and a value change listener.DateField(LocalDate value)Constructs a new
DateFieldwith initial date value.
-
Method Summary
All Methods Modifier and Type Method Description StringgetAssistiveText()Get the description that explains the usage of the Widget for users of assistive devices.
StringgetPlaceholder()Returns the current placeholder text.
protected LocalDateFieldStategetState()Returns the shared state bean with information to be sent from the server to the client.
protected LocalDateFieldStategetState(boolean markAsDirty)Returns the shared state for this connector.
booleanisTextFieldEnabled()Checks whether the text field is enabled (default) or not.
voidsetAssistiveText(String description)Set a description that explains the usage of the Widget for users of assistive devices.
voidsetPlaceholder(String placeholder)Sets the placeholder text.
voidsetTextFieldEnabled(boolean state)Enables or disables the text field.
-
Methods inherited from class com.vaadin.ui.AbstractLocalDateField
adjustToResolution, buildDate, convertFromDate, convertToDate, formatDate, getDatePart, getRangeValidator, handleUnparsableDateString, 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, 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.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.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.shared.Connector
getConnectorId
-
Methods inherited from interface com.vaadin.data.HasValue
clear, getEmptyValue, getOptionalValue, isEmpty
-
Methods inherited from interface com.vaadin.server.Sizeable
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined
-
-
-
-
Constructor Detail
-
DateField
public DateField()Constructs an empty
DateFieldwith no caption.
-
DateField
public DateField(String caption, LocalDate value)Constructs a new
DateFieldwith the given caption and initial text contents.Parameters:
caption- the captionStringfor the editor.value- the LocalDate value.
-
DateField
public DateField(LocalDate value)Constructs a new
DateFieldwith initial date value.Parameters:
value- the LocalDate value.
-
DateField
public DateField(String caption)Constructs an empty
DateFieldwith caption.Parameters:
caption- the caption of the datefield.
-
DateField
public DateField(HasValue.ValueChangeListener<LocalDate> valueChangeListener)Constructs a new
DateFieldwith a value change listener.The listener is called when the value of this
DateFieldis changed either by the user or programmatically.Parameters:
valueChangeListener- the value change listener, notnull
-
DateField
public DateField(String caption, HasValue.ValueChangeListener<LocalDate> valueChangeListener)Constructs a new
DateFieldwith the given caption and a value change listener.The listener is called when the value of this
DateFieldis changed either by the user or programmatically.Parameters:
caption- the caption for the fieldvalueChangeListener- the value change listener, notnull
-
DateField
public DateField(String caption, LocalDate value, HasValue.ValueChangeListener<LocalDate> valueChangeListener)Constructs a new
DateFieldwith the given caption, initial text contents and a value change listener.The listener is called when the value of this
DateFieldis changed either by the user or programmatically.Parameters:
caption- the caption for the fieldvalue- the value for the field, notnullvalueChangeListener- the value change listener, notnull
-
-
Method Detail
-
getPlaceholder
public String getPlaceholder()Returns the current placeholder text.
Returns:
the placeholder text
See Also:
-
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 LocalDateFieldState getState()Description copied from class:
AbstractComponentReturns 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:
getStatein classAbstractLocalDateFieldReturns:
updated component shared state
-
getState
protected LocalDateFieldState getState(boolean markAsDirty)Description copied from class:
AbstractClientConnectorReturns the shared state for this connector.
Overrides:
getStatein classAbstractLocalDateFieldParameters:
markAsDirty- true if the connector should automatically be marked dirty, false otherwiseReturns:
The shared state for this connector. Never null.
See Also:
-
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
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
-
-