com.vaadin.ui

Class AbstractDateField<T extends Temporal & TemporalAdjuster & Serializable & Comparable<? super T>,R extends Enum<R>>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractField<T>

com.vaadin.ui.AbstractDateField<T,R>

Type Parameters:

T - type of date (LocalDate or LocalDateTime).

R - resolution enumeration type

All Implemented Interfaces:

HasValue<T>, ConnectorEventListener, ContextClickEvent.ContextClickNotifier, FieldEvents.BlurNotifier, FieldEvents.FocusNotifier, MethodEventSource, SerializableEventListener, ClientConnector, Sizeable, VariableOwner, Connector, Component, Component.Focusable, LegacyComponent, Serializable, EventListener

Direct Known Subclasses:

AbstractLocalDateField, AbstractLocalDateTimeField

public abstract class AbstractDateField<T extends Temporal & TemporalAdjuster & Serializable & Comparable<? super T>,R extends Enum<R>>
extends AbstractField<T>
implements LegacyComponent, FieldEvents.FocusNotifier, FieldEvents.BlurNotifier

A date editor component with LocalDate as an input value.

Since:

8.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

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

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

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

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
AbstractDateField(R resolution) Constructs an empty AbstractDateField with no caption and specified resolution.
AbstractDateField(String caption, R resolution) Constructs an empty AbstractDateField with caption.
AbstractDateField(String caption, T value, R resolution) Constructs a new AbstractDateField with the given caption and initial text contents.

Method Summary

Modifier and Type	Method and Description
Registration	addBlurListener(FieldEvents.BlurListener listener) Adds a BlurListener to the Component which gets fired when a Field loses keyboard focus.
Registration	addFocusListener(FieldEvents.FocusListener listener) Adds a FocusListener to the Component which gets fired when a Field receives keyboard focus.
protected abstract T	buildDate(Map<R,Integer> resolutionValues) Builds date by the given resolutionValues which is a map whose keys are resolution and integer values.
void	changeVariables(Object source, Map<String,Object> variables) Called when one or more variables handled by the implementing class are changed.
protected abstract T	convertFromDate(Date date) Converts Date to date type T.
protected abstract Date	convertToDate(T date) Converts the object of type T to Date.
protected void	doSetValue(T value) Sets the value of this field.
protected void	fireEvent(EventObject event) Sends the event to all listeners.
String	getDateFormat() Returns a format string used to format date value on client side or null if default formatting from Component.getLocale() is used.
String	getDateOutOfRangeMessage() Returns current date-out-of-range error message.
protected abstract int	getDatePart(T date, R resolution) Returns a date integer value part for the given date for the given resolution.
String	getParseErrorMessage() Return the error message that is shown if the user inputted value can't be parsed into a Date object.
T	getRangeEnd() Returns the precise rangeEnd used.
T	getRangeStart() Returns the precise rangeStart used.
protected abstract RangeValidator<T>	getRangeValidator() Returns a custom date range validator which is applicable for the type T.
R	getResolution() Gets the resolution.
protected AbstractDateFieldState	getState() Returns the shared state bean with information to be sent from the server to the client.
protected AbstractDateFieldState	getState(boolean markAsDirty) Returns the shared state for this connector.
T	getValue() Returns the current value of this object.
protected Result<T>	handleUnparsableDateString(String dateString) This method is called to handle a non-empty date string from the client if the client could not parse it as a Date.
boolean	isLenient() Returns whether date/time interpretation is to be lenient.
boolean	isShowISOWeekNumbers() Checks whether ISO 8601 week numbers are shown in the date selector.
void	paintContent(PaintTarget target) Paints the Paintable into a UIDL stream.
void	readDesign(org.jsoup.nodes.Element design, DesignContext designContext) Reads the component state from the given design.
void	setDateFormat(String dateFormat) Sets formatting used by some component implementations.
void	setDateOutOfRangeMessage(String dateOutOfRangeMessage) Sets the current error message if the range validation fails.
void	setLenient(boolean lenient) Specifies whether or not date/time interpretation in component is to be lenient.
void	setParseErrorMessage(String parsingErrorMessage) Sets the default error message used if the DateField cannot parse the text input by user to a Date field.
void	setRangeEnd(T endDate) Sets the end range for this component.
void	setRangeStart(T startDate) Sets the start range for this component.
void	setResolution(R resolution) Sets the resolution of the DateField.
void	setShowISOWeekNumbers(boolean showWeekNumbers) Sets the visibility of ISO 8601 week numbers in the date selector.
void	setValue(T value) Sets the value of this object.
void	writeDesign(org.jsoup.nodes.Element design, DesignContext designContext) Writes the component state to the given design.

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, beforeClientResponse, 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, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, 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, 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.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled

