com.vaadin.client.ui

Class VAbstractTextualDate<R extends Enum<R>>

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.google.gwt.user.client.ui.FlowPanel

com.vaadin.client.ui.VDateField<R>

com.vaadin.client.ui.VAbstractTextualDate<R>

Type Parameters:

R - the resolution type which this field is based on (day, month, ...)

All Implemented Interfaces:

com.google.gwt.event.dom.client.ChangeHandler, com.google.gwt.event.dom.client.KeyDownHandler, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.EventHandler, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.InsertPanel, com.google.gwt.user.client.ui.InsertPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Focusable, HandlesAriaCaption, HandlesAriaInvalid, HandlesAriaRequired, Field, SubPartAware, Iterable<com.google.gwt.user.client.ui.Widget>

Direct Known Subclasses:

VAbstractPopupCalendar

public abstract class VAbstractTextualDate<R extends Enum<R>>
extends VDateField<R>
implements Field, com.google.gwt.event.dom.client.ChangeHandler, Focusable, SubPartAware, HandlesAriaCaption, HandlesAriaInvalid, HandlesAriaRequired, com.google.gwt.event.dom.client.KeyDownHandler

Abstract textual date field base implementation. Provides a text box as an editor for a date. The class is parameterized by the date resolution enumeration type.

Since:

8.0

Author:

Vaadin Ltd

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel

com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields

Modifier and Type	Field and Description
String	formatStr For internal use only.
boolean	lenient For internal use only.
com.google.gwt.user.client.ui.TextBox	text For internal use only.

Fields inherited from class com.vaadin.client.ui.VDateField

CLASSNAME, client, currentLocale, dts, enabled, paintableId, readonly, showISOWeekNumbers

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
VAbstractTextualDate(R resoluton)

Method Summary

Modifier and Type	Method and Description
void	bindAriaCaption(com.google.gwt.user.client.Element captionElement) Called to bind the provided caption (label in HTML speak) element to the main input element of the Widget.
void	buildDate() Updates the text field according to the current date (provided by VDateField.getDate()).
protected String	cleanFormat(String format) Clean date format string to make it suitable for getFormatString().
void	focus() Sets focus to this widget.
protected String	getFormatString() Gets the date format string for the current locale.
String	getPlaceHolder() Gets the set placeholder this textual date input, or an empty string if none is set.
com.google.gwt.user.client.Element	getSubPartElement(String subPart) Locates an element inside a component using the identifier provided in subPart.
String	getSubPartName(com.google.gwt.user.client.Element subElement) Provides an identifier that identifies the element within the component.
protected String	getText()
void	onChange(com.google.gwt.event.dom.client.ChangeEvent event)
void	onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent event)
void	setAriaInvalid(boolean invalid) Called to set the element, typically an input element, as invalid.
void	setAriaRequired(boolean required) Called to set the element, typically an input element, as required.
void	setEnabled(boolean enabled)
void	setPlaceholder(String placeholder) Sets the placeholder for this textual date input.
protected void	setText(String text)
protected void	updateDateVariables() Updates variables to send a response to the server.
protected void	updateStyleNames() Updates style names for the widget (and its children).

Methods inherited from class com.vaadin.client.ui.VDateField

doGetResolutions, getClient, getCurrentDate, getCurrentLocale, getCurrentResolution, getDate, getDate, getDateTimeService, getId, getResolutions, getResolutionVariable, isEnabled, isReadonly, isShowISOWeekNumbers, isYear, resolutionAsString, setCurrentDate, setCurrentDate, setCurrentLocale, setCurrentResolution, setDate, setReadonly, setShowISOWeekNumbers

Methods inherited from class com.google.gwt.user.client.ui.FlowPanel

add, clear, insert, insert

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, adopt, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

add

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

getWidgetIndex

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel

getWidget, getWidgetCount, getWidgetIndex, remove

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

text

public final com.google.gwt.user.client.ui.TextBox text

For internal use only. May be removed or replaced in the future.

lenient

public boolean lenient

For internal use only. May be removed or replaced in the future.

formatStr

public String formatStr

For internal use only. May be removed or replaced in the future.

Constructor Detail

