com.whitestein.lsps.vaadin.ui.components

Class UIDateTextBox

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractField<Date>

com.vaadin.ui.DateField

com.vaadin.ui.PopupDateField

com.whitestein.lsps.vaadin.ui.components.UIDateTextBox

All Implemented Interfaces:

com.vaadin.data.Buffered, com.vaadin.data.BufferedValidatable, com.vaadin.data.Property<Date>, com.vaadin.data.Property.Editor, com.vaadin.data.Property.ReadOnlyStatusChangeListener, com.vaadin.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.data.Property.ValueChangeListener, com.vaadin.data.Property.ValueChangeNotifier, com.vaadin.data.Property.Viewer, com.vaadin.data.Validatable, com.vaadin.event.Action.ShortcutNotifier, com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.FieldEvents.BlurNotifier, com.vaadin.event.FieldEvents.FocusNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Field<Date>, com.vaadin.ui.LegacyComponent, UIComponent, UIField, UIComponentWithHints2, UIComponentWithInputPrompt, Serializable, EventListener

public class UIDateTextBox
extends com.vaadin.ui.PopupDateField
implements UIComponent, UIComponentWithInputPrompt, UIField, UIComponentWithHints2

Standard Vaadin component for "ui::TextBox" with binding of type Reference<Date>.

Author:

mbj

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.DateField

com.vaadin.ui.DateField.UnparsableDateString

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractField

com.vaadin.ui.AbstractField.FocusShortcut, com.vaadin.ui.AbstractField.ReadOnlyStatusChangeEvent

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

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

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

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

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

com.vaadin.server.Sizeable.Unit

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

com.vaadin.ui.Field.ValueChangeEvent

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

com.vaadin.data.Buffered.SourceException

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

com.vaadin.data.Property.Editor, com.vaadin.data.Property.ReadOnlyException, com.vaadin.data.Property.ReadOnlyStatusChangeListener, com.vaadin.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.data.Property.Transactional<T>, com.vaadin.data.Property.ValueChangeListener, com.vaadin.data.Property.ValueChangeNotifier, com.vaadin.data.Property.Viewer

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	hasInvalidDateString Flag set to true if the date string entered by the user is invalid.

Fields inherited from class com.vaadin.ui.DateField

RESOLUTION_DAY, RESOLUTION_HOUR, RESOLUTION_MIN, RESOLUTION_MONTH, RESOLUTION_SEC, RESOLUTION_YEAR

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
UIDateTextBox(UIComponentData componentData)

Method Summary

Modifier and Type	Method and Description
boolean	applyHint(String hintName, Variant<Object> newValue, Variant<Object> oldValue) Applies the given hint to this component.
void	changeVariables(Object source, Map<String,Object> variables)
UIComponentData	getComponentData() Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.
protected com.vaadin.shared.ui.datefield.Resolution	getResolutionFor(List<String> formatPatterns) Computes the required resolution for the used format pattern.
protected com.vaadin.shared.ui.datefield.Resolution	getResolutionFor(String formatPattern)
com.vaadin.ui.AbstractComponent	getWidget() Returns the Vaadin widget which implements the UI part of this component.
protected Date	handleUnparsableDateString(String dateString)
void	refresh() This method is called from LSPS rendering engine.
void	setDateFormat(String formatPattern)
String	toString()
boolean	unapplyHint(String hintName, Variant<Object> oldValue) The hint has been removed from the hint map.
protected void	updateResolutionFor(List<String> formatPatterns) Sets the required resolution for the used format pattern.
void	validate()

Methods inherited from class com.vaadin.ui.PopupDateField

getAssistiveText, getInputPrompt, getState, getState, isTextFieldEnabled, paintContent, setAssistiveText, setInputPrompt, setTextFieldEnabled

Methods inherited from class com.vaadin.ui.DateField

addBlurListener, addFocusListener, addListener, addListener, discard, fireValueChange, getDateFormat, getDateOutOfRangeMessage, getParseErrorMessage, getRangeEnd, getRangeStart, getResolution, getTimeZone, getType, isLenient, isShowISOWeekNumbers, readDesign, removeBlurListener, removeFocusListener, removeListener, removeListener, setDateOutOfRangeMessage, setInternalValue, setLenient, setParseErrorMessage, setRangeEnd, setRangeStart, setResolution, setShowISOWeekNumbers, setTimeZone, setValue, shouldHideErrors, writeDesign

Methods inherited from class com.vaadin.ui.AbstractField

