net.sourceforge.jdatebutton.swing

Class JDateButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JButton

net.sourceforge.jdatebutton.swing.JDateButton

All Implemented Interfaces:

ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants, JDateBaseButton

public class JDateButton
extends JButton
implements JDateBaseButton

Provides a button which displays the currently selected LocalDate.

When clicked the button displays a mode-less JDateDialog enabling date selection This dialog will be closed if focus is lost or escape is pressed

An underlying JDateConfig is used to control locale, format and select-able range, and to directly set the selected date. Changes to the selected date are reported via a PropertyChangeEvent for the PROPERTY_DATE property, and may be monitored by attaching a PropertyChangeListener

Author:

Tony Washer

See Also:

Serialized Form

Nested Class Summary

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

JComponent.AccessibleJComponent

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

Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
static int	PREFERRED_HEIGHT Preferred Height.
static int	PREFERRED_WIDTH Preferred Width.
static String	PROPERTY_DATE Name of the Date property.

Fields inherited from class javax.swing.AbstractButton

BORDER_PAINTED_CHANGED_PROPERTY, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, 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 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
JDateButton() Constructor.
JDateButton(JDateConfig pConfig) Constructor for extension classes.
JDateButton(JDateFormatter pFormatter) Constructor.

Method Summary

Modifier and Type	Method and Description
JDateConfig	getDateConfig() Obtain Date Configuration.
JDateDialog	getDialog() Obtain the dialog.
LocalDate	getSelectedDate() Obtain SelectedDate.
void	reBuildNames() Rebuild names.
void	refreshText() Refresh the text.
void	setAllowNullDateSelection(boolean pAllowNullDateSelection) Allow null date selection.
void	setEarliestDate(LocalDate pEarliest) Set the earliest date.
void	setFormat(String pFormat) Set the date format.
void	setFormatter(JDateFormatter pFormatter) Set formatter.
void	setLatestDate(LocalDate pLatest) Set the latest date.
void	setLocale(Locale pLocale)
void	setSelectedDate(LocalDate pDate) Set SelectedDate.

Methods inherited from class javax.swing.JButton

getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, removeNotify, setDefaultCapable, updateUI

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addItemListener, doClick, doClick, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, 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, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_DATE

public static final String PROPERTY_DATE

Name of the Date property.

See Also:

Constant Field Values

PREFERRED_WIDTH

public static final int PREFERRED_WIDTH

Preferred Width.

See Also:

Constant Field Values

PREFERRED_HEIGHT

public static final int PREFERRED_HEIGHT

Preferred Height.

See Also:

Constant Field Values

Constructor Detail

JDateButton

public JDateButton()

Constructor.

JDateButton

public JDateButton(JDateFormatter pFormatter)

Constructor.

Parameters:

pFormatter - the Date formatter

JDateButton

public JDateButton(JDateConfig pConfig)

Constructor for extension classes.

Parameters:

pConfig - the configuration to use

Method Detail

getDateConfig

public JDateConfig getDateConfig()

Description copied from interface: JDateBaseButton

Obtain Date Configuration.

Specified by:

getDateConfig in interface JDateBaseButton

Returns:

the date configuration

getDialog

public JDateDialog getDialog()

Obtain the dialog.

Returns:

the dialog

getSelectedDate

public LocalDate getSelectedDate()

Obtain SelectedDate.

Returns:

the selected date

setSelectedDate

public void setSelectedDate(LocalDate pDate)

Set SelectedDate.

Parameters:

pDate - the selected date

setLocale

public void setLocale(Locale pLocale)

Overrides:

setLocale in class Component

setFormat

public void setFormat(String pFormat)

Set the date format.

Parameters:

pFormat - the format string

setFormatter

public void setFormatter(JDateFormatter pFormatter)

Set formatter.

Parameters:

pFormatter - the formatter

setEarliestDate

public void setEarliestDate(LocalDate pEarliest)

Set the earliest date. This is the earliest date that may be selected. If the configured latest date is earlier than this date, it will be set to this date to ensure a valid range.

Parameters:

pEarliest - the Earliest select-able date (or null if unlimited)

setLatestDate

public void setLatestDate(LocalDate pLatest)

Set the latest date. This is the latest date that may be selected. If the configured earliest date is later than this date, it will be set to this date to ensure a valid range.

Parameters:

pLatest - the Latest select-able date (or null if unlimited)

setAllowNullDateSelection

public void setAllowNullDateSelection(boolean pAllowNullDateSelection)

Allow null date selection. If this flag is set an additional button will be displayed allowing the user to explicitly select no date, thus setting the SelectedDate to null.

Parameters:

pAllowNullDateSelection - true/false

refreshText

public void refreshText()

Description copied from interface: JDateBaseButton

Refresh the text.

Specified by:

refreshText in interface JDateBaseButton

reBuildNames

public void reBuildNames()

Description copied from interface: JDateBaseButton

Rebuild names.

Specified by:

reBuildNames in interface JDateBaseButton