edu.wisc.ssec.mcidasv.ui

Class JCalendarDateEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextField

javax.swing.JFormattedTextField

edu.wisc.ssec.mcidasv.ui.JCalendarDateEditor

All Implemented Interfaces:

com.toedter.calendar.IDateEditor, ActionListener, FocusListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, CaretListener, Scrollable, SwingConstants

public class JCalendarDateEditor
extends JFormattedTextField
implements com.toedter.calendar.IDateEditor, CaretListener, FocusListener, ActionListener

This class is just a JTextFieldDateEditor that allows the user to enter either the day within (current) year or a McIDAS-X style "julian day" (YYYYDDD or YYDDD), in addition to the formatting allowed by JTextFieldDateEditor.

See Also:

Serialized Form

Nested Class Summary

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

JFormattedTextField.AbstractFormatter, JFormattedTextField.AbstractFormatterFactory

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

JTextField.AccessibleJTextField

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding

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

Fields

Modifier and Type	Field and Description
private SimpleDateFormat	badYearAndDay Parse YYDDD dates.
private static Pattern	badYearDay Match YYDDD dates.
private Calendar	calendar
protected Color	darkGreen
protected Date	date
protected SimpleDateFormat	dateFormatter
protected String	datePattern
protected com.toedter.calendar.DateUtil	dateUtil
private SimpleDateFormat	dayOfYear Parse DDD dates (even if they are one or two digits).
private static Pattern	dayOnly Match day of year.
private int	hours
private boolean	ignoreDatePatternChange
private boolean	isMaskVisible
private static org.slf4j.Logger	logger
protected MaskFormatter	maskFormatter
protected String	maskPattern
private int	millis
private int	minutes
protected char	placeholder
private int	seconds
private SimpleDateFormat	yearAndDay Parse YYYYDDD dates.
private static Pattern	yearDay Match YYYYDDD.

Fields inherited from class javax.swing.JFormattedTextField

COMMIT, COMMIT_OR_REVERT, PERSIST, REVERT

Fields inherited from class javax.swing.JTextField

notifyAction

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

Fields inherited from class javax.swing.JComponent

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
JCalendarDateEditor()
JCalendarDateEditor(boolean showMask, String datePattern, String maskPattern, char placeholder)
JCalendarDateEditor(String datePattern, String maskPattern, char placeholder)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) Validates the typed date and sets it (only if it is valid).
private Date	attemptParsing(String text)
void	caretUpdate(CaretEvent event) After any user input, the value of the textfield is proofed.
private void	checkText()
String	createMaskFromDatePattern(String datePattern) Creates a mask from a date pattern.
void	focusGained(FocusEvent e)
void	focusLost(FocusEvent focusEvent)
Date	getDate()
String	getDateFormatString()
Date	getMaxSelectableDate()
Date	getMinSelectableDate()
Dimension	getPreferredSize() Returns the preferred size.
JComponent	getUiComponent()
boolean	isMaskVisible() Returns true, if the mask is visible.
void	setDate(Date date)
protected void	setDate(Date date, boolean firePropertyChange) Sets the date.
void	setDateFormatString(String dateFormatString)
void	setEnabled(boolean b) Enables and disabled the compoment.
void	setLocale(Locale locale)
void	setMaskVisible(boolean isMaskVisible) Sets the mask visible.
void	setMaxSelectableDate(Date max)
void	setMinSelectableDate(Date min)
void	setSelectableDateRange(Date min, Date max)

Methods inherited from class javax.swing.JFormattedTextField

commitEdit, getActions, getFocusLostBehavior, getFormatter, getFormatterFactory, getUIClassID, getValue, invalidEdit, isEditValid, processFocusEvent, processInputMethodEvent, setDocument, setFocusLostBehavior, setFormatter, setFormatterFactory, setValue

Methods inherited from class javax.swing.JTextField

actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getScrollOffset, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setFont, setHorizontalAlignment, setScrollOffset

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setForeground, 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, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, processHierarchyBoundsEvent, processHierarchyEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.toedter.calendar.IDateEditor

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Field Detail

dayOnly

private static final Pattern dayOnly

Match day of year.

yearDay

private static final Pattern yearDay

Match YYYYDDD.

badYearDay

private static final Pattern badYearDay

Match YYDDD dates.

logger

private static final org.slf4j.Logger logger

date

protected Date date

dateFormatter

protected SimpleDateFormat dateFormatter

dayOfYear

private final SimpleDateFormat dayOfYear

Parse DDD dates (even if they are one or two digits).

yearAndDay

private final SimpleDateFormat yearAndDay

