com.klg.jclass.swing
Class JCPopupCalendar

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JComboBox
                          |
                          +--com.klg.jclass.swing.JCPopupCalendar

All Implemented Interfaces:

Accessible, ActionListener, DocumentListener, EventListener, FocusListener, ImageObserver, ItemSelectable, KeyListener, ListDataListener, MenuContainer, PropertyChangeListener, Serializable

public class JCPopupCalendar

extends JComboBox

implements KeyListener, PropertyChangeListener, DocumentListener, FocusListener

JCPopupCalendar is subclassed from JCComboBox. It uses a model with a single Date object in conjunction with a calendar popup. Note: This component can only be used with JDK 1.4 or later.

See Also:

Serialized Form

Nested Class Summary

protected class	JCPopupCalendar.Bounds This class is allows the DateEditor to make sure its value falls between any minimum or maximum specified on the popup calendar.
class	JCPopupCalendar.DateEditor The default editor for the JCPopupCalendar.
class	JCPopupCalendar.DateRenderer The default renderer for the JCPopupCalendar.

Nested classes inherited from class javax.swing.JComboBox

JComboBox.AccessibleJComboBox, JComboBox.KeySelectionManager

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected int	calendarType The type of calendar - either Date_TIME or DATE.
static int	DATE Valid value for CalendarType.
static int	DATE_TIME Valid value for CalendarType.
protected DefaultComboBoxModel	model The current model.
protected com.klg.jclass.swing.JCPopupCalendarEditor	popupEditor The current popup editor.
protected boolean	showPopupOnUpDownArrow If true, and the user presses up or down arrow while in the editor, the calendar popup appears.

Fields inherited from class javax.swing.JComboBox

actionCommand, dataModel, editor, isEditable, keySelectionManager, lightWeightPopupEnabled, maximumRowCount, renderer, 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

JCPopupCalendar()
Constructs a JCPopupCalendar of type DATE_TIME with the current date and time and the default locale.

JCPopupCalendar(Date d)
Constructs a JCPopupCalendar of type DATE_TIME with the supplied date and the default locale.

JCPopupCalendar(Date d, Locale l)
Constructs a JCPopupCalendar of type DATE_TIME with the supplied date and locale.

JCPopupCalendar(int calendarType)
Constructs a JCPopupCalendar of the supplied calendarType with the current date and the default locale.

JCPopupCalendar(int calendarType, Date d)
Constructs a JCPopupCalendar of the supplied calendarType with the supplied date and the default locale.

JCPopupCalendar(int calendarType, Date d, Locale l)
Constructs a JCPopupCalendar with the supplied date and locale.

Method Summary

void	changedUpdate(DocumentEvent e) Gives notification that an attribute or set of attributes changed.
protected Date	extractCurrentEditorValue() This returns the currently being edited value (possibly before a commit takes place) of the combo box editor.
void	focusGained(FocusEvent e) Invoked when a component gains the keyboard focus.
void	focusLost(FocusEvent e) Invoked when a component loses the keyboard focus.
int	getCalendarType() Get the calendar type.
static DateFormat	getDefaultDateFormat(int type, Locale l) Given a calendar type and a locale, return the default date format that JCPopupCalendar uses.
boolean	getHidePopupOnDayTableClick() Get whether the popup will popdown when the user selects a day on the day table.
Date	getMaximumDate() Returns the maximum date.
Date	getMinimumDate() Returns the minimum date.
com.klg.jclass.swing.JCPopupCalendarEditor	getPopupEditor() Returns the popup editor.
boolean	getShowApplyButton() Get whether an apply button be shown in the popup.
boolean	getShowPopupOnUpDownArrow() Get whether the popup should appear when the user presses up or down arrow while in the editor.
Date	getValue() Return the model's current value (stored as a Date object).
protected ComboBoxUI	inferLookAndFeelUI() Return the appropriate ComboBoxUI object based on the Look and Feel.
void	insertUpdate(DocumentEvent event) Gives notification that there was an insert into the document.
void	keyPressed(KeyEvent e) Invoked when a key has been pressed.
void	keyReleased(KeyEvent e) Invoked when a key has been released.
void	keyTyped(KeyEvent e) Invoked when a key has been typed.
static void	main(String[] args) Use for testing to provide a simple popup calendar within a frame.
void	propertyChange(PropertyChangeEvent e) This method gets called when a bound property is changed.
void	removeUpdate(DocumentEvent e) Gives notification that a portion of the document has been removed.
void	setCalendarType(int calendarType) Set the calendar type.
void	setEditor(ComboBoxEditor anEditor) Sets the editor used to paint and edit the selected item in the JCPopupCalendar.
void	setHidePopupOnDayTableClick(boolean hidePopupOnDayTableClick) Set whether the popup will popdown when the user selects a day on the day table.
void	setLocale(Locale l) Sets the locale being used by the popup calendar, which will set it on the popup editor and its child components, the editor, and the renderer.
void	setMaximumDate(Date maxDate) Sets the maximum date.
void	setMinimumDate(Date minDate) Sets the minimum date.
void	setPopupEditor(com.klg.jclass.swing.JCPopupCalendarEditor popup) Sets the popup editor.
void	setShowApplyButton(boolean showApplyButton) Set whether an apply button be shown in the popup.
void	setShowPopupOnUpDownArrow(boolean showPopupOnUpDownArrow) Set whether the popup should appear when the user presses up or down arrow while in the editor.
void	setUI(ComboBoxUI ui) Sets the look and feel for this component.
void	setValue(Date d) Sets the value on the model as a Date object.
protected void	setValue(Date d, boolean updatePopupEditor) Sets the value on the model as a Date object.
protected void	updateComboBoxEditor(Date d) Update the combo box editor with a new date.
protected void	updateComboBoxModel(Date d) Update the combo box model with a new date.
protected void	updateComboBoxRenderer() Update the combo box renderer (this gets done when the popup calendar).
protected void	updatePopupEditor(Date d) Update the popup editor with a new date.
void	updateUI() Resets the UI property to a value from the current look and feel.

