com.jidesoft.combobox
Class DateComboBox

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.jidesoft.combobox.AbstractComboBox
                  com.jidesoft.combobox.DateComboBox

All Implemented Interfaces:

DateModelListener, ConverterContextSupport, AlignmentSupport, ActionListener, FocusListener, MouseListener, ImageObserver, ItemSelectable, MenuContainer, Serializable, EventListener, Accessible, PopupMenuListener

Direct Known Subclasses:

DateSpinnerComboBox, MonthComboBox

public class DateComboBox
extends AbstractComboBox
implements DateModelListener

DateComboBox is a combobox which can be used to choose a Date.

See Also:

Serialized Form

Nested Class Summary

class	DateComboBox.DateEditorComponent EditorComponent for DateComboBox when it is not readonly.
class	DateComboBox.DateRendererComponent EditorComponent for DateComboBox when it is readonly.

Nested classes/interfaces inherited from class com.jidesoft.combobox.AbstractComboBox

AbstractComboBox.AccessibleJComboBox, AbstractComboBox.ComboBoxSpinner, AbstractComboBox.ComboBoxTextField, AbstractComboBox.DefaultRendererComponent, AbstractComboBox.DefaultTextFieldEditorComponent, AbstractComboBox.EditorComponent, AbstractComboBox.EnterLazyDelegateAction, AbstractComboBox.LazyDelegateAction, AbstractComboBox.SpinnerEditorComponent

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static String	PROPERTY_SHOW_NONE_BUTTON
static String	PROPERTY_SHOW_OK_BUTTON
static String	PROPERTY_SHOW_TODAY_BUTTON
static String	PROPERTY_SHOW_WEEK_NUMBERS

Fields inherited from class com.jidesoft.combobox.AbstractComboBox

_dialog, _editable, _editor, _listDataListener, _oldSelectedItemReminder, _popupButton, _popupPanel, _renderer, actionCommand, CLIENT_PROPERTY_HIDE_POPUP_ON_LIST_DATA_CHANGED, CLIENT_PROPERTY_TABLE_CELL_EDITOR, CLIENT_PROPERTY_TABLE_CELL_RENDERER, COMMIT, COMMIT_OR_RESET, COMMIT_OR_REVERT, dataModel, DIALOG, DROPDOWN, HIDE_POPUP_KEY, PERSIST, PROPERTY_SELECTED_ITEM, RESET, REVERT, selectedItemReminder

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

DateComboBox()
Constructs a new DateComboBox.

DateComboBox(DateModel model)
Constructs a new DateComboBox with specified DateModel.

Method Summary

protected String	convertElementToString(Object value, Class clazz)
Calendar	createCalendarInstance() Creates a new Calendar instance that will be used internally.
protected DateChooserPanel	createDateChooserPanel() Creates DateChooserPanel as popup component.
AbstractComboBox.EditorComponent	createEditorComponent() Subclass should implement this method to create the actual editor component.
PopupPanel	createPopupComponent() Creates the DateChoosrePanel.
protected void	customizePopup(JidePopup popup) Customizes the JidePopup that is used to show the drop down.
void	dateModelChanged(DateModelEvent e) This notification tells listeners the something changed in date model.
protected boolean	equals(Object object1, Object object2) Check if object1 is equal to object2.
Calendar	getCalendar() Gets the Calendar object that is represented in this component.
Date	getDate() Gets the Date object that is represented in this component.
DateModel	getDateModel() Gets the DateModel.
protected List<KeyStroke>	getDelegateKeyStrokes() Overrides to undelegate CTRL+PAGE_UP and CTRL+PAGE_DOWN
DateFormat	getFormat() Gets the DateFormat that is used to renderer the label.
String	getTimeFormat() Gets the time format for time spinner on DateChooserPanel.
boolean	isInvalidValueAllowed() Checks if the invalid value is allowed.
boolean	isPopupVolatile() Checks if the popup is volatile.
boolean	isShowNoneButton() Checks if none button is visible.
boolean	isShowOKButton() Checks if OK button is visible.
boolean	isShowTodayButton() Checks if today button is visible.
boolean	isShowWeekNumbers() Checks if the week of year panel is visible.
boolean	isTimeDisplayed() Checks if the time is displayed.
void	popupMenuCanceled(PopupMenuEvent e)
void	resetPopup() Resets the popup.
void	setCalendar(Calendar calendar) Sets the Date.
void	setDate(Date date) Sets the Date.
void	setDateModel(DateModel dateModel) Sets the DateModel.
void	setFormat(DateFormat format) Sets the DateFormat.
void	setInvalidValueAllowed(boolean invalidValueAllowed) Sets the flag if the invalid value is allowed to be entered into DateComboBox.
void	setLocale(Locale l)
void	setSelectedItem(Object anObject, boolean fireEvent) Sets the selected item.
void	setSelectedItemWithoutValidation(Object anObject, boolean fireEvent) Sets the selected date.
void	setShowNoneButton(boolean showNoneButton) Sets the none button visible.
void	setShowOKButton(boolean showOKButton) Sets the OK button visible.
void	setShowTodayButton(boolean showTodayButton) Sets the today button visible.
void	setShowWeekNumbers(boolean showWeekNumbers) Sets the week of year panel visible.
void	setTimeDisplayed(boolean timeDisplayed) Sets the timeDisplayed property.
void	setTimeFormat(String timeFormat) Sets the format for the time spinner on DateChooserPanel.
protected void	updateDateFromEditorComponent()

Methods inherited from class com.jidesoft.combobox.AbstractComboBox

actionPerformed, addActionListener, addItemListener, addNotify, addPopupMenuListener, calculatePopupLocation, comboBoxSelected, commitEdit, commitEditWithFocusLostBehavior, configurePropertiesFromAction, createActionPropertyChangeListener, createButtonComponent, createDefaultButton, createPopupWindow, createPropertyChangeListener, createSpinner, createTextField, customizeButton, customizeDialog, customizeDialogLocation, delegateKeyStrokes, fireActionEvent, fireItemStateChanged, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, focusGained, focusLost, getAccessibleContext, getAction, getActionCommand, getActionListeners, getBackground, getBaseline, getConverter, getConverterContext, getDefaultCancelAction, getDefaultOKAction, getDelegateTarget, getDialogCancelAction, getDialogOKAction, getDisabledBackground, getDisabledForeground, getEditor, getFocusLostBehavior, getForeground, getHorizontalAlignment, getItemListeners, getModel, getPopupButton, getPopupCancelBehavior, getPopupLocation, getPopupMenuListeners, getPopupPanel, getPopupType, getPrototypeDisplayValue, getRenderer, getSelectedItem, getSelectedItemForPopupPanel, getSelectedObjects, getType, getVerticalAlignment, hidePopup, initComponent, initComponent, installColorFontAndBorder, installListener, isButtonOnly, isButtonVisible, isClearSelectionOnListDataChanged, isEditable, isHidePopupOnListDataChanged, isKeepPopupSize, isOpaque, isPopupVisible, isStretchToFit, isToggleValueOnDoubleClick, isUpdateFromPopupOnFly, listDataChanged, modelUpdated, mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased, notifyUser, paintComponent, popupMenuWillBecomeInvisible, popupMenuWillBecomeVisible, processKeyBinding, removeActionListener, removeItemListener, removeNotify, removePopupMenuListener, resetEdit, revertEdit, selectedItemChanged, setAction, setActionCommand, setBackground, setBorder, setButtonOnly, setButtonVisible, setClearSelectionOnListDataChanged, setConverter, setConverterContext, setDisabledBackground, setDisabledForeground, setEditable, setEditor, setEnabled, setFocusLostBehavior, setForeground, setHidePopupOnListDataChanged, setHorizontalAlignment, setKeepPopupSize, setModel, setPopupButton, setPopupCancelBehavior, setPopupType, setPopupVisible, setPopupVolatile, setPrototypeDisplayValue, setRenderer, setSelectedItem, setStretchToFit, setToggleValueOnDoubleClick, setType, setVerticalAlignment, showPopup, showPopupPanel, showPopupPanelAsPopup, undelegateKeyStrokes, uninstallListener, updateToolTipTextForChildren, updateUI, validateValueForNonEditable

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_SHOW_NONE_BUTTON

public static final String PROPERTY_SHOW_NONE_BUTTON

See Also:

Constant Field Values

PROPERTY_SHOW_OK_BUTTON

public static final String PROPERTY_SHOW_OK_BUTTON

See Also:

Constant Field Values

PROPERTY_SHOW_TODAY_BUTTON

public static final String PROPERTY_SHOW_TODAY_BUTTON

See Also:

Constant Field Values

PROPERTY_SHOW_WEEK_NUMBERS

public static final String PROPERTY_SHOW_WEEK_NUMBERS

