Package com.storedobject.ui

Class TimestampPeriodField

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<TimestampPeriod>,TimestampPeriod>

com.vaadin.flow.component.customfield.CustomField<TimestampPeriod>

com.storedobject.ui.RangeField<TimestampPeriod,Timestamp>

com.storedobject.ui.TimestampPeriodField

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.customfield.CustomField<TimestampPeriod>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.customfield.CustomField<TimestampPeriod>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.customfield.CustomField<TimestampPeriod>>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<TimestampPeriod>,TimestampPeriod>,TimestampPeriod>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<TimestampPeriod>,TimestampPeriod>,TimestampPeriod>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, com.vaadin.flow.component.shared.InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<TimestampPeriod>,TimestampPeriod>,TimestampPeriod>, Serializable

public class TimestampPeriodField
extends RangeField<TimestampPeriod,Timestamp>

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

com.vaadin.flow.component.HasValue.ValueChangeEvent<V>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Constructor Summary

Constructors

Constructor	Description
TimestampPeriodField()
TimestampPeriodField(String label)
TimestampPeriodField(String label, TimestampPeriod initialValue)

Method Summary

Modifier and Type	Method	Description
protected TimestampPeriod	create(Timestamp from, Timestamp to)
int	getEpoch()	Get the current epoch value.
protected TimestampField	getFromField()
Timestamp	getMax()	Get the allowed maximum value that is currently set.
Timestamp	getMin()	Get the allowed minimum value that is currently set.
final TimeResolution	getResolution()	Get the resolution.
protected TimestampField	getToField()
boolean	isWeekNumbersVisible()	Check the visibility of "week numbers" while accepting the value.
void	setEpoch(int epoch)	Epoch value to set.
void	setMax(Timestamp value)	Set the maximum value allowed.
void	setMin(Timestamp value)	Set the minimum value allowed.
void	setStep(Duration step)	Sets the step property of the time picker using duration.
void	setWeekNumbersVisible(boolean weekNumbersVisible)	Set the visibility of "week numbers" while accepting the value.

Methods inherited from class com.storedobject.ui.RangeField

generateModelValue, getFrom, getTo, isInvalid, setPresentationValue

Methods inherited from class com.vaadin.flow.component.customfield.CustomField

add, addThemeVariants, getLabel, remove, removeThemeVariants, setLabel, updateValue

Methods inherited from class com.vaadin.flow.component.AbstractField

addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, setValue, valueEquals

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.BlurNotifier

addBlurListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.Focusable

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.flow.component.FocusNotifier

addFocusListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasHelper

getHelperComponent, getHelperText, setHelperComponent, setHelperText

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

getTooltip, setTooltipText

Methods inherited from interface com.vaadin.flow.component.HasValidation

setManualValidation

Methods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties

getErrorMessage, setErrorMessage, setInvalid

Methods inherited from interface com.vaadin.flow.component.HasValue

addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty, setValue

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible

Constructor Details

TimestampPeriodField

public TimestampPeriodField()

TimestampPeriodField

public TimestampPeriodField(String label)

TimestampPeriodField

public TimestampPeriodField(String label,
 TimestampPeriod initialValue)

Method Details

create

protected TimestampPeriod create(Timestamp from,
 Timestamp to)

Specified by:

create in class RangeField<TimestampPeriod,Timestamp>

getResolution

public final TimeResolution getResolution()

Get the resolution.

Returns:

Resolution.

getFromField

protected TimestampField getFromField()

Overrides:

getFromField in class RangeField<TimestampPeriod,Timestamp>

getToField

protected TimestampField getToField()

Overrides:

getToField in class RangeField<TimestampPeriod,Timestamp>

setMin

public void setMin(Timestamp value)

Set the minimum value allowed.

Parameters:

value - Minimum value allowed.

setMax

public void setMax(Timestamp value)

Set the maximum value allowed.

Parameters:

value - Maximum value allowed.

getMin

public Timestamp getMin()

Get the allowed minimum value that is currently set. Null is returned of no minimum value was set.

Returns:

Minimum value.

getMax

public Timestamp getMax()

Get the allowed maximum value that is currently set. Null is returned of no maximum value was set.

Returns:

Maximum value.

setWeekNumbersVisible

public void setWeekNumbersVisible(boolean weekNumbersVisible)

Set the visibility of "week numbers" while accepting the value.

Parameters:

weekNumbersVisible - True if visible.

isWeekNumbersVisible

public boolean isWeekNumbersVisible()

Check the visibility of "week numbers" while accepting the value.

Returns:

True if visible.

setStep

public void setStep(Duration step)

Sets the step property of the time picker using duration. It specifies the intervals for the displayed items in the time picker dropdown and also the displayed time format.

The set step needs to evenly divide a day or an hour and has to be larger than 0 milliseconds.

If the step is less than 60 seconds, the format will be changed to hh:mm:ss and it can be in hh:mm:ss.fff format, when the step is less than 1 second.

NOTE: If the step is less than 900 seconds, the dropdown is hidden.

NOTE: changing the step to a larger duration can cause a new HasValue.ValueChangeEvent to be fired if some parts (eg. seconds) is discarded from the value.

Parameters:

step - Step.

setEpoch

public void setEpoch(int epoch)

Epoch value to set. Epoch value determines how a 2 digit year value is interpreted. Epoch value is added to the 2 digit year value. The default value of epoch is the first year of the century. For example, for the 21st century, the default epoch value is 2000.

Parameters:

epoch - Epoch value to set.

getEpoch

public int getEpoch()

Get the current epoch value. (Please see setEpoch(int)).

Returns:

Current the current epoch value.