Methods inherited from class javax.swing.JComboBox

actionPerformed, addActionListener, addItem, addItemListener, addPopupMenuListener, configureEditor, configurePropertiesFromAction, contentsChanged, createActionPropertyChangeListener, createDefaultKeySelectionManager, fireActionEvent, fireItemStateChanged, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getAction, getActionCommand, getActionListeners, getEditor, getItemAt, getItemCount, getItemListeners, getKeySelectionManager, getMaximumRowCount, getModel, getPopupMenuListeners, getPrototypeDisplayValue, getRenderer, getSelectedIndex, getSelectedItem, getSelectedObjects, getUI, getUIClassID, hidePopup, insertItemAt, installAncestorListener, intervalAdded, intervalRemoved, isEditable, isLightWeightPopupEnabled, isPopupVisible, paramString, processKeyEvent, removeActionListener, removeAllItems, removeItem, removeItemAt, removeItemListener, removePopupMenuListener, selectedItemChanged, selectWithKeyChar, setAction, setActionCommand, setEditable, setEnabled, setKeySelectionManager, setLightWeightPopupEnabled, setMaximumRowCount, setModel, setPopupVisible, setPrototypeDisplayValue, setRenderer, setSelectedIndex, setSelectedItem, showPopup

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

DATE_TIME

public static final int DATE_TIME

Valid value for CalendarType.

See Also:

Constant Field Values

DATE

public static final int DATE

Valid value for CalendarType.

See Also:

Constant Field Values

calendarType

protected int calendarType

The type of calendar - either Date_TIME or DATE.

popupEditor

protected com.klg.jclass.swing.JCPopupCalendarEditor popupEditor

The current popup editor.

showPopupOnUpDownArrow

protected boolean showPopupOnUpDownArrow

If true, and the user presses up or down arrow while in the editor, the calendar popup appears.

model

protected DefaultComboBoxModel model

The current model.

Constructor Detail

JCPopupCalendar

public JCPopupCalendar()

Constructs a JCPopupCalendar of type DATE_TIME with the current date and time and the default locale.

JCPopupCalendar

public JCPopupCalendar(int calendarType)

Constructs a JCPopupCalendar of the supplied calendarType with the current date and the default locale.

Parameters:

calendarType - The calendar type of the JCPopupCalendar. Must be one of JCPopupCalendar.DATE_TIME or JCPopupCalendar.DATE.

JCPopupCalendar

public JCPopupCalendar(Date d)

Constructs a JCPopupCalendar of type DATE_TIME with the supplied date and the default locale.

Parameters:

d - The date to use for the calendar. If null, the current date and time is used.

JCPopupCalendar

public JCPopupCalendar(int calendarType,
                       Date d)

Constructs a JCPopupCalendar of the supplied calendarType with the supplied date and the default locale.

Parameters:

calendarType - The calendar type of the JCPopupCalendar. Must be one of JCPopupCalendar.DATE_TIME or JCPopupCalendar.DATE.

