com.klg.jclass.util.calendar
Class DateTimeEditor

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--com.klg.jclass.util.calendar.CalendarContainer
                                |
                                +--com.klg.jclass.util.calendar.DateTimeEditor

All Implemented Interfaces:

Accessible, ActionListener, CalendarComponent, ContainerListener, EventListener, ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

DateTimeChooser

public class DateTimeEditor

extends CalendarContainer

Class that wraps a JCDateChooser and a Time Component together.

See Also:

Serialized Form

Nested Class Summary

protected class

DateTimeEditor.DateChooser The date chooser component.

Nested classes inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

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 JButton	applyButton A button that sets the current value on the popup calendar and pops down the popup.
protected com.klg.jclass.util.calendar.JCDateChooser	dateChooser The date chooser.
protected boolean	hidePopupOnDayTableClick If true, popdown popup if user clicks on day table.
protected boolean	showApplyButton Add an apply button to the popup.
protected boolean	showTimeComponent Controls whether the timeComponent is shown.
protected com.klg.jclass.util.calendar.CalendarComponent	timeComponent The time component.
protected com.klg.jclass.util.calendar.CalendarContainer	timeContainer The container which holds the time component.

Fields inherited from class com.klg.jclass.util.calendar.CalendarContainer

actionListeners, initialized, locale, model, specialDates, userFont

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

DateTimeEditor()
Create a DateTimeChooser with default values and no associated popupEditor.

DateTimeEditor(int chooserType, boolean showTimeComponent, boolean showApplyButton, Locale l, Calendar c)
Create a DateTimeChooser that specifies the type of chooser, whether or not to show a time component, the locale, and an intial date/time.

DateTimeEditor(int chooserType, boolean showTimeComponent, boolean showApplyButton, Locale l, Calendar c, String[] months, String[] shortMonths, String[] days)
Create a DateTimeChooser that specifies the type of chooser, whether or not to show a time component, the locale, an intial date/time, and gives a list of month, shortMonth, and day strings to use for the calendar.

Method Summary

protected JButton	createApplyButton() Create an apply button.
protected com.klg.jclass.util.calendar.CalendarComponent	createTimeComponent(int type, Calendar c) Create the time component based on the passed in type.
protected com.klg.jclass.util.calendar.CalendarContainer	createTimeContainer(Calendar c) Create the time component and the the container which holds it.
protected void	firePopupEvent() Fire a popup event to all listeners.
JButton	getApplyButton() Return the applyButton.
int	getChooserType() Gets the date chooser type.
com.klg.jclass.util.calendar.JCDateChooser	getDateChooser() Returns the JCDateChooser component.
boolean	getHidePopupOnDayTableClick() Get whether the popup will popdown when the user selects a day on the day table.
Calendar	getMaximumDate() Returns the maximum roll date.
Calendar	getMinimumDate() Returns the minimum roll date.
boolean	getShowApplyButton() Get whether an apply button be shown in the popup.
boolean	getShowTimeComponent() Returns whether the time component should appear or not.
com.klg.jclass.util.calendar.CalendarComponent	getTimeComponent() Returns the time component.
Object	getValue() Returns the value in the data model.
void	setChooserType(int type) Sets the date chooser type.
void	setHidePopupOnDayTableClick(boolean hidePopupOnDayTableClick) Set whether the popup will popdown when the user selects a day on the day table.
void	setMaximumDate(Calendar maxDate) Sets the maximum roll date.
void	setMinimumDate(Calendar minDate) Sets the minimum date.
void	setShowApplyButton(boolean showApplyButton) Set whether an apply button be shown in the popup.
void	setShowTimeComponent(boolean showTimeComponent) Sets whether the time component should appear or not.
void	setValue(Object value) Sets the value in the data model.
protected void	updateLayout(boolean doLayout) Update the layout so that we get the dateChooser, then the timeContainer if it is required, and then the apply button if it is required.
protected void	updateTimeComponent(int type) Update the time component in response to the user changing the chooser type.

Methods inherited from class com.klg.jclass.util.calendar.CalendarContainer

actionPerformed, addActionListener, componentAdded, componentRemoved, getCalendarModel, getLocale, getUserFont, removeActionListener, setCalendarModel, setFont, setLocale, setSpecialDates

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, processKeyEvent, 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, setEnabled, 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, 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

dateChooser

protected com.klg.jclass.util.calendar.JCDateChooser dateChooser

The date chooser.

timeComponent

protected com.klg.jclass.util.calendar.CalendarComponent timeComponent

The time component. Either a TimeSpin or TimeLabel object.

timeContainer

protected com.klg.jclass.util.calendar.CalendarContainer timeContainer

The container which holds the time component.

applyButton

protected JButton applyButton

A button that sets the current value on the popup calendar and pops down the popup.

showTimeComponent

protected boolean showTimeComponent

Controls whether the timeComponent is shown.

showApplyButton

protected boolean showApplyButton

Add an apply button to the popup.

hidePopupOnDayTableClick

protected boolean hidePopupOnDayTableClick

If true, popdown popup if user clicks on day table.

Constructor Detail

DateTimeEditor

public DateTimeEditor()

Create a DateTimeChooser with default values and no associated popupEditor.

DateTimeEditor

public DateTimeEditor(int chooserType,
                      boolean showTimeComponent,
                      boolean showApplyButton,
                      Locale l,
                      Calendar c)

Create a DateTimeChooser that specifies the type of chooser, whether or not to show a time component, the locale, and an intial date/time.

Parameters:

chooserType - The type of date chooser. Must be one of JCDateChooser.QUICK_SELECT, JCDateChooser.DUAL_SPIN, JCDateChooser.SPIN_POPDOWN, or JCDateChooser.READ_ONLY. Note that specifying JCDateChooser.SPIN_POPDOWN will cause JCDateChooser.DUAL_SPIN to be used because we cannot have a popdown within a popdown.

showTimeComponent - Determines whether the time component is shown or not.

showApplyButton - If true, an apply button is shown.

l - The locale to use.

c - The intial date and time.

DateTimeEditor

public DateTimeEditor(int chooserType,
                      boolean showTimeComponent,
                      boolean showApplyButton,
                      Locale l,
                      Calendar c,
                      String[] months,
                      String[] shortMonths,
                      String[] days)

Create a DateTimeChooser that specifies the type of chooser, whether or not to show a time component, the locale, an intial date/time, and gives a list of month, shortMonth, and day strings to use for the calendar.

Parameters:

chooserType - The type of date chooser. Must be one of JCDateChooser.QUICK_SELECT, JCDateChooser.DUAL_SPIN, JCDateChooser.SPIN_POPDOWN, or JCDateChooser.READ_ONLY. Note that specifying JCDateChooser.SPIN_POPDOWN will cause JCDateChooser.DUAL_SPIN to be used because we cannot have a popdown within a popdown.

showTimeComponent - Determines whether the time component is shown or not.

showApplyButton - If true, an apply button is shown.

l - The locale to use

c - The intial date and time.

months - The month strings to use for the calendar. Note that this array must be the correct size for the locale (or longer).

shortMonths - The shortMonth strings to use for the calendar. Note that this array must be the correct size for the locale (or longer).

days - The day strings to use for the calendar. Note that this array must be the correct size for the locale (or longer).

Method Detail

createTimeComponent

protected com.klg.jclass.util.calendar.CalendarComponent createTimeComponent(int type,
                                                                             Calendar c)

Create the time component based on the passed in type. Its always a TimeSpin object unless the type is JCDateChooser.READ_ONLY in which case its a TimeLabel object.

Parameters:

type - The type of chooser

c - The initial time

Returns:

The new time component

updateTimeComponent

protected void updateTimeComponent(int type)

Update the time component in response to the user changing the chooser type.

Parameters:

type - The new chooser type

createTimeContainer

protected com.klg.jclass.util.calendar.CalendarContainer createTimeContainer(Calendar c)

Create the time component and the the container which holds it.

Parameters:

c - An initial time for the time component

Returns:

The new time container

getTimeComponent

public com.klg.jclass.util.calendar.CalendarComponent getTimeComponent()

Returns the time component. This may be either a time label (if the chooser type is JCDateChooser.READ_ONLY), a time spinner, or null is showTimeComponent is false.

Returns:

The time component. This may be null, if showTimeComponent is false.

See Also:

TimeSpin, TimeLabel

firePopupEvent

protected void firePopupEvent()

Fire a popup event to all listeners. Since this is not a popup, this method does nothing here. Meant to be overridden.

createApplyButton

protected JButton createApplyButton()

Create an apply button.

Returns:

The newly created apply button.

getApplyButton

public JButton getApplyButton()

Return the applyButton.

Returns:

The apply button. This may be null, if showApplyButton is false.

updateLayout

protected void updateLayout(boolean doLayout)

Update the layout so that we get the dateChooser, then the timeContainer if it is required, and then the apply button if it is required.

setChooserType

public void setChooserType(int type)

Sets the date chooser type.

Parameters:

type - The type of chooser; must be one of JCDateChooser.QUICK_SELECT, JCDateChooser.DUAL_SPIN,, or JCDateChooser.READ_ONLY. The chooser cannot be of type JCDateChooser.SPIN_POPDOWN because we cannot have a popdown within a popdown.

getChooserType

public int getChooserType()

Gets the date chooser type.

Returns:

an int representing the chooser type, one of

• JCDateChooser.QUICK_SELECT
• JCDateChooser.DUAL_SPIN
• JCDateChooser.READ_ONLY
. The chooser cannot be of type JCDateChooser.SPIN_POPDOWN because we cannot have a popdown within a popdown.

setShowTimeComponent

public void setShowTimeComponent(boolean showTimeComponent)

Sets whether the time component should appear or not.

Parameters:

showTimeComponent - If true, the time component will appear

getShowTimeComponent

public boolean getShowTimeComponent()

Returns whether the time component should appear or not.

Returns:

The current value of showTimeComponent

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.

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.

getValue

public Object getValue()

Returns the value in the data model.

Returns:

The current value in the data model

setValue

public void setValue(Object value)

Sets the value in the data model.

Parameters:

value - The value for the data model.

getMinimumDate

public Calendar getMinimumDate()

Returns the minimum roll date. The calendar cannot change before the date.

Returns:

the minimum date

See Also:

Calendar, setMinimumDate(java.util.Calendar), getMaximumDate(), setMaximumDate(java.util.Calendar)

setMinimumDate

public void setMinimumDate(Calendar minDate)

Sets the minimum date. The calendar cannot change to before this date.

Parameters:

minDate - the new minimum date

See Also:

Calendar, getMinimumDate(), getMaximumDate(), setMaximumDate(java.util.Calendar)

getMaximumDate

public Calendar getMaximumDate()

Returns the maximum roll date. The calendar cannot change later than this date.

Returns:

the maximum date

See Also:

Calendar, setMinimumDate(java.util.Calendar), getMinimumDate(), setMaximumDate(java.util.Calendar)

setMaximumDate

public void setMaximumDate(Calendar maxDate)

Sets the maximum roll date. The calendar cannot change later than this date.

Parameters:

maxDate - the new maximum date

See Also:

Calendar, setMinimumDate(java.util.Calendar), getMinimumDate(), getMaximumDate()

getDateChooser

public com.klg.jclass.util.calendar.JCDateChooser getDateChooser()

Returns the JCDateChooser component.

Returns:

The date chooser component

See Also:

JCDateChooser