Package org.jdesktop.swingx.plaf.basic
Class BasicDatePickerUI
java.lang.Object
javax.swing.plaf.ComponentUI
org.jdesktop.swingx.plaf.DatePickerUI
org.jdesktop.swingx.plaf.basic.BasicDatePickerUI
The basic implementation of a
DatePickerUI
.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected class
Popup component that shows a JXMonthView component along with controlling buttons to allow traversal of the months.private class
A subclass of JFormattedTextField which calculates a "reasonable" minimum preferred size, independent of value/text.class
The wrapper for the editor cancel action.private class
PENDING: JW - I really hate the one-in-all.class
private class
Action used to commit the current value in the JFormattedTextField. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected JXDatePicker
private ActionListener
private PropertyChangeListener
private FocusListener
private BasicDatePickerUI.Handler
private static final Logger
private ActionListener
private PropertyChangeListener
private DateSelectionListener
listeners for the picker's monthviewprotected MouseListener
protected MouseMotionListener
private JButton
private PopupMenuListener
private BasicDatePickerUI.PopupRemover
protected PropertyChangeListener
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
cancel()
protected void
commit()
private Action
Creates and returns the action for cancel the picker's edit.private Action
Creates and returns the action for committing the picker's input.protected JFormattedTextField
Creates the editor used to edit the date selection.protected ActionListener
Creates and returns the ActionListener for the picker's editor.protected PropertyChangeListener
protected FocusListener
Creates and returns the focuslistener for picker and editor.private Action
createHomeAction
(boolean commit) protected LayoutManager
protected ActionListener
Creates and returns the ActionListener for the picker's monthView.protected PropertyChangeListener
Creates and returns the property change listener for the picker's monthViewprotected DateSelectionListener
Returns the listener for the dateSelection.protected MouseListener
protected MouseMotionListener
protected JButton
protected PopupMenuListener
Creates and returns a PopupMenuListener.protected PropertyChangeListener
protected BasicDatePickerUI.TogglePopupAction
Creates and returns the action which toggles the visibility of the popup.static ComponentUI
int
getBaseline
(int width, int height) Get the baseline for the specified component, or a value less than 0 if the baseline can not be determined.private DateFormat[]
getCustomFormats
(JFormattedTextField editor) Checks and returns custom formats on the editor, if any.private BasicDatePickerUI.Handler
Lazily creates and returns the shared all-mighty listener of everythingprotected PopupMenuListener
Returns the PopupMenuListener for the MonthView popup.getSelectableDate
(Date date) Checks the given date for validity for selection.void
PENDING: widened access for debugging - need api to control popup visibility?protected void
home
(boolean commit) Navigates to linkDate.protected void
protected void
Installs DatePicker default properties.protected void
protected void
Installs actions and key bindings on the datePicker's linkPanel.protected void
Creates and installs all listeners to all components.protected void
Creates the popup and registers the popup listener.void
boolean
private void
revertValue
(Date oldDate) PENDING: currently this resets at once - but it's a no-no, because it happens during notificationprivate void
setActionEnabled
(String key, boolean enabled) void
Toggles the popups visibility after preparing internal state.protected void
protected void
private void
uninstallEditorListeners
(JFormattedTextField oldEditor) Uninstalls all listeners and actions which have been installed by this delegate from the given editor.protected void
protected void
Uninstalls actions and key bindings from linkPanel.protected void
Uninstalls and nulls all listeners which had been installed by this delegate.protected void
Removes the popup listener from the popup and null it, if it was not null.void
private void
updateChildLocale
(Locale locale) protected void
updateEditorListeners
(JFormattedTextField oldEditor) Wires the picker's editor related listening and actions.private void
Synchronizes the properties of the current editor to the properties of the JXDatePicker.private void
Sets the editor value to the model's selectedDate.private void
updateFormatLocale
(Locale locale) protected void
Updates the picker's formats to the given TimeZone.protected void
Updates internals after picker's date property changed.protected void
Updates properties which depend on the picker's editable.protected void
updateFromEditorChanged
(JFormattedTextField oldEditor, boolean updateListeners) Updates internals after the picker's editor property has changed.protected void
Update properties which depend on the picker's enabled.protected void
updateFromMonthViewChanged
(JXMonthView oldMonthView) Updates internals after the picker's monthView has changed.protected void
updateFromSelectionChanged
(DateSelectionEvent.EventType eventType, boolean adjusting) Updates date related properties picker/editor after a change in the monthView's selection.protected void
Updates internals after the selection model changed.protected void
updateFromValueChanged
(Date oldDate, Date newDate) Updates date related properties in picker/monthView after a change in the editor's value.protected void
Updates the picker's linkDate to be in synch with monthView's today.protected void
updateLinkPanel
(JComponent oldLinkPanel) protected void
Called form property listener, updates all components locale, formats etc.protected void
updateMonthViewListeners
(JXMonthView oldMonthView) Wires the picker's monthView related listening.protected void
Wires monthView's selection model listening.protected void
updateTimeZone
(TimeZone old) Updates picker's timezone dependent properties on change notification from the associated monthView.Methods inherited from class javax.swing.plaf.ComponentUI
contains, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior, getMaximumSize, paint, update
-
Field Details
-
LOG
-
datePicker
-
popupButton
-
popup
-
handler
-
propertyChangeListener
-
focusListener
-
mouseListener
-
mouseMotionListener
-
editorActionListener
-
editorCancelAction
-
editorPropertyListener
-
monthViewSelectionListener
listeners for the picker's monthview -
monthViewActionListener
-
monthViewPropertyListener
-
popupRemover
-
popupMenuListener
-
-
Constructor Details
-
BasicDatePickerUI
public BasicDatePickerUI()
-
-
Method Details
-
createUI
-
installUI
- Overrides:
installUI
in classComponentUI
-
uninstallUI
- Overrides:
uninstallUI
in classComponentUI
-
installComponents
protected void installComponents() -
getCustomFormats
Checks and returns custom formats on the editor, if any.- Parameters:
editor
- the editor to check- Returns:
- the custom formats uses in the editor or null if it had used defaults as defined in the datepicker properties
-
uninstallComponents
protected void uninstallComponents() -
installDefaults
protected void installDefaults()Installs DatePicker default properties. -
uninstallDefaults
protected void uninstallDefaults() -
installKeyboardActions
protected void installKeyboardActions() -
uninstallKeyboardActions
protected void uninstallKeyboardActions() -
installLinkPanelKeyboardActions
protected void installLinkPanelKeyboardActions()Installs actions and key bindings on the datePicker's linkPanel. Does nothing if the linkPanel is null. PRE: keybindings installed on picker. -
uninstallLinkPanelKeyboardActions
Uninstalls actions and key bindings from linkPanel. Does nothing if the linkPanel is null.- Parameters:
panel
- the component to uninstall
-
installListeners
protected void installListeners()Creates and installs all listeners to all components. -
uninstallListeners
protected void uninstallListeners()Uninstalls and nulls all listeners which had been installed by this delegate. -
updateMonthViewListeners
Wires the picker's monthView related listening. Removes all listeners from the given old view and adds the listeners to the current monthView.- Parameters:
oldMonthView
-
-
updateEditorListeners
Wires the picker's editor related listening and actions. Removes listeners/actions from the old editor and adds them to the new editor.- Parameters:
oldEditor
- the pickers editor before the change
-
uninstallEditorListeners
Uninstalls all listeners and actions which have been installed by this delegate from the given editor.- Parameters:
oldEditor
- the editor to uninstall.
-
updateSelectionModelListeners
Wires monthView's selection model listening. Removes the selection listener from the old model and add to the new model.- Parameters:
oldModel
- the dateSelectionModel before the change, may be null.
-
createEditor
Creates the editor used to edit the date selection. The editor is configured with the default DatePickerFormatter marked as UIResource.- Returns:
- an instance of a JFormattedTextField
-
createPopupButton
-
getMinimumSize
- Overrides:
getMinimumSize
in classComponentUI
-
getPreferredSize
- Overrides:
getPreferredSize
in classComponentUI
-
getBaseline
public int getBaseline(int width, int height) Description copied from class:DatePickerUI
Get the baseline for the specified component, or a value less than 0 if the baseline can not be determined. The baseline is measured from the top of the component.- Overrides:
getBaseline
in classDatePickerUI
- Parameters:
width
- Width of the component to determine baseline for.height
- Height of the component to determine baseline for.- Returns:
- baseline for the specified component
-
getSelectableDate
Checks the given date for validity for selection. If valid, returns the date as appropriate in the picker's context, otherwise throws a propertyVetoException. Note that the returned date might be different from the input date, f.i. the time fields might be cleared. The input date is guaranteed to be unchanged.- Specified by:
getSelectableDate
in classDatePickerUI
- Parameters:
date
- date to check- Returns:
- the date as allowed in the context of the picker.
- Throws:
PropertyVetoException
- if the given date is not valid for selection
-
updateFromDateChanged
protected void updateFromDateChanged()Updates internals after picker's date property changed. -
updateFromValueChanged
Updates date related properties in picker/monthView after a change in the editor's value. Reverts the value if the new date is unselectable.- Parameters:
oldDate
- the editor value before the changenewDate
- the editor value after the change
-
revertValue
PENDING: currently this resets at once - but it's a no-no, because it happens during notification- Parameters:
oldDate
- the old date to revert to
-
updateFromSelectionChanged
protected void updateFromSelectionChanged(DateSelectionEvent.EventType eventType, boolean adjusting) Updates date related properties picker/editor after a change in the monthView's selection. Here: does nothing if the change is intermediate. PENDNG JW: shouldn't we listen to actionEvents then?- Parameters:
eventType
- the type of the selection changeadjusting
- flag to indicate whether the the selection change is intermediate
-
updateFromMonthViewChanged
Updates internals after the picker's monthView has changed.Cleans to popup. Wires the listeners. Updates date. Updates formats' timezone.
- Parameters:
oldMonthView
- the picker's monthView before the change, may be null.
-
updateFromEditorChanged
Updates internals after the picker's editor property has changed.Updates the picker's children. Removes the old editor and adds the new editor. Wires the editor listeners, it the flag set. Typically, this method is called during installing the componentUI with the flag set to false and true at all other moments.
- Parameters:
oldEditor
- the picker's editor before the change, may be null.updateListeners
- a flag to indicate whether the listeners are ready for usage.
-
updateEditorProperties
private void updateEditorProperties()Synchronizes the properties of the current editor to the properties of the JXDatePicker. -
updateFromSelectionModelChanged
Updates internals after the selection model changed.- Parameters:
oldModel
- the model before the change.
-
updateEditorValue
private void updateEditorValue()Sets the editor value to the model's selectedDate. -
updateFromEditableChanged
protected void updateFromEditableChanged()Updates properties which depend on the picker's editable. -
updateFromEnabledChanged
protected void updateFromEnabledChanged()Update properties which depend on the picker's enabled. -
setActionEnabled
- Parameters:
key
-enabled
-
-
updateFormatsFromTimeZone
Updates the picker's formats to the given TimeZone.- Parameters:
zone
- the timezone to set on the formats.
-
updateTimeZone
Updates picker's timezone dependent properties on change notification from the associated monthView. PENDING JW: DatePicker needs to send notification on timezone change?- Parameters:
old
- the timezone before the change.
-
updateLinkDate
protected void updateLinkDate()Updates the picker's linkDate to be in synch with monthView's today. -
updateLocale
protected void updateLocale()Called form property listener, updates all components locale, formats etc. -
updateFormatLocale
-
updateChildLocale
-
updateLinkPanel
- Parameters:
oldLinkPanel
-
-
commit
protected void commit() -
cancel
protected void cancel() -
hidePopup
public void hidePopup()PENDING: widened access for debugging - need api to control popup visibility? -
isPopupVisible
public boolean isPopupVisible() -
home
protected void home(boolean commit) Navigates to linkDate. If commit, the linkDate is selected and committed. If not commit, the linkDate is scrolled to visible, if the monthview is open, does nothing for invisible monthView.- Parameters:
commit
- boolean to indicate whether the linkDate should be selected and committed
-
createCommitAction
Creates and returns the action for committing the picker's input.- Returns:
-
createCancelAction
Creates and returns the action for cancel the picker's edit.- Returns:
-
createHomeAction
-
createTogglePopupAction
Creates and returns the action which toggles the visibility of the popup.- Returns:
- the action which toggles the visibility of the popup.
-
toggleShowPopup
public void toggleShowPopup()Toggles the popups visibility after preparing internal state. -
installPopup
protected void installPopup()Creates the popup and registers the popup listener. All internal methods must use this method instead of calling createPopup directly. -
uninstallPopup
protected void uninstallPopup()Removes the popup listener from the popup and null it, if it was not null. All internal popup removal/replacement must use this method instead of nulling directly. -
getPopupMenuListener
Returns the PopupMenuListener for the MonthView popup. Lazily created.- Returns:
- the popupuMenuListener to install on the popup
-
createPopupMenuListener
Creates and returns a PopupMenuListener. PENDING JW: the listener management assumes a stateless implementation relative to the popup/picker. Custom implementations should take care to not keep any references.- Returns:
-
createMonthViewPopup
-
createMonthViewPropertyListener
Creates and returns the property change listener for the picker's monthView- Returns:
- the listener for monthView properties
-
createFocusListener
Creates and returns the focuslistener for picker and editor.- Returns:
- the focusListener
-
createEditorActionListener
Creates and returns the ActionListener for the picker's editor.- Returns:
- the Actionlistener for the editor.
-
createMonthViewActionListener
Creates and returns the ActionListener for the picker's monthView.- Returns:
- the Actionlistener for the monthView.
-
createMonthViewSelectionListener
Returns the listener for the dateSelection.- Returns:
- the date selection listener
-
createEditorPropertyListener
- Returns:
- a propertyChangeListener listening to editor property changes
-
getHandler
Lazily creates and returns the shared all-mighty listener of everything- Returns:
- the shared listener.
-
createPropertyChangeListener
-
createLayoutManager
-
createMouseListener
-
createMouseMotionListener
-