addListener, addListener, addReadOnlyStatusChangeListener, addValidator, addValueChangeListener, attach, beforeClientResponse, clear, commit, detach, fireReadOnlyStatusChange, focus, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getCustomAttributes, getErrorMessage, getInternalValue, getModelType, getPropertyDataSource, getRequiredError, getTabIndex, getValidators, getValue, isBuffered, isEmpty, isImmediate, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isRequired, isValid, isValidationVisible, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeReadOnlyStatusChangeListener, removeValidator, removeValueChangeListener, setBuffered, setConversionError, setConvertedValue, setConverter, setConverter, setCurrentBufferedSourceException, setInvalidAllowed, setInvalidCommitted, setLocale, setPropertyDataSource, setReadOnly, setRequired, setRequiredError, setTabIndex, setValidationVisible, setValue, setValue, validate, valueChange

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getExplicitImmediateValue, 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, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setImmediate, 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, 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, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.whitestein.lsps.vaadin.ui.UIComponentWithInputPrompt

getInputPrompt, setInputPrompt

Methods inherited from interface com.whitestein.lsps.vaadin.ui.components.UIField

isRequired, setRequired

Methods inherited from interface com.vaadin.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled, isImmediate

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, 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.event.Action.ShortcutNotifier

addShortcutListener, removeShortcutListener

Field Detail

hasInvalidDateString

protected boolean hasInvalidDateString

Flag set to true if the date string entered by the user is invalid.

Constructor Detail

UIDateTextBox

public UIDateTextBox(UIComponentData componentData)

Parameters:

componentData -

Method Detail

setDateFormat

public void setDateFormat(String formatPattern)

Overrides:

setDateFormat in class com.vaadin.ui.DateField

updateResolutionFor

protected void updateResolutionFor(List<String> formatPatterns)

Sets the required resolution for the used format pattern. Applies most granular resolution. Called from setDateFormat(String).

Parameters:

formatPatterns - all format patterns accepted by this date text box. Never null, may be empty if only the default locale format is to be used. In such case, the Resolution.DAY is applied.

getResolutionFor

protected com.vaadin.shared.ui.datefield.Resolution getResolutionFor(List<String> formatPatterns)

Computes the required resolution for the used format pattern. Returns the most granular resolution.

Parameters:

formatPatterns - all format patterns accepted by this date text box. Never null, may be empty if only the default locale format is to be used. In such case, the Resolution.DAY is returned.

Returns:

the resolution, never null.

getResolutionFor

protected com.vaadin.shared.ui.datefield.Resolution getResolutionFor(String formatPattern)

refresh

public void refresh()

Description copied from interface: UIComponent

This method is called from LSPS rendering engine. It should load all information needed from component definition record holder and apply them accordingly.

Note that this method should not attempt to apply any hints - hints are applied automatically after the component is refreshed. You however may read the hints value here - it is guaranteed that you will receive freshly updated hint value by reading UIComponentData.getHints().

Specified by:

refresh in interface UIComponent

changeVariables

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

Specified by:

changeVariables in interface com.vaadin.server.VariableOwner

Overrides:

changeVariables in class com.vaadin.ui.DateField

handleUnparsableDateString

protected Date handleUnparsableDateString(String dateString)
                                   throws com.vaadin.data.util.converter.Converter.ConversionException

Overrides:

handleUnparsableDateString in class com.vaadin.ui.DateField

Throws:

com.vaadin.data.util.converter.Converter.ConversionException

validate

public void validate()
              throws com.vaadin.data.Validator.InvalidValueException

Specified by:

validate in interface com.vaadin.data.Validatable

Overrides:

validate in class com.vaadin.ui.DateField

Throws:

com.vaadin.data.Validator.InvalidValueException

getComponentData

public UIComponentData getComponentData()

Description copied from interface: UIComponent

Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.

Specified by:

getComponentData in interface UIComponent

Returns:

component definition. The definition record instance must be present in root scope (screen context).

toString

public String toString()

Overrides:

toString in class com.vaadin.ui.AbstractField<Date>

getWidget

public com.vaadin.ui.AbstractComponent getWidget()

Description copied from interface: UIComponent

Returns the Vaadin widget which implements the UI part of this component.

Specified by:

getWidget in interface UIComponent

Returns:

the widget, not null.

applyHint

public boolean applyHint(String hintName,
                         Variant<Object> newValue,
                         Variant<Object> oldValue)

Description copied from interface: UIComponentWithHints2

Applies the given hint to this component.

Specified by:

applyHint in interface UIComponentWithHints2

Parameters:

hintName - the hint name, not null.

newValue - variant containing the new hint value, never null, may contain null value.

oldValue - variant containing the previous hint value, never null, may contain null value if the hint was missing or the old value was null.

Returns:

true if the hint is supported and was applied, false if the hint is not known to this component.

unapplyHint

public boolean unapplyHint(String hintName,
                           Variant<Object> oldValue)

Description copied from interface: UIComponentWithHints2

The hint has been removed from the hint map. Unapply from the component and revert the value to the default one.

Specified by:

unapplyHint in interface UIComponentWithHints2

Parameters:

hintName - the the hint name, not null.

oldValue - variant containing the previous hint value, never null, may contain null value if the old value was null.

Returns:

true if the hint is supported and was applied, false if the hint is not known to this component.