See Also:

Constant Field Values

Constructor Detail

DateComboBox

public DateComboBox()

Constructs a new DateComboBox.

DateComboBox

public DateComboBox(DateModel model)

Constructs a new DateComboBox with specified DateModel.

Parameters:

model - the DateModel.

Method Detail

getDateModel

public DateModel getDateModel()

Gets the DateModel.

Returns:

the DateModel.

setDateModel

public void setDateModel(DateModel dateModel)

Sets the DateModel.

Parameters:

dateModel - the date model

dateModelChanged

public void dateModelChanged(DateModelEvent e)

Description copied from interface: DateModelListener

This notification tells listeners the something changed in date model.

Specified by:

dateModelChanged in interface DateModelListener

createEditorComponent

public AbstractComboBox.EditorComponent createEditorComponent()

Description copied from class: AbstractComboBox

Subclass should implement this method to create the actual editor component.

Specified by:

createEditorComponent in class AbstractComboBox

Returns:

the editor component

createPopupComponent

public PopupPanel createPopupComponent()

Creates the DateChoosrePanel. Here is the code we used to create it. You can override to if you want to subclass DateChooserPanel in order to override methods on DateChooserPanel.

 DateChooserPanel dateChooserPanel = new DateChooserPanel(getDateModel(),
 isShowTodayButton(),
 isShowNoneButton(), isShowWeekNumbers(), getLocale());
 dateChooserPanel.setTimeDisplayed(isTimeDisplayed());
 dateChooserPanel.setShowOKButton(isShowOKButton());
 return dateChooserPanel;
 

Specified by:

createPopupComponent in class AbstractComboBox

Returns:

an instance of DateChooserPanel.

See Also:

createDateChooserPanel()

createDateChooserPanel

protected DateChooserPanel createDateChooserPanel()

Creates DateChooserPanel as popup component.

You could override this method to customize the date chooser panel as you wish. The default implementation is

      return new DateChooserPanel(getDateModel(), isShowTodayButton(), isShowNoneButton(), isShowWeekNumbers(), getLocale());
 

Returns:

the DateChooserPanel instance.

isPopupVolatile

public boolean isPopupVolatile()

Description copied from class: AbstractComboBox

Checks if the popup is volatile. If a popup is volatile, it will be recreated every time the popup is shown. By default, it's false. Subclasses can override it to return true or false depending on the actual case.

Overrides:

isPopupVolatile in class AbstractComboBox

Returns:

true if the popup is volatile.

popupMenuCanceled

public void popupMenuCanceled(PopupMenuEvent e)

Specified by:

popupMenuCanceled in interface PopupMenuListener

Overrides:

popupMenuCanceled in class AbstractComboBox

getDate

public Date getDate()

Gets the Date object that is represented in this component.

Returns:

the Date

setSelectedItemWithoutValidation

public void setSelectedItemWithoutValidation(Object anObject,
                                             boolean fireEvent)

Sets the selected date. This method will not validate the date like setSelectedItem(Object,boolean) does.

Parameters:

anObject - the new date

fireEvent - true to fire event. False to not to fire event.

equals

protected boolean equals(Object object1,
                         Object object2)

Description copied from class: AbstractComboBox

Check if object1 is equal to object2. The default implementation is check if the object1 and object2 is the same instance. You can override it if you need more concise control on the events.

Overrides:

equals in class AbstractComboBox

Parameters:

object1 - one of the two objects

object2 - another one of the two objects

Returns:

true if those two objects are equal. Otherwise false.

setSelectedItem

public void setSelectedItem(Object anObject,
                            boolean fireEvent)

Sets the selected item. This method will valid to make sure the new value is a valid date using getDateModel.isValidDate method.

Overrides:

setSelectedItem in class AbstractComboBox

Parameters:

anObject - the new date

fireEvent - true to fire event. False to not to fire event.

See Also:

setSelectedItemWithoutValidation(Object, boolean)

createCalendarInstance

public Calendar createCalendarInstance()

Creates a new Calendar instance that will be used internally.

Returns:

a Calendar instance.

updateDateFromEditorComponent

protected void updateDateFromEditorComponent()

getCalendar

public Calendar getCalendar()

Gets the Calendar object that is represented in this component.

Returns:

the Date in Calendar

setDate

public void setDate(Date date)

Sets the Date.

Parameters:

date - the date

setCalendar

public void setCalendar(Calendar calendar)

Sets the Date.

Parameters:

calendar - the calendar

convertElementToString

protected String convertElementToString(Object value,
                                        Class clazz)

getFormat

public DateFormat getFormat()

Gets the DateFormat that is used to renderer the label.

Returns:

the DateFormat

setFormat

public void setFormat(DateFormat format)

Sets the DateFormat.

Please note, if you want to change the DateFormat, please make sure you call this method before you set the Calendar value using setCalendar(java.util.Calendar) method. Otherwise, the Calendar value you set will be converted using the old format. Here is the right order to display time value in DateComboBox.

 DateComboBox dateBox = new DateComboBox();
 dateBox.setTimeDisplayed(true);
 dateBox.setFormat(DateFormat.getDateTimeInstance()); // call this before setCalendar.
 dateBox.setCalendar(cal);
 

Parameters:

format - the date format

isShowTodayButton

public boolean isShowTodayButton()

Checks if today button is visible.

Returns:

true if today button is visible.

setShowTodayButton

public void setShowTodayButton(boolean showTodayButton)

Sets the today button visible.

Parameters:

showTodayButton - the flag

isShowNoneButton

public boolean isShowNoneButton()

Checks if none button is visible.

Returns:

true if none button is visible.

setShowNoneButton

public void setShowNoneButton(boolean showNoneButton)

Sets the none button visible.

Parameters:

showNoneButton - the flag

isShowOKButton

public boolean isShowOKButton()

Checks if OK button is visible.

Returns:

true if OK button is visible.

setShowOKButton

public void setShowOKButton(boolean showOKButton)

Sets the OK button visible. Even you set it to true, OK button will only be displayed when setTimeDisplayed(boolean) is also set to true.

Parameters:

showOKButton - the flag

isShowWeekNumbers

public boolean isShowWeekNumbers()

Checks if the week of year panel is visible.

Returns:

true if the week of year is visible.

setShowWeekNumbers

public void setShowWeekNumbers(boolean showWeekNumbers)

Sets the week of year panel visible.

Parameters:

showWeekNumbers - the flag

getDelegateKeyStrokes

protected List<KeyStroke> getDelegateKeyStrokes()

Overrides to undelegate CTRL+PAGE_UP and CTRL+PAGE_DOWN

Overrides:

getDelegateKeyStrokes in class AbstractComboBox

Returns:

the list of KeyStrokes that will be delegated to the popup panel.

isTimeDisplayed

public boolean isTimeDisplayed()

Checks if the time is displayed.

Returns:

true or false.

setTimeDisplayed

public void setTimeDisplayed(boolean timeDisplayed)

Sets the timeDisplayed property. If this property is true, the DateChooserPanel will show a time spinner so that user can change time.

Parameters:

timeDisplayed - the flag

getTimeFormat

public String getTimeFormat()

Gets the time format for time spinner on DateChooserPanel.

Returns:

the time format.

setTimeFormat

public void setTimeFormat(String timeFormat)

Sets the format for the time spinner on DateChooserPanel. The default value is "hh:mm a". Please refer to SimpleDateFormat for the specification of format. Please also note this time format is not for what to be displayed in the combobox itself. The format that controls what is displayed in the combobox is setFormat(java.text.DateFormat).

Parameters:

timeFormat - the flag

setLocale

public void setLocale(Locale l)

Overrides:

setLocale in class Component

resetPopup

public void resetPopup()

Description copied from class: AbstractComboBox

Resets the popup. If the popup is not volatile, this method will reset the popup to null so next time it will recreate again.

Overrides:

resetPopup in class AbstractComboBox

isInvalidValueAllowed

public boolean isInvalidValueAllowed()

Checks if the invalid value is allowed.

Returns:

true or false.

setInvalidValueAllowed

public void setInvalidValueAllowed(boolean invalidValueAllowed)

Sets the flag if the invalid value is allowed to be entered into DateComboBox. If false (the default value), user must type a valid date string in the correct format. Otherwise, the focus lost or after enter is pressed, the invalid value will be reset. If true, the invalid string will be kept and set to the combobox using setSelectedItem. Developer can use getSelectedItem to retrieve the value. getDate or getCalendar will still return null as the value is not valid.

Parameters:

invalidValueAllowed - true or false.

customizePopup

protected void customizePopup(JidePopup popup)

Description copied from class: AbstractComboBox

Customizes the JidePopup that is used to show the drop down.

Overrides:

customizePopup in class AbstractComboBox

Parameters:

popup - the JidePopup.