|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.vaadin.terminal.AbstractClientConnector com.vaadin.ui.AbstractComponent com.vaadin.ui.AbstractField<Date> com.vaadin.ui.DateField
public class DateField
A date editor component that can be bound to any Property
that is
compatible with java.util.Date
.
Since DateField
extends AbstractField
it implements
the Buffered
interface.
A DateField
is in write-through mode by default, so
AbstractField.setWriteThrough(boolean)
must be called to
enable buffering.
Nested Class Summary | |
---|---|
static class |
DateField.Resolution
Resolutions for DateFields |
static class |
DateField.UnparsableDateString
|
Nested classes/interfaces inherited from class com.vaadin.ui.AbstractField |
---|
AbstractField.FocusShortcut, AbstractField.ReadOnlyStatusChangeEvent |
Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent |
---|
AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler |
Nested classes/interfaces inherited from interface com.vaadin.terminal.VariableOwner |
---|
VariableOwner.ErrorEvent |
Nested classes/interfaces inherited from interface com.vaadin.ui.Component |
---|
Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener |
Nested classes/interfaces inherited from interface com.vaadin.terminal.Sizeable |
---|
Sizeable.Unit |
Nested classes/interfaces inherited from interface com.vaadin.ui.Field |
---|
Field.ValueChangeEvent |
Nested classes/interfaces inherited from interface com.vaadin.data.Buffered |
---|
Buffered.SourceException |
Nested classes/interfaces inherited from interface com.vaadin.data.Property |
---|
Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.Transactional<T>, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer |
Field Summary | |
---|---|
static DateField.Resolution |
RESOLUTION_DAY
Deprecated. Use DateField.Resolution.DAY |
static DateField.Resolution |
RESOLUTION_HOUR
Deprecated. Use DateField.Resolution.HOUR |
static DateField.Resolution |
RESOLUTION_MIN
Deprecated. Use DateField.Resolution.MINUTE |
static DateField.Resolution |
RESOLUTION_MONTH
Deprecated. Use DateField.Resolution.MONTH |
static DateField.Resolution |
RESOLUTION_SEC
Deprecated. Use DateField.Resolution.SECOND |
static DateField.Resolution |
RESOLUTION_YEAR
Deprecated. Use DateField.Resolution.YEAR |
Fields inherited from interface com.vaadin.terminal.Sizeable |
---|
SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS |
Constructor Summary | |
---|---|
DateField()
Constructs an empty DateField with no caption. |
|
DateField(Property dataSource)
Constructs a new DateField that's bound to the specified
Property and has no caption. |
|
DateField(String caption)
Constructs an empty DateField with caption. |
|
DateField(String caption,
Date value)
Constructs a new DateField with the given caption and
initial text contents. |
|
DateField(String caption,
Property dataSource)
Constructs a new DateField that's bound to the specified
Property and has the given caption String . |
Method Summary | |
---|---|
void |
addListener(FieldEvents.BlurListener listener)
Adds a BlurListener to the Component which gets fired
when a Field loses keyboard focus. |
void |
addListener(FieldEvents.FocusListener listener)
Adds a FocusListener to the Component which gets fired
when a Field receives keyboard focus. |
void |
changeVariables(Object source,
Map<String,Object> variables)
Called when one or more variables handled by the implementing class are changed. |
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 |
getParseErrorMessage()
Return the error message that is shown if the user inputted value can't be parsed into a Date object. |
DateField.Resolution |
getResolution()
Gets the resolution. |
TimeZone |
getTimeZone()
Gets the time zone used by this field. |
Class<Date> |
getType()
Returns the type of the Field. |
protected Date |
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 |
removeListener(FieldEvents.BlurListener listener)
Removes a BlurListener from the Component. |
void |
removeListener(FieldEvents.FocusListener listener)
Removes a FocusListener from the Component. |
void |
setDateFormat(String dateFormat)
Sets formatting used by some component implementations. |
protected void |
setInternalValue(Date newValue)
Sets the internal field value. |
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 |
setResolution(DateField.Resolution resolution)
Sets the resolution of the DateField. |
void |
setShowISOWeekNumbers(boolean showWeekNumbers)
Sets the visibility of ISO 8601 week numbers in the date selector. |
void |
setTimeZone(TimeZone timeZone)
Sets the time zone used by this date field. |
protected void |
setValue(Date newValue,
boolean repaintIsNotNeeded)
Sets the value of the field. |
protected boolean |
shouldHideErrors()
Returns true if the error indicator be hidden when painting the component even when there are errors. |
void |
validate()
Validates the current value against registered validators if the field is not empty. |
Methods inherited from class com.vaadin.terminal.AbstractClientConnector |
---|
addExtension, addMethodInvocationToQueue, createState, getAllChildrenIterable, getConnectorId, getExtensions, getRpcManager, getRpcProxy, getStateType, registerRpc, registerRpc, removeExtension, requestRepaintAll, retrievePendingRpcCalls |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.vaadin.terminal.VariableOwner |
---|
isEnabled, isImmediate |
Methods inherited from interface com.vaadin.ui.Component |
---|
addListener, addStyleName, attach, getApplication, getCaption, getDebugId, getIcon, getLocale, getParent, getRoot, getState, getStyleName, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setDebugId, setEnabled, setIcon, setReadOnly, setStyleName, setVisible, updateState |
Methods inherited from interface com.vaadin.terminal.gwt.server.ClientConnector |
---|
detach, getExtensions, getStateType, isConnectorEnabled, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setParent |
Methods inherited from interface com.vaadin.terminal.gwt.client.Connector |
---|
getConnectorId |
Methods inherited from interface com.vaadin.terminal.gwt.server.RpcTarget |
---|
getRpcManager |
Methods inherited from interface com.vaadin.terminal.Sizeable |
---|
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setSizeFull, setSizeUndefined, setWidth, setWidth |
Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier |
---|
addShortcutListener, removeShortcutListener |
Field Detail |
---|
@Deprecated public static final DateField.Resolution RESOLUTION_SEC
DateField.Resolution.SECOND
@Deprecated public static final DateField.Resolution RESOLUTION_MIN
DateField.Resolution.MINUTE
@Deprecated public static final DateField.Resolution RESOLUTION_HOUR
DateField.Resolution.HOUR
@Deprecated public static final DateField.Resolution RESOLUTION_DAY
DateField.Resolution.DAY
@Deprecated public static final DateField.Resolution RESOLUTION_MONTH
DateField.Resolution.MONTH
@Deprecated public static final DateField.Resolution RESOLUTION_YEAR
DateField.Resolution.YEAR
Constructor Detail |
---|
public DateField()
DateField
with no caption.
public DateField(String caption)
DateField
with caption.
caption
- the caption of the datefield.public DateField(String caption, Property dataSource)
DateField
that's bound to the specified
Property
and has the given caption String
.
caption
- the caption String
for the editor.dataSource
- the Property to be edited with this editor.public DateField(Property dataSource) throws IllegalArgumentException
DateField
that's bound to the specified
Property
and has no caption.
dataSource
- the Property to be edited with this editor.
IllegalArgumentException
public DateField(String caption, Date value)
DateField
with the given caption and
initial text contents. The editor constructed this way will not be bound
to a Property unless
Property.Viewer.setPropertyDataSource(Property)
is called to bind it.
caption
- the caption String
for the editor.value
- the Date value.Method Detail |
---|
public void paintContent(PaintTarget target) throws PaintException
Vaadin6Component
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.
paintContent
in interface Vaadin6Component
target
- the target UIDL stream where the component should paint itself
to.
PaintException
- if the paint operation failed.protected boolean shouldHideErrors()
AbstractField
shouldHideErrors
in class AbstractField<Date>
public void changeVariables(Object source, Map<String,Object> variables)
VariableOwner
changeVariables
in interface VariableOwner
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.protected Date handleUnparsableDateString(String dateString) throws Converter.ConversionException
dateString
-
Converter.ConversionException
- to keep the old value and indicate an errorpublic Class<Date> getType()
AbstractField
getValue
and
setValue
must be compatible with this type: one must be able
to safely cast the value returned from getValue
to the given
type and pass any variable assignable to this type as an argument to
setValue
.
getType
in interface Property<Date>
getType
in class AbstractField<Date>
protected void setValue(Date newValue, boolean repaintIsNotNeeded) throws Property.ReadOnlyException
AbstractField
setValue
in class AbstractField<Date>
newValue
- the New value of the field.repaintIsNotNeeded
- True iff caller is sure that repaint is not needed.
Property.ReadOnlyException
protected void setInternalValue(Date newValue)
AbstractField
AbstractField.getInternalValue()
if necessary.
setInternalValue
in class AbstractField<Date>
newValue
- the new value to be set.public DateField.Resolution getResolution()
public void setResolution(DateField.Resolution resolution)
DateField.Resolution.DAY
since Vaadin 7.0.
resolution
- the resolution to set.public void setDateFormat(String dateFormat)
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.
dateFormat
- the dateFormat to setcom.vaadin.ui.AbstractComponent#setLocale(Locale))
public String getDateFormat()
Component.getLocale()
is used.
public void setLenient(boolean lenient)
lenient
- true if the lenient mode is to be turned on; false if it is to
be turned off.Calendar.setLenient(boolean)
,
isLenient()
public boolean isLenient()
setLenient(boolean)
public void addListener(FieldEvents.FocusListener listener)
FieldEvents.FocusNotifier
FocusListener
to the Component which gets fired
when a Field
receives keyboard focus.
addListener
in interface FieldEvents.FocusNotifier
FieldEvents.FocusListener
public void removeListener(FieldEvents.FocusListener listener)
FieldEvents.FocusNotifier
FocusListener
from the Component.
removeListener
in interface FieldEvents.FocusNotifier
FieldEvents.FocusListener
public void addListener(FieldEvents.BlurListener listener)
FieldEvents.BlurNotifier
BlurListener
to the Component which gets fired
when a Field
loses keyboard focus.
addListener
in interface FieldEvents.BlurNotifier
FieldEvents.BlurListener
public void removeListener(FieldEvents.BlurListener listener)
FieldEvents.BlurNotifier
BlurListener
from the Component.
removeListener
in interface FieldEvents.BlurNotifier
FieldEvents.BlurListener
public boolean isShowISOWeekNumbers()
public void setShowISOWeekNumbers(boolean showWeekNumbers)
showWeekNumbers
- true if week numbers should be shown, false otherwise.public void validate() throws Validator.InvalidValueException
validate
in interface Validatable
validate
in class AbstractField<Date>
Validator.InvalidValueException
- if the value is not validAbstractField.validate()
public String getParseErrorMessage()
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.
setParseErrorMessage(String)
public void setParseErrorMessage(String parsingErrorMessage)
handleUnparsableDateString(String)
method is overridden, the
localized message from its exception is used.
parsingErrorMessage
- getParseErrorMessage()
,
handleUnparsableDateString(String)
public void setTimeZone(TimeZone timeZone)
TimeZone.getDefault()
is used.
timeZone
- the time zone to use for time calculations.getTimeZone()
public TimeZone getTimeZone()
null
is returned, the current default time zone returned by
TimeZone.getDefault()
is used.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |