com.standbysoft.component.date.swing
Class JMonthView

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.standbysoft.component.date.swing.JDateComponent
                  com.standbysoft.component.date.swing.JMonth
                      com.standbysoft.component.date.swing.JMonthView

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class JMonthView

extends JMonth

A multiple-month calendar that enables users to view and select dates by means of an intuitive interface. You can find task-oriented documentation and examples of using calendars in Using the JMonthView Component, a section in The JDatePicker Suite Tutorial.

Months can be arranged on rows and columns and can be scrolled using the month-scrolling buttons. One can specify the number of months to be scrolled when the buttons are clicked.

A great part of its properties are inherited from JMonth only that they apply to all the months from the calendar. For instance, you can hide week numbers:

 	JMonthView calendar = new JMonthView();
 	calendar.setColumns(3);
 	calendar.setWeekNumbersVisible(false);
 

JMonth has a detailed description of its API. In addition, this component adds a status bar that contains the today and none buttons.

The default UI delegate used by this component is DefaultMonthViewUI. When using this delegate, the component can be configured with some client properties that improve its behavior.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class com.standbysoft.component.date.swing.JDateComponent

JDateComponent.DateAction, JDateComponent.RollDateAction, JDateComponent.SelectFirstDayAction, JDateComponent.SelectLastDayAction, JDateComponent.SelectNoneAction, JDateComponent.SelectTodayAction

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected int	columns Specifies the number of columns used to arrange months of the calendar.
protected boolean	noneButtonVisible Specifies whether the none button is displayed.
protected int	rows Specifies the number of rows used to arrange months of the calendar.
protected int	scrollingDelta Specifies the number of months to scroll.
protected boolean	statusVisible Specifies whether the status bar that contains the today and none buttons is displayed.
protected boolean	todayButtonVisible Specifies whether the today button is displayed.

Fields inherited from class com.standbysoft.component.date.swing.JMonth

AUTOUPDATE_MILLISECONDS_24H, autoUpdateTodayEnabled, DATE_COMMAND, datesOrientation, gridColor, horizontalLinesVisible, monthBackground, monthModel, monthModelListener, renderer, titleBackground, titleForeground, toggleDateSelectionEnabled, trailingForeground, trailingNextEnabled, trailingPreviousEnabled, verticalLinesVisible, weekModel, weekModelListener, weekNamesVisible, weekNumbersVisible

Fields inherited from class com.standbysoft.component.date.swing.JDateComponent

actionCommand, calendar, dateSelectionModel, dateSelectionModelListener, locale, selectFirstDayAction, selectLastDayAction, selectNextDayAction, selectNoneAction, selectPreviousDayAction, selectSameDayNextMonthAction, selectSameDayNextWeekAction, selectSameDayNextYearAction, selectSameDayPreviousMonthAction, selectSameDayPreviousWeekAction, selectSameDayPreviousYearAction, selectTodayAction, timeZone

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

JMonthView()
Creates a default month view.

Method Summary

int	getColumns() Returns the number of columns used to arrange the months of this calendar.
int	getRows() Returns the number of rows used to arrange the months of this calendar.
int	getScrollingDelta() Returns the number of months to scroll.
java.lang.String	getUIClassID() Returns the name of the L&F class that renders this component.
boolean	isNoneButtonVisible() Determines whether the button that deselects all selected dates is shown.
boolean	isStatusVisible() Determines whether the status line is visible or not.
boolean	isTodayButtonVisible() Determines whether the button that displays and selects the today date is shown.
void	scrollDateToVisible(java.util.Date date) Scrolls this month view to make the specified date visible.
void	setColumns(int columns) Specifies the number of columns used to arrange the months of this calendar.
void	setNoneButtonVisible(boolean show) Specifies whether the none button is displayed.
void	setRows(int rows) Specifies the number of rows used to arrange the months of this calendar.
void	setScrollingDelta(int scrollingDelta) Specifies the number of months to scroll when the scrolling buttons are used.
void	setStatusVisible(boolean visible) Specifies whether the status line where the today and none buttons are displayed is visible or not.
void	setTodayButtonVisible(boolean show) Specifies whether the today button is displayed.

Methods inherited from class com.standbysoft.component.date.swing.JMonth

addMonthModelListener, addWeekModelListener, fireDowChanged, fireDowFirstChanged, fireDowNamesChanged, fireMonthChanged, fireMonthNamesChanged, fireTodayChanged, fireWeekChanged, fireWeekNumbersChanged, getDateRenderer, getDatesOrientation, getDowFirst, getGridColor, getMonth, getMonthBackground, getMonthModel, getSelectedDates, getSelectionMode, getTitleBackground, getTitleForeground, getTrailingForeground, getWeekModel, getYear, isAutoUpdateToday, isDowSelectionAllowed, isHorizontalLinesVisible, isToggleDateSelectionEnabled, isTrailingNextEnabled, isTrailingPreviousEnabled, isVerticalLinesVisible, isWeekNamesVisible, isWeekNumbersVisible, isWeekSelectionAllowed, removeMonthModelListener, removeWeekModelListener, requestFocus, setAutoUpdateToday, setDateRenderer, setDatesOrientation, setDowFirst, setDowSelectionAllowed, setGridColor, setHorizontalLinesVisible, setLocale, setMonth, setMonth, setMonthBackground, setMonthModel, setSelectedDates, setSelectionMode, setTimeZone, setTitleBackground, setTitleForeground, setToggleDateSelectionEnabled, setTrailingForeground, setTrailingNextEnabled, setTrailingPreviousEnabled, setVerticalLinesVisible, setWeekModel, setWeekNamesVisible, setWeekNumbersVisible, setWeekSelectionAllowed, setYear