d - The date to use for the calendar. If null, the current date and time is used.

JCPopupCalendar

public JCPopupCalendar(Date d,
                       Locale l)

Constructs a JCPopupCalendar of type DATE_TIME with the supplied date and locale.

Parameters:

d - The date to use for the calendar. If null, the current date and time is used.

l - The locale to use. If null, the default locale is used.

JCPopupCalendar

public JCPopupCalendar(int calendarType,
                       Date d,
                       Locale l)

Constructs a JCPopupCalendar with the supplied date and locale.

Parameters:

calendarType - The calendar type of the JCPopupCalendar. Must be one of JCPopupCalendar.DATE_TIME or JCPopupCalendar.DATE.

d - The date to use for the calendar. If null, the current date and time is used.

l - The locale to use If null, the default locale is used.

Method Detail

inferLookAndFeelUI

protected ComboBoxUI inferLookAndFeelUI()

Return the appropriate ComboBoxUI object based on the Look and Feel.

Returns:

A ComboBoxUI based on the L&F

setPopupEditor

public void setPopupEditor(com.klg.jclass.swing.JCPopupCalendarEditor popup)

Sets the popup editor.

Parameters:

popup - The new popup editor

getPopupEditor

public com.klg.jclass.swing.JCPopupCalendarEditor getPopupEditor()

Returns the popup editor.

Returns:

The current popup editor

setValue

public void setValue(Date d)

Sets the value on the model as a Date object.

Parameters:

d - The new date value.

setValue

protected void setValue(Date d,
                        boolean updatePopupEditor)

Sets the value on the model as a Date object.

Parameters:

d - The new date value.

updatePopupEditor - If true, pass the new value on to the popup editor.

getValue

public Date getValue()

Return the model's current value (stored as a Date object).

Returns:

The current value

getMinimumDate

public Date getMinimumDate()

Returns the minimum date. The popup calendar's date value cannot change to before this minimum date.

Returns:

The current minimum date.

setMinimumDate

public void setMinimumDate(Date minDate)

Sets the minimum date. The popup calendar's date value cannot change to before this minimum date.

Parameters:

minDate - The new minimum date.

getMaximumDate

public Date getMaximumDate()

Returns the maximum date. The popup calendar's date value cannot change to after this maximum date.

Returns:

The current maximum date.

setMaximumDate

public void setMaximumDate(Date maxDate)

Sets the maximum date. The popup calendar's date value cannot change to after this maximum date.

Parameters:

maxDate - The new maximum date.

getCalendarType

public int getCalendarType()

Get the calendar type. Will be one of JCPopupCalendar.DATE_TIME which means both the date and the time are shown or JCPopupCalendar.DATE which means only the date is shown.

Returns:

The current calendar type

setCalendarType

public void setCalendarType(int calendarType)

Set the calendar type. Must be one of JCPopupCalendar.DATE_TIME which means both the date and the time are shown or JCPopupCalendar.DATE which means only the date is shown.

Parameters:

calendarType - The new calendarType. Must be one of JCPopupCalendar.DATE_TIME or JCPopupCalendar.DATE

getShowPopupOnUpDownArrow

public boolean getShowPopupOnUpDownArrow()

Get whether the popup should appear when the user presses up or down arrow while in the editor.

Returns:

The current value of isShowPopupOnUpDownArrow.

setShowPopupOnUpDownArrow

public void setShowPopupOnUpDownArrow(boolean showPopupOnUpDownArrow)

Set whether the popup should appear when the user presses up or down arrow while in the editor.

Parameters:

showPopupOnUpDownArrow - If true, and the user presses up or down arrow while in the editor, the calendar popup appears.

getHidePopupOnDayTableClick

public boolean getHidePopupOnDayTableClick()

Get whether the popup will popdown when the user selects a day on the day table.

Returns:

The current value of hidePopupOnDayTableClick.

setHidePopupOnDayTableClick

public void setHidePopupOnDayTableClick(boolean hidePopupOnDayTableClick)

Set whether the popup will popdown when the user selects a day on the day table.

Parameters:

hidePopupOnDayTableClick - The new value of hidePopupOnDayTableClick. If true, the popup will popdown when the user selects a day on the day table.

getShowApplyButton

public boolean getShowApplyButton()

Get whether an apply button be shown in the popup. If an apply button is shown, clicking on the button applies the value to the model and hides the popup.

Returns:

The current value of showApplyButton.

setShowApplyButton

public void setShowApplyButton(boolean showApplyButton)