Methods inherited from interface com.vaadin.ui.Component

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

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, 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, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface com.vaadin.data.HasValue

clear, getEmptyValue, getOptionalValue, isEmpty

Constructor Detail

AbstractDateField

public AbstractDateField(R resolution)

Constructs an empty AbstractDateField with no caption and specified resolution.

Parameters:

resolution - initial resolution for the field

AbstractDateField

public AbstractDateField(String caption,
                         R resolution)

Constructs an empty AbstractDateField with caption.

Parameters:

caption - the caption of the datefield.

resolution - initial resolution for the field

AbstractDateField

public AbstractDateField(String caption,
                         T value,
                         R resolution)

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

Parameters:

caption - the caption String for the editor.

value - the date/time value.

resolution - initial resolution for the field

Method Detail

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Description copied from interface: LegacyComponent

Paints the Paintable into a UIDL stream. This method creates the UIDL sequence describing it and outputs it to the given UIDL stream.

It is called when the contents of the component should be painted in response to the component first being shown or having been altered so that its visual representation is changed.

Specified by:

paintContent in interface LegacyComponent

Parameters:

target - the target UIDL stream where the component should paint itself to.

Throws:

PaintException - if the paint operation failed.

changeVariables

public void changeVariables(Object source,
                            Map<String,Object> variables)

Description copied from interface: VariableOwner

Called when one or more variables handled by the implementing class are changed.

Specified by:

changeVariables in interface VariableOwner

Parameters:

source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.

variables - the Mapping from variable names to new variable values.

setRangeStart

public void setRangeStart(T startDate)

Sets the start range for this component. If the value is set before this date (taking the resolution into account), the component will not validate. If startDate is set to null, any value before endDate will be accepted by the range

Parameters:

startDate - - the allowed range's start date

setDateOutOfRangeMessage

public void setDateOutOfRangeMessage(String dateOutOfRangeMessage)

Sets the current error message if the range validation fails.

Parameters:

dateOutOfRangeMessage - - Localizable message which is shown when value (the date) is set outside allowed range

getDateOutOfRangeMessage

public String getDateOutOfRangeMessage()

Returns current date-out-of-range error message.

Returns:

Current error message for dates out of range.

See Also:

setDateOutOfRangeMessage(String)

getResolution

public R getResolution()

Gets the resolution.

Returns:

the date/time field resolution

setResolution

public void setResolution(R resolution)

Sets the resolution of the DateField. The default resolution is DateResolution.DAY since Vaadin 7.0.

Parameters:

resolution - the resolution to set, not null

setRangeEnd

public void setRangeEnd(T endDate)

Sets the end range for this component. If the value is set after this date (taking the resolution into account), the component will not validate. If endDate is set to null, any value after startDate will be accepted by the range.

Parameters:

endDate - - the allowed range's end date (inclusive, based on the current resolution)

getRangeStart

public T getRangeStart()

Returns the precise rangeStart used.

Returns:

the precise rangeStart used, may be null.

getRangeEnd

public T getRangeEnd()

Returns the precise rangeEnd used.

Returns:

the precise rangeEnd used, may be null.

setDateFormat

public void setDateFormat(String dateFormat)

Sets formatting used by some component implementations. See SimpleDateFormat for format details. By default it is encouraged to used default formatting defined by Locale, but due some JVM bugs it is sometimes necessary to use this method to override formatting. See Vaadin issue #2200.

Parameters:

dateFormat - the dateFormat to set

See Also:

com.vaadin.ui.AbstractComponent#setLocale(Locale))

getDateFormat

public String getDateFormat()

Returns a format string used to format date value on client side or null if default formatting from Component.getLocale() is used.

Returns:

the dateFormat

setLenient

public void setLenient(boolean lenient)

Specifies whether or not date/time interpretation in component is to be lenient.

Parameters:

lenient - true if the lenient mode is to be turned on; false if it is to be turned off.

See Also:

Calendar.setLenient(boolean), isLenient()

isLenient

public boolean isLenient()

Returns whether date/time interpretation is to be lenient.

Returns:

true if the interpretation mode of this calendar is lenient; false otherwise.

See Also:

setLenient(boolean)

getValue

public T getValue()

Description copied from interface: HasValue

Returns the current value of this object.

Implementation note: the implementing class should document whether null values may be returned or not.

Specified by:

getValue in interface HasValue<T extends Temporal & TemporalAdjuster & Serializable & Comparable<? super T>>

Returns:

the current value

setValue

public void setValue(T value)

Sets the value of this object. If the new value is not equal to getValue(), fires a ValueChangeEvent .

Specified by:

setValue in interface HasValue<T extends Temporal & TemporalAdjuster & Serializable & Comparable<? super T>>

Overrides:

setValue in class AbstractField<T extends Temporal & TemporalAdjuster & Serializable & Comparable<? super T>>

Parameters:

value - the new value, may be null

isShowISOWeekNumbers

public boolean isShowISOWeekNumbers()

Checks whether ISO 8601 week numbers are shown in the date selector.

Returns:

true if week numbers are shown, false otherwise.

setShowISOWeekNumbers

public void setShowISOWeekNumbers(boolean showWeekNumbers)

Sets the visibility of ISO 8601 week numbers in the date selector. ISO 8601 defines that a week always starts with a Monday so the week numbers are only shown if this is the case.

Parameters:

showWeekNumbers - true if week numbers should be shown, false otherwise.

getParseErrorMessage

public String getParseErrorMessage()

Return the error message that is shown if the user inputted value can't be parsed into a Date object. If handleUnparsableDateString(String) is overridden and it throws a custom exception, the message returned by Throwable.getLocalizedMessage() will be used instead of the value returned by this method.

Returns:

the error message that the DateField uses when it can't parse the textual input from user to a Date object

See Also:

setParseErrorMessage(String)

setParseErrorMessage

public void setParseErrorMessage(String parsingErrorMessage)

Sets the default error message used if the DateField cannot parse the text input by user to a Date field. Note that if the handleUnparsableDateString(String) method is overridden, the localized message from its exception is used.

Parameters:

parsingErrorMessage -

See Also:

getParseErrorMessage(), handleUnparsableDateString(String)

addFocusListener

public Registration addFocusListener(FieldEvents.FocusListener listener)

Description copied from interface: FieldEvents.FocusNotifier

Adds a FocusListener to the Component which gets fired when a Field receives keyboard focus.

Specified by:

addFocusListener in interface FieldEvents.FocusNotifier

Parameters:

listener - the focus listener to add, not null

Returns:

a registration object for removing the listener

See Also:

FieldEvents.FocusListener, Registration

addBlurListener

public Registration addBlurListener(FieldEvents.BlurListener listener)

Description copied from interface: FieldEvents.BlurNotifier

Adds a BlurListener to the Component which gets fired when a Field loses keyboard focus.

Specified by:

addBlurListener in interface FieldEvents.BlurNotifier

Parameters:

listener - the blur listener to add, not null

Returns:

a registration object for removing the listener

See Also:

FieldEvents.BlurListener, Registration

readDesign

public void readDesign(org.jsoup.nodes.Element design,
                       DesignContext designContext)

Description copied from interface: Component

Reads the component state from the given design.

The component is responsible not only for updating its own state but also for ensuring that its children update their state based on the design.

It is assumed that the component is in its default state when this method is called. Reading should only take into consideration attributes specified in the design and not reset any unspecified attributes to their defaults.

This method must not modify the design.

Specified by:

readDesign in interface Component

Overrides:

readDesign in class AbstractField<T extends Temporal & TemporalAdjuster & Serializable & Comparable<? super T>>

Parameters:

design - The element to obtain the state from

designContext - The DesignContext instance used for parsing the design

writeDesign

public void writeDesign(org.jsoup.nodes.Element design,
                        DesignContext designContext)

Description copied from interface: Component

Writes the component state to the given design.

The component is responsible not only for writing its own state but also for ensuring that its children write their state to the design.

This method must not modify the component state.

Specified by:

writeDesign in interface Component

Overrides:

writeDesign in class AbstractField<T extends Temporal & TemporalAdjuster & Serializable & Comparable<? super T>>

Parameters:

design - The element to write the component state to. Any previous attributes or child nodes are not cleared.

designContext - The DesignContext instance used for writing the design

fireEvent

protected void fireEvent(EventObject event)

Description copied from class: AbstractClientConnector

Sends the event to all listeners.

Overrides:

fireEvent in class AbstractClientConnector

Parameters:

event - the Event to be sent to all listeners.

handleUnparsableDateString

protected Result<T> handleUnparsableDateString(String dateString)

This method is called to handle a non-empty date string from the client if the client could not parse it as a Date. By default, an error result is returned whose error message is getParseErrorMessage(). This can be overridden to handle conversions, to return a result with null value (equivalent to empty input) or to return a custom error.

Parameters:

dateString - date string to handle

Returns:

result that contains parsed Date as a value or an error

getState

protected AbstractDateFieldState 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 AbstractField<T extends Temporal & TemporalAdjuster & Serializable & Comparable<? super T>>

Returns:

updated component shared state

getState

protected AbstractDateFieldState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class AbstractField<T extends Temporal & TemporalAdjuster & Serializable & Comparable<? super T>>

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()

doSetValue

protected void doSetValue(T value)

Description copied from class: AbstractField

Sets the value of this field. May do sanitization or throw IllegalArgumentException if the value is invalid. Typically saves the value to shared state.

Specified by:

doSetValue in class AbstractField<T extends Temporal & TemporalAdjuster & Serializable & Comparable<? super T>>

Parameters:

value - the new value of the field

getDatePart

protected abstract int getDatePart(T date,
                                   R resolution)

Returns a date integer value part for the given date for the given resolution.

Parameters:

date - the given date

resolution - the resolution to extract a value from the date by

Returns:

the integer value part of the date by the given resolution

buildDate

protected abstract T buildDate(Map<R,Integer> resolutionValues)

Builds date by the given resolutionValues which is a map whose keys are resolution and integer values.

This is the opposite to getDatePart(Temporal, Enum).

Parameters:

resolutionValues - date values to construct a date

Returns:

date built from the given map of date values

getRangeValidator

protected abstract RangeValidator<T> getRangeValidator()

Returns a custom date range validator which is applicable for the type T.

Returns:

the date range validator

convertFromDate

protected abstract T convertFromDate(Date date)

Converts Date to date type T.

Parameters:

date - a date to convert

Returns:

object of type T representing the date

convertToDate

protected abstract Date convertToDate(T date)

Converts the object of type T to Date.

This is the opposite to convertFromDate(Date).

Parameters:

date - the date of type T

Returns:

converted date of type Date