Parse YYYYDDD dates.

badYearAndDay

private final SimpleDateFormat badYearAndDay

Parse YYDDD dates.

maskFormatter

protected MaskFormatter maskFormatter

datePattern

protected String datePattern

maskPattern

protected String maskPattern

placeholder

protected char placeholder

darkGreen

protected Color darkGreen

dateUtil

protected com.toedter.calendar.DateUtil dateUtil

isMaskVisible

private boolean isMaskVisible

ignoreDatePatternChange

private boolean ignoreDatePatternChange

hours

private int hours

minutes

private int minutes

seconds

private int seconds

millis

private int millis

calendar

private Calendar calendar

Constructor Detail

JCalendarDateEditor

public JCalendarDateEditor()

JCalendarDateEditor

public JCalendarDateEditor(String datePattern,
                           String maskPattern,
                           char placeholder)

JCalendarDateEditor

public JCalendarDateEditor(boolean showMask,
                           String datePattern,
                           String maskPattern,
                           char placeholder)

Method Detail

getDate

public Date getDate()

Specified by:

getDate in interface com.toedter.calendar.IDateEditor

setDate

public void setDate(Date date)

Specified by:

setDate in interface com.toedter.calendar.IDateEditor

setDate

protected void setDate(Date date,
                       boolean firePropertyChange)

Sets the date.

Parameters:

date - the date

firePropertyChange - true, if the date property should be fired.

setDateFormatString

public void setDateFormatString(String dateFormatString)

Specified by:

setDateFormatString in interface com.toedter.calendar.IDateEditor

getDateFormatString

public String getDateFormatString()

Specified by:

getDateFormatString in interface com.toedter.calendar.IDateEditor

getUiComponent

public JComponent getUiComponent()

Specified by:

getUiComponent in interface com.toedter.calendar.IDateEditor

attemptParsing

private Date attemptParsing(String text)

caretUpdate

public void caretUpdate(CaretEvent event)

After any user input, the value of the textfield is proofed. Depending on being a valid date, the value is colored green or red.

Specified by:

caretUpdate in interface CaretListener

Parameters:

event - Caret event.

focusLost

public void focusLost(FocusEvent focusEvent)

Specified by:

focusLost in interface FocusListener

checkText

private void checkText()

focusGained

public void focusGained(FocusEvent e)

Specified by:

focusGained in interface FocusListener

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface com.toedter.calendar.IDateEditor

Overrides:

setLocale in class Component

createMaskFromDatePattern

public String createMaskFromDatePattern(String datePattern)

Creates a mask from a date pattern. This is a very simple (and incomplete) implementation thet works only with numbers. A date pattern of "MM/dd/yy" will result in the mask "##/##/##". Probably you want to override this method if it does not fit your needs.

Parameters:

datePattern - Date pattern.

Returns:

the mask

isMaskVisible

public boolean isMaskVisible()

Returns true, if the mask is visible.

Returns:

true, if the mask is visible.

setMaskVisible

public void setMaskVisible(boolean isMaskVisible)

Sets the mask visible.

Parameters:

isMaskVisible - Whether or not the mask should be visible.

getPreferredSize

public Dimension getPreferredSize()

Returns the preferred size. If a date pattern is set, it is the size the date pattern would take.

Overrides:

getPreferredSize in class JTextField

actionPerformed

public void actionPerformed(ActionEvent e)

Validates the typed date and sets it (only if it is valid).

Specified by:

actionPerformed in interface ActionListener

setEnabled

public void setEnabled(boolean b)

Enables and disabled the compoment. It also fixes the background bug 4991597 and sets the background explicitely to a TextField.inactiveBackground.

Specified by:

setEnabled in interface com.toedter.calendar.IDateEditor

Overrides:

setEnabled in class JComponent

getMaxSelectableDate

public Date getMaxSelectableDate()

Specified by:

getMaxSelectableDate in interface com.toedter.calendar.IDateEditor

getMinSelectableDate

public Date getMinSelectableDate()

Specified by:

getMinSelectableDate in interface com.toedter.calendar.IDateEditor

setMaxSelectableDate

public void setMaxSelectableDate(Date max)

Specified by:

setMaxSelectableDate in interface com.toedter.calendar.IDateEditor

setMinSelectableDate

public void setMinSelectableDate(Date min)

Specified by:

setMinSelectableDate in interface com.toedter.calendar.IDateEditor

setSelectableDateRange

public void setSelectableDateRange(Date min,
                                   Date max)

Specified by:

setSelectableDateRange in interface com.toedter.calendar.IDateEditor