VAbstractTextualDate

public VAbstractTextualDate(R resoluton)

Method Detail

updateStyleNames

protected void updateStyleNames()

Updates style names for the widget (and its children).

getFormatString

protected String getFormatString()

Gets the date format string for the current locale.

Returns:

the format string

bindAriaCaption

public void bindAriaCaption(com.google.gwt.user.client.Element captionElement)

Description copied from interface: HandlesAriaCaption

Called to bind the provided caption (label in HTML speak) element to the main input element of the Widget. Binding should be removed from the main input field when captionElement is null.

Specified by:

bindAriaCaption in interface HandlesAriaCaption

Parameters:

captionElement - Element of the caption

setAriaRequired

public void setAriaRequired(boolean required)

Description copied from interface: HandlesAriaRequired

Called to set the element, typically an input element, as required.

Specified by:

setAriaRequired in interface HandlesAriaRequired

Parameters:

required - boolean true when the element needs to be set as required

setAriaInvalid

public void setAriaInvalid(boolean invalid)

Description copied from interface: HandlesAriaInvalid

Called to set the element, typically an input element, as invalid.

Specified by:

setAriaInvalid in interface HandlesAriaInvalid

Parameters:

invalid - boolean, true when the element should be marked invalid, false otherwise

buildDate

public void buildDate()

Updates the text field according to the current date (provided by VDateField.getDate()). Takes care of updating text, enabling and disabling the field, setting/removing readonly status and updating readonly styles.

For internal use only. May be removed or replaced in the future.

TODO: Split part of this into a method that only updates the text as this is what usually is needed except for updateFromUIDL.

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface com.google.gwt.user.client.ui.HasEnabled

Overrides:

setEnabled in class VDateField<R extends Enum<R>>

onChange

public void onChange(com.google.gwt.event.dom.client.ChangeEvent event)

Specified by:

onChange in interface com.google.gwt.event.dom.client.ChangeHandler

updateDateVariables

protected void updateDateVariables()

Updates variables to send a response to the server.

The method can be overridden by subclasses to provide a custom logic for date variables to avoid overriding the onChange(ChangeEvent) method.

cleanFormat

protected String cleanFormat(String format)

Clean date format string to make it suitable for getFormatString().

Parameters:

format - date format string

Returns:

cleaned up string

See Also:

getFormatString()

focus

public void focus()

Description copied from interface: Focusable

Sets focus to this widget.

Specified by:

focus in interface Focusable

setPlaceholder

public void setPlaceholder(String placeholder)

Sets the placeholder for this textual date input.

Parameters:

placeholder - the placeholder to set, or null to clear

getPlaceHolder

public String getPlaceHolder()

Gets the set placeholder this textual date input, or an empty string if none is set.

Returns:

the placeholder or an empty string if none set

getText

protected String getText()

setText

protected void setText(String text)

getSubPartElement

public com.google.gwt.user.client.Element getSubPartElement(String subPart)

Description copied from interface: SubPartAware

Locates an element inside a component using the identifier provided in subPart. The subPart identifier is component specific and may be any string of characters, numbers, space characters and brackets.

Specified by:

getSubPartElement in interface SubPartAware

Parameters:

subPart - The identifier for the element inside the component

Returns:

The element identified by subPart or null if the element could not be found.

getSubPartName

public String getSubPartName(com.google.gwt.user.client.Element subElement)

Description copied from interface: SubPartAware

Provides an identifier that identifies the element within the component. The subElement is a part of the component and must never be null.

Note! getSubPartElement(getSubPartName(element)) == element is not always true. A component can choose to provide a more generic identifier for any given element if the results of all interactions with subElement are the same as interactions with the element identified by the return value. For example a button can return an identifier for the root element even though a DIV inside the button was passed as subElement because interactions with the DIV and the root button element produce the same result.

Specified by:

getSubPartName in interface SubPartAware

Parameters:

subElement - The element the identifier string should uniquely identify

Returns:

An identifier that uniquely identifies subElement or null if no identifier could be provided.

onKeyDown

public void onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent event)

Specified by:

onKeyDown in interface com.google.gwt.event.dom.client.KeyDownHandler