Set whether an apply button be shown in the popup. If an apply button is shown, clicking on the button applies the value to the model and hides the popup.

Parameters:

showApplyButton - The new value of showApplyButton. If true, an apply button is shown in the popup.

keyTyped

public void keyTyped(KeyEvent e)

Invoked when a key has been typed. See the class description for KeyEvent for a definition of a key typed event.

Specified by:

keyTyped in interface KeyListener

Parameters:

e - The event generated by the key being typed

keyPressed

public void keyPressed(KeyEvent e)

Invoked when a key has been pressed. See the class description for KeyEvent for a definition of a key pressed event.

Specified by:

keyPressed in interface KeyListener

Parameters:

e - The event generated by the keyPress

keyReleased

public void keyReleased(KeyEvent e)

Invoked when a key has been released. See the class description for KeyEvent for a definition of a key released event.

Specified by:

keyReleased in interface KeyListener

Parameters:

e - The event generated by the keyRelease

propertyChange

public void propertyChange(PropertyChangeEvent e)

This method gets called when a bound property is changed.

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

e - A PropertyChangeEvent object describing the event source and the property that has changed.

focusGained

public void focusGained(FocusEvent e)

Invoked when a component gains the keyboard focus.

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent e)

Invoked when a component loses the keyboard focus. Sometimes the editor's value gets reset when the focus changes. Make sure it reflects the current model's value.

Specified by:

focusLost in interface FocusListener

insertUpdate

public void insertUpdate(DocumentEvent event)

Gives notification that there was an insert into the document. The range given by the DocumentEvent bounds the freshly inserted region.

Specified by:

insertUpdate in interface DocumentListener

Parameters:

event - The document event

removeUpdate

public void removeUpdate(DocumentEvent e)

Gives notification that a portion of the document has been removed. The range is given in terms of what the view last saw (that is, before updating sticky positions).

Specified by:

removeUpdate in interface DocumentListener

Parameters:

e - The document event

changedUpdate

public void changedUpdate(DocumentEvent e)

Gives notification that an attribute or set of attributes changed.

Specified by:

changedUpdate in interface DocumentListener

Parameters:

e - The document event

extractCurrentEditorValue

protected Date extractCurrentEditorValue()

This returns the currently being edited value (possibly before a commit takes place) of the combo box editor. This may or may not be equal to the value in the formatted text field.

Returns:

The current editor value

updateComboBoxEditor

protected void updateComboBoxEditor(Date d)

Update the combo box editor with a new date.

Parameters:

d - The new date

updateComboBoxRenderer

protected void updateComboBoxRenderer()

Update the combo box renderer (this gets done when the popup calendar).

updateComboBoxModel

protected void updateComboBoxModel(Date d)

Update the combo box model with a new date.

Parameters:

d - The new date

updatePopupEditor

protected void updatePopupEditor(Date d)

Update the popup editor with a new date.

Parameters:

d - The new date

setUI

public void setUI(ComboBoxUI ui)

Sets the look and feel for this component.

Overrides:

setUI in class JComboBox

Parameters:

ui - The new Look and Feel object.

updateUI

public void updateUI()

Resets the UI property to a value from the current look and feel. Note that if you are using a popup editor that is not the default, you will need to recreate your popup editor (with the new L&F) and reset it on popup calendar.

Overrides:

updateUI in class JComboBox

setLocale

public void setLocale(Locale l)

Sets the locale being used by the popup calendar, which will set it on the popup editor and its child components, the editor, and the renderer.

Overrides:

setLocale in class Component

Parameters:

l - The new locale to be used.

setEditor

public void setEditor(ComboBoxEditor anEditor)

Sets the editor used to paint and edit the selected item in the JCPopupCalendar. The editor is used only if the receiving JCPopupCalendar is editable. If not editable, the popup calendar uses the renderer to paint the selected item.

Overrides:

setEditor in class JComboBox

Parameters:

anEditor - The ComboBoxEditor that displays the current value

See Also:

JComboBox.setRenderer(javax.swing.ListCellRenderer)

getDefaultDateFormat

public static DateFormat getDefaultDateFormat(int type,
                                              Locale l)

Given a calendar type and a locale, return the default date format that JCPopupCalendar uses.

Parameters:

type - A calendar type. Must be one of JCPopupCalendar.DATE_TIME or JCPopupCalendar.DATE.

l - The locale. If null, the default locale is used.

Returns:

A DateFormat object based on the type and locale.

main

public static void main(String[] args)

Use for testing to provide a simple popup calendar within a frame.

Parameters:

args - Command line args (ignored)