Package com.vaadin.ui
Class PopupDateField
- java.lang.Object
-
- com.vaadin.server.AbstractClientConnector
-
- com.vaadin.ui.AbstractComponent
-
- com.vaadin.ui.AbstractField<Date>
-
- com.vaadin.ui.DateField
-
- com.vaadin.ui.PopupDateField
-
- All Implemented Interfaces:
Buffered
,BufferedValidatable
,Property<Date>
,Property.Editor
,Property.ReadOnlyStatusChangeListener
,Property.ReadOnlyStatusChangeNotifier
,Property.ValueChangeListener
,Property.ValueChangeNotifier
,Property.Viewer
,Validatable
,Action.ShortcutNotifier
,ConnectorEventListener
,ContextClickEvent.ContextClickNotifier
,FieldEvents.BlurNotifier
,FieldEvents.FocusNotifier
,MethodEventSource
,ClientConnector
,Sizeable
,VariableOwner
,Connector
,Component
,Component.Focusable
,Field<Date>
,LegacyComponent
,Serializable
,EventListener
public class PopupDateField extends DateField
A date entry component, which displays the actual date selector as a popup.
- Since:
- 5.0
- Author:
- Vaadin Ltd.
- See Also:
DateField
,InlineDateField
, Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.vaadin.ui.DateField
DateField.UnparsableDateString
-
Nested classes/interfaces inherited from class com.vaadin.ui.AbstractField
AbstractField.FocusShortcut, AbstractField.ReadOnlyStatusChangeEvent
-
Nested classes/interfaces inherited from interface com.vaadin.data.Buffered
Buffered.SourceException
-
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.ui.Component
Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener
-
Nested classes/interfaces inherited from interface com.vaadin.ui.Field
Field.ValueChangeEvent
-
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
-
Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable
Sizeable.Unit
-
-
Field Summary
-
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 Description PopupDateField()
PopupDateField(Property dataSource)
PopupDateField(String caption)
PopupDateField(String caption, Property dataSource)
PopupDateField(String caption, Date value)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getAssistiveText()
Get the description that explains the usage of the Widget for users of assistive devices.String
getInputPrompt()
Gets the current input prompt.protected PopupDateFieldState
getState()
Returns the shared state bean with information to be sent from the server to the client.protected PopupDateFieldState
getState(boolean markAsDirty)
Returns the shared state for this connector.boolean
isTextFieldEnabled()
Checks whether the text field is enabled (default) or not.void
paintContent(PaintTarget target)
Paints the Paintable into a UIDL stream.void
setAssistiveText(String description)
Set a description that explains the usage of the Widget for users of assistive devices.void
setInputPrompt(String inputPrompt)
Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.void
setTextFieldEnabled(boolean state)
Enables or disables the text field.-
Methods inherited from class com.vaadin.ui.DateField
addBlurListener, addFocusListener, addListener, addListener, changeVariables, discard, fireValueChange, getDateFormat, getDateOutOfRangeMessage, getParseErrorMessage, getRangeEnd, getRangeStart, getResolution, getTimeZone, getType, handleUnparsableDateString, isLenient, isShowISOWeekNumbers, readDesign, removeBlurListener, removeFocusListener, removeListener, removeListener, setDateFormat, setDateOutOfRangeMessage, setInternalValue, setLenient, setParseErrorMessage, setRangeEnd, setRangeStart, setResolution, setShowISOWeekNumbers, setTimeZone, setValue, shouldHideErrors, validate, 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, toString, 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.vaadin.event.Action.ShortcutNotifier
addShortcutListener, removeShortcutListener
-
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.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.shared.Connector
getConnectorId
-
Methods inherited from interface com.vaadin.ui.LegacyComponent
markAsDirty
-
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.server.VariableOwner
isEnabled, isImmediate
-
-
-
-
Constructor Detail
-
PopupDateField
public PopupDateField()
-
PopupDateField
public PopupDateField(Property dataSource) throws IllegalArgumentException
- Throws:
IllegalArgumentException
-
PopupDateField
public PopupDateField(String caption)
-
-
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 interfaceLegacyComponent
- Overrides:
paintContent
in classDateField
- Parameters:
target
- the target UIDL stream where the component should paint itself to.- Throws:
PaintException
- if the paint operation failed.
-
getInputPrompt
public String getInputPrompt()
Gets the current input prompt.- Returns:
- the current input prompt, or null if not enabled
- See Also:
setInputPrompt(String)
-
setInputPrompt
public void setInputPrompt(String inputPrompt)
Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.- Parameters:
inputPrompt
-
-
getState
protected PopupDateFieldState 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().
-
getState
protected PopupDateFieldState getState(boolean markAsDirty)
Description copied from class:AbstractClientConnector
Returns the shared state for this connector.- Overrides:
getState
in classDateField
- 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()
-
isTextFieldEnabled
public boolean isTextFieldEnabled()
Checks whether the text field is enabled (default) or not.- Returns:
- true if the text field is enabled, false otherwise.
-
setTextFieldEnabled
public void setTextFieldEnabled(boolean state)
Enables or disables the text field. By default the text field is enabled. Disabling it causes only the button for date selection to be active, thus preventing the user from entering invalid dates. See {@link http://dev.vaadin.com/ticket/6790}.- Parameters:
state
- true to enable text field, false to disable it.
-
setAssistiveText
public void setAssistiveText(String description)
Set a description that explains the usage of the Widget for users of assistive devices.- Parameters:
description
- String with the description
-
getAssistiveText
public String getAssistiveText()
Get the description that explains the usage of the Widget for users of assistive devices.- Returns:
- String with the description
-
-