Class CalendarPane
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- com.michaelbaranov.microba.common.MicrobaComponent
-
- com.michaelbaranov.microba.calendar.CalendarPane
-
- All Implemented Interfaces:
CalendarColors,java.awt.image.ImageObserver,java.awt.MenuContainer,java.io.Serializable
- Direct Known Subclasses:
DatePicker
public class CalendarPane extends MicrobaComponent implements CalendarColors
A concrete implementation of JComponent. Capable of displaying and selecting dates, much like a real-world calendar.- Author:
- Michael Baranov
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringPROPERTY_NAME_DATEThe name of a "date" property.static java.lang.StringPROPERTY_NAME_FOCUS_LOST_BEHAVIORThe name of a "focusLocatBehavior" property.static java.lang.StringPROPERTY_NAME_HOLIDAY_POLICYThe name of a "holidayPolicy" property.static java.lang.StringPROPERTY_NAME_LOCALEThe name of a "locale" property.static java.lang.StringPROPERTY_NAME_RESOURCESThe name of a "resources" property.static java.lang.StringPROPERTY_NAME_SHOW_NONE_BTNThe name of a "showNoneButton" property.static java.lang.StringPROPERTY_NAME_SHOW_NUMBER_WEEKThe name of a "resources" property.static java.lang.StringPROPERTY_NAME_SHOW_TODAY_BTNThe name of a "showTodayButton" property.static java.lang.StringPROPERTY_NAME_STRIP_TIMEThe name of a "stripTime" property.static java.lang.StringPROPERTY_NAME_STYLEThe name of a "style" property.static java.lang.StringPROPERTY_NAME_VETO_POLICYThe name of a "vetoPolicy" property.static java.lang.StringPROPERTY_NAME_ZONEThe name of a "zone" property.static intSTYLE_CLASSICA constant for the "style" property.static intSTYLE_MODERNA constant for the "style" property.-
Fields inherited from class com.michaelbaranov.microba.common.MicrobaComponent
PROPERTY_NAME_COLOR_OVERRIDE_MAP
-
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 com.michaelbaranov.microba.calendar.CalendarColors
COLOR_CALENDAR_GRID_BACKGROUND_DISABLED, COLOR_CALENDAR_GRID_BACKGROUND_ENABLED, COLOR_CALENDAR_GRID_FOCUS, COLOR_CALENDAR_GRID_FOREGROUND_DISABLED, COLOR_CALENDAR_GRID_FOREGROUND_ENABLED, COLOR_CALENDAR_GRID_HOLIDAY_FOREGROUND_DISABLED, COLOR_CALENDAR_GRID_HOLIDAY_FOREGROUND_ENABLED, COLOR_CALENDAR_GRID_RESTRICTED, COLOR_CALENDAR_GRID_SELECTION_BACKGROUND_DISABLED, COLOR_CALENDAR_GRID_SELECTION_BACKGROUND_ENABLED, COLOR_CALENDAR_GRID_WEEKEND_FOREGROUND_DISABLED, COLOR_CALENDAR_GRID_WEEKEND_FOREGROUND_ENABLED, COLOR_CALENDAR_HEADER_BACKGROUND_DISABLED, COLOR_CALENDAR_HEADER_BACKGROUND_ENABLED, COLOR_CALENDAR_HEADER_FOREGROUND_DISABLED, COLOR_CALENDAR_HEADER_FOREGROUND_ENABLED, COLOR_CALENDAR_HEADER_FOREGROUND_WEEKEND_DISABLED, COLOR_CALENDAR_HEADER_FOREGROUND_WEEKEND_ENABLED
-
-
Constructor Summary
Constructors Constructor Description CalendarPane()Constructor.CalendarPane(int style)Constructor.CalendarPane(java.util.Date initialDate)Constructor.CalendarPane(java.util.Date initialDate, int style)Constructor.CalendarPane(java.util.Date initialDate, int style, java.util.Locale locale)Constructor.CalendarPane(java.util.Date initialDate, int style, java.util.Locale locale, java.util.TimeZone zone)Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddActionListener(java.awt.event.ActionListener listener)Adds anActionListenerlistener.voidaddCommitListener(CommitListener listener)Adds anCommitListenerlistener.booleancommitEdit()Forces the control to commit current user's edit.voidcommitOrRevert()Forces the control to commit or revert user's edit depending on the current focus lost behavior as if the focus would be lost.voidfireActionEvent()Fires aActionEventto all registered listeners.voidfireCommitEvent(boolean commit)Fires aCommitEventto all registered listeners.java.util.DategetDate()Returns currently selected date in the control.intgetFocusLostBehavior()Returns the focus lost behavior.HolidayPolicygetHolidayPolicy()Returns current holliday policy (model).java.util.LocalegetLocale()Returns current locale.CalendarResourcesgetResources()Resurns current calendar resources model.intgetStyle()Returns current visual style of the control.java.lang.StringgetUIClassID()VetoPolicygetVetoPolicy()Returns the current veto policy (model).java.util.TimeZonegetZone()Returns current time zone.booleanisShowNoneButton()Is the none-button visible?booleanisShowNumberOfWeek()Is the number of every week visible?booleanisShowTodayButton()Is today button visible?booleanisStripTime()Is time protion of the date automatically striped, based on current locale and ime zone?voidobserveMonth(int year, int month)Makes the widget display given month within given year without actually changing selected date.voidremoveActionListener(java.awt.event.ActionListener listener)Removes anActionListenerlistener.voidremoveCommitListener(CommitListener listener)Removes anCommitListenerlistener.voidrevertEdit()Forces the control to revert current user's edit to reflect current control's date.voidsetDate(java.util.Date date)Sets currently selected date to the control.voidsetFocusLostBehavior(int behavior)Sets the focus lost behaviour.voidsetHolidayPolicy(HolidayPolicy holidayPolicy)Sets current holliday policy (model) then updates the control to reflect the policy set.voidsetLocale(java.util.Locale locale)Sets current locale.voidsetResources(CalendarResources resources)Sets current calendar resources model.voidsetShowNoneButton(boolean visible)Shows or hides the none-button.voidsetShowNumberOfWeek(boolean visible)Shows or hides the the number of every week.voidsetShowTodayButton(boolean visible)Shows or hides the today-button.voidsetStripTime(boolean stripTime)MakesgetDate()either strip the time portion of the date, or keep it.voidsetStyle(int style)Sets the current visual style of the control.voidsetVetoPolicy(VetoPolicy vetoModel)Sets the current veto policy (model).voidsetZone(java.util.TimeZone zone)Sets current time zone.static java.util.DatestripTime(java.util.Date date, java.util.TimeZone zone, java.util.Locale locale)Returns same date as given, but time portion (hours, minutes, seconds, fraction of second) set to zero, based on given locale and time zone.-
Methods inherited from class com.michaelbaranov.microba.common.MicrobaComponent
getColorOverrideMap, getUI, setColorOverrideMap, updateUI
-
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, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, 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, setLayout, 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, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Field Detail
-
PROPERTY_NAME_DATE
public static final java.lang.String PROPERTY_NAME_DATE
The name of a "date" property.- See Also:
- Constant Field Values
-
PROPERTY_NAME_LOCALE
public static final java.lang.String PROPERTY_NAME_LOCALE
The name of a "locale" property.- See Also:
- Constant Field Values
-
PROPERTY_NAME_ZONE
public static final java.lang.String PROPERTY_NAME_ZONE
The name of a "zone" property.- See Also:
- Constant Field Values
-
PROPERTY_NAME_STYLE
public static final java.lang.String PROPERTY_NAME_STYLE
The name of a "style" property.- See Also:
- Constant Field Values
-
PROPERTY_NAME_SHOW_TODAY_BTN
public static final java.lang.String PROPERTY_NAME_SHOW_TODAY_BTN
The name of a "showTodayButton" property.- See Also:
- Constant Field Values
-
PROPERTY_NAME_SHOW_NONE_BTN
public static final java.lang.String PROPERTY_NAME_SHOW_NONE_BTN
The name of a "showNoneButton" property.- See Also:
- Constant Field Values
-
PROPERTY_NAME_FOCUS_LOST_BEHAVIOR
public static final java.lang.String PROPERTY_NAME_FOCUS_LOST_BEHAVIOR
The name of a "focusLocatBehavior" property.- See Also:
- Constant Field Values
-
PROPERTY_NAME_VETO_POLICY
public static final java.lang.String PROPERTY_NAME_VETO_POLICY
The name of a "vetoPolicy" property.- See Also:
- Constant Field Values
-
PROPERTY_NAME_HOLIDAY_POLICY
public static final java.lang.String PROPERTY_NAME_HOLIDAY_POLICY
The name of a "holidayPolicy" property.- See Also:
- Constant Field Values
-
PROPERTY_NAME_RESOURCES
public static final java.lang.String PROPERTY_NAME_RESOURCES
The name of a "resources" property.- See Also:
- Constant Field Values
-
PROPERTY_NAME_SHOW_NUMBER_WEEK
public static final java.lang.String PROPERTY_NAME_SHOW_NUMBER_WEEK
The name of a "resources" property.- See Also:
- Constant Field Values
-
PROPERTY_NAME_STRIP_TIME
public static final java.lang.String PROPERTY_NAME_STRIP_TIME
The name of a "stripTime" property.- See Also:
- Constant Field Values
-
STYLE_MODERN
public static final int STYLE_MODERN
A constant for the "style" property.- See Also:
- Constant Field Values
-
STYLE_CLASSIC
public static final int STYLE_CLASSIC
A constant for the "style" property.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CalendarPane
public CalendarPane()
Constructor.
-
CalendarPane
public CalendarPane(int style)
Constructor.
-
CalendarPane
public CalendarPane(java.util.Date initialDate)
Constructor.
-
CalendarPane
public CalendarPane(java.util.Date initialDate, int style)Constructor.
-
CalendarPane
public CalendarPane(java.util.Date initialDate, int style, java.util.Locale locale)Constructor.
-
CalendarPane
public CalendarPane(java.util.Date initialDate, int style, java.util.Locale locale, java.util.TimeZone zone)Constructor.
-
-
Method Detail
-
getUIClassID
public java.lang.String getUIClassID()
- Overrides:
getUIClassIDin classjavax.swing.JComponent
-
getDate
public java.util.Date getDate()
Returns currently selected date in the control.The returned date is guaranteed to pass the restriction check by the current
VetoPolicy. Based on the value ofstripTimeproperty, the returned date may be automatically stripped.- Returns:
- currently selected date
- See Also:
stripTime,stripTime(Date, TimeZone, Locale)
-
setDate
public void setDate(java.util.Date date) throws java.beans.PropertyVetoExceptionSets currently selected date to the control.The given date is checked against the current
VetoPolicy. If the check is passed, the date is transferred to the control and the control is updated to display the date.A
PropertyChangeEventmay be fired, anActionEventmay be fired.- Parameters:
date- the date to set- Throws:
java.beans.PropertyVetoException- if the date is restricted by the currentVetoPolicy.- See Also:
getVetoPolicy(),setVetoPolicy(VetoPolicy),addActionListener(ActionListener)
-
getLocale
public java.util.Locale getLocale()
Returns current locale.- Overrides:
getLocalein classjava.awt.Component- Returns:
- current locale
-
setLocale
public void setLocale(java.util.Locale locale)
Sets current locale.The locale is used to construct internal
Calendarinstances and affects visual representation of the control.- Overrides:
setLocalein classjava.awt.Component- Parameters:
locale- the locale to set
-
getZone
public java.util.TimeZone getZone()
Returns current time zone.- Returns:
- current time zone
-
setZone
public void setZone(java.util.TimeZone zone)
Sets current time zone.The time zone is used to construct internal
Calendarinstances and affects visual representation of the control. The dates returned bygetDate()will have all time components set to zero considering the current locale.- Parameters:
zone- the time zone to set
-
getStyle
public int getStyle()
Returns current visual style of the control.- Returns:
- current visual style constant.
-
setStyle
public void setStyle(int style)
Sets the current visual style of the control.The control is then updated to reflect the new style.
- Parameters:
style- the style to set- See Also:
STYLE_CLASSIC,STYLE_MODERN
-
isShowTodayButton
public boolean isShowTodayButton()
Is today button visible?The today button allows the user to quickly select current date.
- Returns:
trueif the today button is visible,falseotherwise
-
setShowTodayButton
public void setShowTodayButton(boolean visible)
Shows or hides the today-button.The today-button allows the user to quickly select current date.
- Parameters:
visible-trueto show the today-buttonfalseto hide
-
isShowNoneButton
public boolean isShowNoneButton()
Is the none-button visible?The none-button allows the user to select empty date (null-date, no date).
- Returns:
trueif the none-button is visible,falseotherwise
-
setShowNoneButton
public void setShowNoneButton(boolean visible)
Shows or hides the none-button.The none-button allows the user to select empty date (null-date, no date).
- Parameters:
visible-trueto show the none-buttonfalseto hide
-
getFocusLostBehavior
public int getFocusLostBehavior()
Returns the focus lost behavior. Possible values are:JFormattedTextField.COMMITJFormattedTextField.COMMIT_OR_REVERTJFormattedTextField.REVERTJFormattedTextField.PERSIST
- Returns:
- the focus lost behavior constant
- See Also:
JFormattedTextField
-
setFocusLostBehavior
public void setFocusLostBehavior(int behavior)
Sets the focus lost behaviour. Possible values are:JFormattedTextField.COMMITJFormattedTextField.COMMIT_OR_REVERTJFormattedTextField.REVERTJFormattedTextField.PERSIST
- Parameters:
behavior- the focus lost behavior constant- See Also:
JFormattedTextField
-
getResources
public CalendarResources getResources()
Resurns current calendar resources model.The model is used to query localized resources for the control.
- Returns:
- current calendar resources model
- See Also:
CalendarResources
-
setResources
public void setResources(CalendarResources resources)
Sets current calendar resources model.The model is used to query localized resources for the control.
- Parameters:
resources- a calendar resources model to set. Should not benull- See Also:
CalendarResources
-
getHolidayPolicy
public HolidayPolicy getHolidayPolicy()
Returns current holliday policy (model).The policy is used to query holliday dates and holliday descriptions.
- Returns:
- current holliday policy or
nullif none set - See Also:
HolidayPolicy
-
setHolidayPolicy
public void setHolidayPolicy(HolidayPolicy holidayPolicy)
Sets current holliday policy (model) then updates the control to reflect the policy set.The policy is used to query holliday dates and holiday descriptions.
- Parameters:
holidayPolicy- a holliday policy to set. May benull- See Also:
VetoPolicy
-
getVetoPolicy
public VetoPolicy getVetoPolicy()
Returns the current veto policy (model).The policy is used to veto dates in the control.
- Returns:
- current veto policy or
nullif none set - See Also:
VetoPolicy
-
setVetoPolicy
public void setVetoPolicy(VetoPolicy vetoModel)
Sets the current veto policy (model).The policy is used to veto dates in the control.
- Parameters:
vetoModel- a veto policy to set. May benull
-
isShowNumberOfWeek
public boolean isShowNumberOfWeek()
Is the number of every week visible?- Returns:
trueif the number of every week is visible,falseotherwise
-
isStripTime
public boolean isStripTime()
Is time protion of the date automatically striped, based on current locale and ime zone?- Returns:
trueifgetDate()returns a stripped date,falseotherwise- See Also:
setStripTime(boolean),stripTime(Date, TimeZone, Locale)
-
setStripTime
public void setStripTime(boolean stripTime)
MakesgetDate()either strip the time portion of the date, or keep it.- Parameters:
stripTime-trueto strip time,falseto keep time
-
setShowNumberOfWeek
public void setShowNumberOfWeek(boolean visible)
Shows or hides the the number of every week.The number of week is based on the current locale for the component.
- Parameters:
visible-trueto show the the number of every weekfalseto hide
-
addActionListener
public void addActionListener(java.awt.event.ActionListener listener)
Adds anActionListenerlistener.- Parameters:
listener- a listener to add- See Also:
ActionListener
-
removeActionListener
public void removeActionListener(java.awt.event.ActionListener listener)
Removes anActionListenerlistener.- Parameters:
listener- a listener to remove- See Also:
ActionListener
-
addCommitListener
public void addCommitListener(CommitListener listener)
Adds anCommitListenerlistener.- Parameters:
listener- a listener to add- See Also:
CommitListener
-
removeCommitListener
public void removeCommitListener(CommitListener listener)
Removes anCommitListenerlistener.- Parameters:
listener- a listener to remove- See Also:
CommitListener
-
commitEdit
public boolean commitEdit()
Forces the control to commit current user's edit. The opertaion may fail because the date in the control may be restricted by current veto policy. If successfull, the current date of the control may change, aCommitEventis fired.- Returns:
trueif successful,falseotherwise- See Also:
revertEdit(),getFocusLostBehavior(),setFocusLostBehavior(int)
-
revertEdit
public void revertEdit()
Forces the control to revert current user's edit to reflect current control's date. The current date of the control may change, aCommitEventis fired.
-
commitOrRevert
public void commitOrRevert()
Forces the control to commit or revert user's edit depending on the current focus lost behavior as if the focus would be lost.
-
fireCommitEvent
public void fireCommitEvent(boolean commit)
Fires aCommitEventto all registered listeners.- Parameters:
commit-trueto indicate commit,falseto indicate revert- See Also:
CommitEvent,CommitListener
-
fireActionEvent
public void fireActionEvent()
Fires aActionEventto all registered listeners.- See Also:
ActionEvent,ActionListener
-
stripTime
public static java.util.Date stripTime(java.util.Date date, java.util.TimeZone zone, java.util.Locale locale)Returns same date as given, but time portion (hours, minutes, seconds, fraction of second) set to zero, based on given locale and time zone. Utility method.Examle:
Fri Sep 29 15:57:23 EEST 2006 -> Fri Sep 29 00:00:00 EEST 2006- Parameters:
date- date to strip time fromzone- time zone to get zero fields inlocale- locale to base the calendar on- Returns:
- stripped date
-
observeMonth
public void observeMonth(int year, int month)Makes the widget display given month within given year without actually changing selected date.- Parameters:
year- year to showmonth- month within the year to show
-
-