Methods inherited from class com.standbysoft.component.date.swing.JDateComponent

addActionListener, addDateSelectionListener, fireActionEvent, fireDateSelectionChanged, fireDisabledDatesChanged, fireDisabledDateSelectionAttempted, fireEmptySelectionAllowedChanged, fireSelectionModeChanged, getActionCommand, getCalendar, getDateSelectionModel, getLocale, getSelectedDate, getTimeZone, getUI, isEmptySelectionAllowed, removeActionListener, removeDateSelectionListener, setActionCommand, setDateSelectionModel, setEmptySelectionAllowed, setSelectedDate, 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, getAccessibleContext, 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, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, 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, 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

todayButtonVisible

protected boolean todayButtonVisible

Specifies whether the today button is displayed.

noneButtonVisible

protected boolean noneButtonVisible

Specifies whether the none button is displayed.

statusVisible

protected boolean statusVisible

Specifies whether the status bar that contains the today and none buttons is displayed.

rows

protected int rows

Specifies the number of rows used to arrange months of the calendar.

columns

protected int columns

Specifies the number of columns used to arrange months of the calendar.

scrollingDelta

protected int scrollingDelta

Specifies the number of months to scroll.

Constructor Detail

JMonthView

public JMonthView()

Creates a default month view.

Method Detail

scrollDateToVisible

public void scrollDateToVisible(java.util.Date date)

Scrolls this month view to make the specified date visible. If the date is already visible, nothing happens.

See Also:

JMonth.setMonth(int, int)

getColumns

public int getColumns()

Returns the number of columns used to arrange the months of this calendar.

Returns:

number of columns used to arrange the months of this calendar.

setColumns

public void setColumns(int columns)
                throws java.lang.IllegalArgumentException

Specifies the number of columns used to arrange the months of this calendar. The total number of months displayed by this calendar is given by rows * columns.

Parameters:

columns - number of columns (must be >= 1)

Throws:

java.lang.IllegalArgumentException - if specified number of columns is less than 1

See Also:

setRows(int)

getRows

public int getRows()

Returns the number of rows used to arrange the months of this calendar.

Returns:

number of rows used to arrange the months of this calendar.

setRows

public void setRows(int rows)
             throws java.lang.IllegalArgumentException

Specifies the number of rows used to arrange the months of this calendar. The total number of months displayed by this calendar is given by rows * columns.

Parameters:

rows - number of rows (must be >= 1)

Throws:

java.lang.IllegalArgumentException - if specified number of rows is less than 1

See Also:

setColumns(int)

getScrollingDelta

public int getScrollingDelta()

Returns the number of months to scroll. Scrolling the months is usually done using the month scrolling buttons.

Returns:

number of months to scroll. By default it returns 1.

See Also:

setScrollingDelta(int)

setScrollingDelta

public void setScrollingDelta(int scrollingDelta)

Specifies the number of months to scroll when the scrolling buttons are used.

Parameters:

scrollingDelta - number of months to scroll

isTodayButtonVisible

public boolean isTodayButtonVisible()

Determines whether the button that displays and selects the today date is shown.

Returns:

true if the today button is displayed; false otherwise.

setTodayButtonVisible

public void setTodayButtonVisible(boolean show)

Specifies whether the today button is displayed.

Parameters:

show - true if it should be displayed; false otherwise.

See Also:

isTodayButtonVisible()

isNoneButtonVisible

public boolean isNoneButtonVisible()

Determines whether the button that deselects all selected dates is shown.

Returns:

true if the none button is displayed; false otherwise.

setNoneButtonVisible

public void setNoneButtonVisible(boolean show)

Specifies whether the none button is displayed.

Parameters:

show - true if it should be displayed; false otherwise.

See Also:

isNoneButtonVisible()

isStatusVisible

public boolean isStatusVisible()

Determines whether the status line is visible or not.

Returns:

true if the status line is visible or false otherwise.

See Also:

setStatusVisible(boolean)

setStatusVisible

public void setStatusVisible(boolean visible)

Specifies whether the status line where the today and none buttons are displayed is visible or not.

Parameters:

visible - visibility of the status line

getUIClassID

public java.lang.String getUIClassID()

Returns the name of the L&F class that renders this component.

Overrides:

getUIClassID in class JMonth

Returns:

the string "MonthViewUI"