org.jdesktop.swingx.plaf.basic
Class BasicMonthViewUI

java.lang.Object
  javax.swing.plaf.ComponentUI
      org.jdesktop.swingx.plaf.MonthViewUI
          org.jdesktop.swingx.plaf.basic.BasicMonthViewUI

public class BasicMonthViewUI
extends MonthViewUI

Base implementation of the JXMonthView UI.

Note: The api changed considerably between releases 0.9.1 and 0.9.2. Most of the old methods are still available but deprecated. It's strongly recommended to update subclasses soon, because those methods will be removed before 0.9.3.

The general drift of the change was

• replace all methods which take/return a date in millis with equivalents taking/returning a Date object
• streamline the painting (to make it understandable for me ;-) See below.
• pass-around a calendar object to all painting methods. The general contract is that methods which receive the calendar must not change it in any way. It's up to the calling method to loop through the dates if appropriate.

Painting: defined coordinate systems.

• Screen coordinates of months/days, accessible via the getXXBounds() methods. These coordinates are absolute in the system of the monthView.
• The grid of visible months with logical row/column coordinates. The logical coordinates are adjusted to ComponentOrientation.
• The grid of days in a month with logical row/column coordinates. The logical coordinates are adjusted to ComponentOrientation. The columns are the days of the week, the rows are the weeks in a month. The column header shows the localized names of the days and has the row coordinate -1. It is shown always. The row header shows the week number in the year and has the column coordinate -1. It is shown only if the showingWeekNumber property is true.

Field Summary

protected Rectangle	calendarGrid The bounding box of the grid of visible months.
protected SimpleDateFormat	dayOfMonthFormatter Formatter used to format the day of the week to a numerical value.
protected Font	derivedFont Used as the font for flagged days.
protected boolean	isLeftToRight
static int	MONTH_DOWN Return value used to identify when the month down button is pressed.
static int	MONTH_UP Return value used to identify when the month up button is pressed.
protected Icon	monthDownImage
protected String[]	monthsOfTheYear localized names of all months.
protected Icon	monthUpImage
protected JXMonthView	monthView the component we are installed for.

Constructor Summary

BasicMonthViewUI()

Method Summary

protected Font	createDerivedFont() Create a derived font used to when painting various pieces of the month view component.
protected LayoutManager	createLayoutManager()
protected MouseListener	createMouseListener()
protected MouseMotionListener	createMouseMotionListener()
protected PropertyChangeListener	createPropertyChangeListener()
static ComponentUI	createUI(JComponent c)
protected Calendar	getCalendar() Returns the monthViews calendar configured to the firstDisplayedDate.
protected Calendar	getCalendar(Date date) Returns the monthViews calendar configured to the given time.
Date	getDayAtLocation(int x, int y) Returns the Date at the given location.
protected Rectangle	getDayBounds(Date date) Returns the bounds of the given day.
protected Rectangle	getDayBoundsAtLocation(int x, int y) Returns the bounds of the day in the grid of days which contains the given location.
protected Point	getDayGridPosition(Date date) Returns the given date's position in the grid of the month it is contained in.
protected Point	getDayGridPositionAtLocation(int x, int y) Returns the logical coordinates of the day which contains the given location.
protected Date	getDayInMonth(Date month, int row, int column) Returns the Date defined by the logical grid coordinates relative to the given month.
protected Dimension	getDaySize() Returns the size of a day including the padding.
String[]	getDaysOfTheWeek() Returns an array of String to use as names for the days of the week.
protected Date	getFirstDisplayedDay()
protected int	getFirstDisplayedMonth()
protected int	getFirstDisplayedYear()
Date	getLastDisplayedDay() Returns the last possible date that can be displayed.
protected Date	getMonth(int row, int column) Returns the Date representing the start of the month at the given logical position in the grid of months.
protected Date	getMonthAtLocation(int x, int y) Returns the Date representing the start of the month which contains the given location.
protected Rectangle	getMonthBounds(Date date) Returns the bounds of the month containing the given date.
protected Rectangle	getMonthBounds(int row, int column) Returns the bounds of the month at the given logical coordinates in the grid of visible months.
protected Rectangle	getMonthBoundsAtLocation(int x, int y) Returns the bounds of the month which contains the given location.
protected Point	getMonthGridPosition(Date date) Returns the logical grid position of the month containing the given date.
protected Point	getMonthGridPositionAtLocation(int x, int y) Returns the logical coordinates of the month which contains the given location.
protected Rectangle	getMonthHeaderBoundsAtLocation(int x, int y) Returns the bounds of the month header which contains the given location.
protected int	getMonthHeaderHeight() Returns the height of the month header.
protected Dimension	getMonthSize() Returns the size of a month.
protected SortedSet<Date>	getSelection()
protected Date	getToday()
protected int	getTraversableGridPositionAtLocation(int x, int y) Mapping pixel to bounds.
protected int	getWeeks(Calendar month) Returns the number of weeks to paint in the current month, as represented by the given calendar.
protected void	installComponents()
protected void	installDefaults()
protected void	installKeyboardActions()
protected void	installListeners()
void	installUI(JComponent c) Configures the specified component appropriate for the look and feel.
protected boolean	isToday(Date date) Returns true if the date passed in is the same as today.
boolean	isUsingKeyboard()
void	paint(Graphics g, JComponent c) Paints the specified component appropriate for the look and feel.
protected void	paintBackground(Rectangle clip, Graphics g)
protected void	paintDay(Graphics g, int left, int top, Calendar calendar) Paints a day the current month, represented by the calendar in a day-box located at left/top.
protected void	paintDayBackground(Graphics g, int x, int y, int width, int height, Calendar cal) Paint the background for the day specified by the given calendar.
protected void	paintDayForeground(Graphics g, int x, int y, int width, int height, Calendar cal) Paint the foreground for the specified day.
protected void	paintDayForeground(Graphics g, String numericDay, int x, int y, Calendar cal) Paints string of the day.
protected void	paintDayOfTheWeekBackground(Graphics g, int x, int y, int width, int height, Calendar cal)
protected void	paintDays(Graphics g, int left, int top, int width, Calendar cal) Paints all days in the days' grid, that is the month area below the daysOfWeek and to the right/left (depending on the monthView's componentOrientation) of the weekOfYears.
protected void	paintFlaggedDayBackground(Graphics g, int x, int y, int width, int height, Calendar cal) Paint the background for the specified flagged day.
protected void	paintFlaggedDayForeground(Graphics g, int x, int y, int width, int height, Calendar cal) Paint the foreground for the specified flagged day.
protected void	paintLeadingDay(Graphics g, int left, int top, Calendar calendar) Paints a leading day of the current month, represented by the calendar, in a day-box located at left/top.
protected void	paintLeadingDayBackground(Graphics g, int x, int y, int width, int height, Calendar cal) Paint the background for the specified leading day.
protected void	paintLeadingDayForeground(Graphics g, int x, int y, int width, int height, Calendar cal) Paint the foreground for the specified leading day.
protected void	paintMonth(Graphics g, int x, int y, int width, int height, Calendar calendar) Paints a month.
protected void	paintMonthStringBackground(Graphics g, int x, int y, int width, int height, Calendar cal) Paints the background of the month string.
protected void	paintMonthStringForeground(Graphics g, int x, int y, int width, int height, Calendar cal) Note: the given calendar must not be changed.
protected void	paintMonthStringForeground(Graphics g, String monthName, int monthX, int monthY, String yearName, int yearX, int yearY, Calendar cal) Paints only text for month and year.
protected void	paintTrailingDay(Graphics g, int left, int top, Calendar calendar) Paints a trailing day of the current month, represented by the calendar, in a day-box located at left/top.
protected void	paintTrailingDayBackground(Graphics g, int x, int y, int width, int height, Calendar cal) Paint the background for the specified trailing day.
protected void	paintTrailingDayForeground(Graphics g, int x, int y, int width, int height, Calendar cal) Paint the foreground for the specified trailing day.
protected void	paintUnselectableDayBackground(Graphics g, int x, int y, int width, int height, Calendar cal) Paint the foreground for the specified unselectable day.
protected void	paintUnselectableDayForeground(Graphics g, int x, int y, int width, int height, Calendar cal) Paint the foreground for the specified unselectable day.
protected void	paintWeekOfYearBackground(Graphics g, int x, int y, int width, int height, Calendar cal)
protected void	paintWeekOfYearForeground(Graphics g, int x, int y, int width, int height, Calendar cal) Paints the week of the year of the week of the year represented by the given calendar.
protected void	paintWeeksOfYear(Graphics g, int x, int initialY, int width, Calendar cal) Paints the weeks of year if the showingWeek property is true.
protected void	setFirstDisplayedDay(Date firstDisplayedDate) Sets the firstDisplayedDate property to the given value.
void	setUsingKeyboard(boolean val)
protected void	uninstallComponents()
protected void	uninstallDefaults()
protected void	uninstallKeyboardActions()
protected void	uninstallListeners()
void	uninstallUI(JComponent c) Reverses configuration which was done on the specified component during installUI.
protected void	updateComponentInputMap() Binds/clears the keystrokes in the component input map, based on the monthView's componentInputMap enabled property.
protected void	updateLocale() Updates month and day names according to specified locale.

Methods inherited from class javax.swing.plaf.ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, getMaximumSize, getMinimumSize, getPreferredSize, update

Methods inherited from class java.lang.Object

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

Field Detail

MONTH_DOWN

public static final int MONTH_DOWN

Return value used to identify when the month down button is pressed.

See Also:

Constant Field Values

MONTH_UP

public static final int MONTH_UP

Return value used to identify when the month up button is pressed.

See Also:

Constant Field Values

dayOfMonthFormatter

protected final SimpleDateFormat dayOfMonthFormatter

Formatter used to format the day of the week to a numerical value.

monthsOfTheYear

protected String[] monthsOfTheYear

localized names of all months. protected for testing only! PENDING: JW - should be property on JXMonthView, for symmetry with daysOfTheWeek?

monthView

protected JXMonthView monthView

the component we are installed for.

derivedFont

protected Font derivedFont

Used as the font for flagged days.

isLeftToRight

protected boolean isLeftToRight

monthUpImage

protected Icon monthUpImage

monthDownImage

protected Icon monthDownImage

calendarGrid

protected Rectangle calendarGrid

The bounding box of the grid of visible months.

Constructor Detail

BasicMonthViewUI

public BasicMonthViewUI()

Method Detail

createUI

public static ComponentUI createUI(JComponent c)

installUI

public void installUI(JComponent c)

Description copied from class: javax.swing.plaf.ComponentUI

Configures the specified component appropriate for the look and feel. This method is invoked when the ComponentUI instance is being installed as the UI delegate on the specified component. This method should completely configure the component for the look and feel, including the following:

1. Install any default property values for color, fonts, borders, icons, opacity, etc. on the component. Whenever possible, property values initialized by the client program should not be overridden.
2. Install a LayoutManager on the component if necessary.
3. Create/add any required sub-components to the component.
4. Create/install event listeners on the component.
5. Create/install a PropertyChangeListener on the component in order to detect and respond to component property changes appropriately.
6. Install keyboard UI (mnemonics, traversal, etc.) on the component.
7. Initialize any appropriate instance data.

Overrides:

installUI in class ComponentUI

Parameters:

c - the component where this UI delegate is being installed

See Also:

ComponentUI.uninstallUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

uninstallUI

public void uninstallUI(JComponent c)

Description copied from class: javax.swing.plaf.ComponentUI

Reverses configuration which was done on the specified component during installUI. This method is invoked when this UIComponent instance is being removed as the UI delegate for the specified component. This method should undo the configuration performed in installUI, being careful to leave the JComponent instance in a clean state (no extraneous listeners, look-and-feel-specific property objects, etc.). This should include the following:

1. Remove any UI-set borders from the component.
2. Remove any UI-set layout managers on the component.
3. Remove any UI-added sub-components from the component.
4. Remove any UI-added event/property listeners from the component.
5. Remove any UI-installed keyboard UI from the component.
6. Nullify any allocated instance data objects to allow for GC.

Overrides:

uninstallUI in class ComponentUI

Parameters:

c - the component from which this UI delegate is being removed; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components

See Also:

ComponentUI.installUI(javax.swing.JComponent), JComponent.updateUI()

installComponents

protected void installComponents()

uninstallComponents

protected void uninstallComponents()

installDefaults

protected void installDefaults()

uninstallDefaults

protected void uninstallDefaults()

installKeyboardActions

protected void installKeyboardActions()

uninstallKeyboardActions

protected void uninstallKeyboardActions()

installListeners

protected void installListeners()

uninstallListeners

protected void uninstallListeners()

updateComponentInputMap

protected void updateComponentInputMap()

Binds/clears the keystrokes in the component input map, based on the monthView's componentInputMap enabled property.

See Also:

JXMonthView.isComponentInputMapEnabled()

updateLocale

protected void updateLocale()

Updates month and day names according to specified locale.

getDaysOfTheWeek

public String[] getDaysOfTheWeek()

Description copied from class: MonthViewUI

Returns an array of String to use as names for the days of the week.

Specified by:

getDaysOfTheWeek in class MonthViewUI

Returns:

array of names for the days of the week.

createDerivedFont

protected Font createDerivedFont()

Create a derived font used to when painting various pieces of the month view component. This method will be called whenever the font on the component is set so a new derived font can be created.

createPropertyChangeListener

protected PropertyChangeListener createPropertyChangeListener()

createLayoutManager

protected LayoutManager createLayoutManager()

createMouseListener

protected MouseListener createMouseListener()

createMouseMotionListener

protected MouseMotionListener createMouseMotionListener()

isUsingKeyboard

public boolean isUsingKeyboard()

setUsingKeyboard

public void setUsingKeyboard(boolean val)

getDayBoundsAtLocation

protected Rectangle getDayBoundsAtLocation(int x,
                                           int y)

Returns the bounds of the day in the grid of days which contains the given location. The bounds are in monthView screen coordinate system.

Note: this is a pure geometric mapping. The returned rectangle need not necessarily map to a date in the month which contains the location, it can represent a week-number/column header or a leading/trailing date.

Parameters:

x - the x position of the location in pixel

y - the y position of the location in pixel

Returns:

the bounds of the day which contains the location, or null if outside

getDayGridPositionAtLocation

protected Point getDayGridPositionAtLocation(int x,
                                             int y)

Returns the logical coordinates of the day which contains the given location. The p.x of the returned value represents the day of week, the p.y represents the week of the month. The transformation takes care of ComponentOrientation.

Note: this is a pure geometric mapping. The returned grid position need not necessarily map to a date in the month which contains the location, it can represent a week-number/column header or a leading/trailing date.

Parameters:

x - the x position of the location in pixel

y - the y position of the location in pixel

Returns:

the logical coordinates of the day in the grid of days in a month or null if outside.

getDayGridPosition

protected Point getDayGridPosition(Date date)

Returns the given date's position in the grid of the month it is contained in.

Parameters:

date - the Date to get the logical position for, must not be null.

Returns:

the logical coordinates of the day in the grid of days in a month or null if the Date is not visible.

getDayAtLocation

public Date getDayAtLocation(int x,
                             int y)

Returns the Date at the given location. May be null if the coordinates don't map to a day in the month which contains the coordinates. Specifically: hitting leading/trailing dates returns null. Mapping pixel to calendar day.

Specified by:

getDayAtLocation in class MonthViewUI

Parameters:

x - the x position of the location in pixel

y - the y position of the location in pixel

Returns:

the day at the given location or null if the location doesn't map to a day in the month which contains the coordinates.

getDayBounds

protected Rectangle getDayBounds(Date date)

Returns the bounds of the given day. The bounds are in monthView coordinate system.

PENDING JW: this most probably should be public as it is the logical reverse of getDayAtLocation

Parameters:

date - the Date to return the bounds for. Must not be null.

Returns:

the bounds of the given date or null if not visible.

getDayInMonth

protected Date getDayInMonth(Date month,
                             int row,
                             int column)

Returns the Date defined by the logical grid coordinates relative to the given month. May be null if the logical coordinates represent a header in the day grid or is outside of the given month. Mapping logical day grid coordinates to Date.

PENDING JW: relax the startOfMonth pre? Why did I require it?

Parameters:

month - a calendar representing the first day of the month, must not be null.

row - the logical row index in the day grid of the month

column - the logical column index in the day grid of the month

Returns:

the day at the logical grid coordinates in the given month or null if the coordinates

Throws:

IllegalStateException - if the month is not the start of the month.

getTraversableGridPositionAtLocation

protected int getTraversableGridPositionAtLocation(int x,
                                                   int y)

Mapping pixel to bounds.

PENDING JW: define the "action grid". Currently this replaces the old version to remove all internal usage of deprecated methods.

Parameters:

x - the x position of the location in pixel

y - the y position of the location in pixel

Returns:

the bounds of the active header area in containing the location or null if outside.

getMonthHeaderBoundsAtLocation

protected Rectangle getMonthHeaderBoundsAtLocation(int x,
                                                   int y)

Returns the bounds of the month header which contains the given location. The bounds are in monthView coordinate system.

Parameters:

x - the x position of the location in pixel

y - the y position of the location in pixel

Returns:

the bounds of the month which contains the location, or null if outside

getMonthBoundsAtLocation

protected Rectangle getMonthBoundsAtLocation(int x,
                                             int y)

Returns the bounds of the month which contains the given location. The bounds are in monthView coordinate system.

Mapping pixel to bounds.

Parameters:

x - the x position of the location in pixel

y - the y position of the location in pixel

Returns:

the bounds of the month which contains the location, or null if outside

getMonthGridPositionAtLocation

protected Point getMonthGridPositionAtLocation(int x,
                                               int y)

Returns the logical coordinates of the month which contains the given location. The p.x of the returned value represents the column, the p.y represents the row the month is shown in. The transformation takes care of ComponentOrientation.

Mapping pixel to logical grid coordinates.

Parameters:

x - the x position of the location in pixel

y - the y position of the location in pixel

Returns:

the logical coordinates of the month in the grid of month shown by this monthView or null if outside.

getMonthAtLocation

protected Date getMonthAtLocation(int x,
                                  int y)

Returns the Date representing the start of the month which contains the given location.

Mapping pixel to calendar day.

Parameters:

x - the x position of the location in pixel

y - the y position of the location in pixel

Returns:

the start of the month which contains the given location or null if the location is outside the grid of months.

getMonth

protected Date getMonth(int row,
                        int column)

Returns the Date representing the start of the month at the given logical position in the grid of months.

Mapping logical grid coordinates to Calendar.

Parameters:

row - the rowIndex in the grid of months.

column - the columnIndex in the grid months.

Returns:

a Date representing the start of the month at the given logical coordinates.

See Also:

getMonthGridPosition(Date)

getMonthGridPosition

protected Point getMonthGridPosition(Date date)

Returns the logical grid position of the month containing the given date. The Point's x value is the column in the grid of months, the y value is the row in the grid of months. Mapping Date to logical grid position, this is the reverse of getMonth(int, int).

Parameters:

date - the Date to return the bounds for. Must not be null.

Returns:

the postion of the month that contains the given date or null if not visible.

See Also:

getMonth(int, int), getMonthBounds(int, int)

getMonthBounds

protected Rectangle getMonthBounds(int row,
                                   int column)

Returns the bounds of the month at the given logical coordinates in the grid of visible months.

Mapping logical grip position to pixel.

Parameters:

row - the rowIndex in the grid of months.

column - the columnIndex in the grid months.

Returns:

the bounds of the month at the given logical logical position.

See Also:

getMonthGridPositionAtLocation(int, int), getMonthBoundsAtLocation(int, int)

getMonthBounds

protected Rectangle getMonthBounds(Date date)

Returns the bounds of the month containing the given date. The bounds are in monthView coordinate system.

Mapping Date to pixel.

Parameters:

date - the Date to return the bounds for. Must not be null.

Returns:

the bounds of the month that contains the given date or null if not visible.

See Also:

getMonthAtLocation(int, int)

getMonthSize

protected Dimension getMonthSize()

Returns the size of a month.

Returns:

the size of a month.

getDaySize

protected Dimension getDaySize()

Returns the size of a day including the padding.

Returns:

the size of a month.

getMonthHeaderHeight

protected int getMonthHeaderHeight()

Returns the height of the month header.

Returns:

the height of the month header.

paint

public void paint(Graphics g,
                  JComponent c)

Paints the specified component appropriate for the look and feel. This method is invoked from the ComponentUI.update method when the specified component is being painted. Subclasses should override this method and use the specified Graphics object to render the content of the component.

Overrides:

paint in class ComponentUI

Parameters:

g - the Graphics context in which to paint

c - the component being painted; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components

See Also:

ComponentUI.update(java.awt.Graphics, javax.swing.JComponent)

paintMonth

protected void paintMonth(Graphics g,
                          int x,
                          int y,
                          int width,
                          int height,
                          Calendar calendar)

Paints a month. It is assumed the given calendar is already set to the first day of the month to be painted.

Note: the given calendar must not be changed.

Parameters:

g - Graphics object.

x - x location of month

y - y location of month

width - width of month

height - height of month

calendar - the calendar specifying the the first day of the month to paint, must not be null

paintDays

protected void paintDays(Graphics g,
                         int left,
                         int top,
                         int width,
                         Calendar cal)

Paints all days in the days' grid, that is the month area below the daysOfWeek and to the right/left (depending on the monthView's componentOrientation) of the weekOfYears. The calendar represents the first day of the month to paint.

Note: the calendar must not be changed.

Parameters:

g - Graphics object.

left - the left boundary of the day grid.

top - the upper boundary of the day grid

width - the width of the day grid.

cal - the calendar specifying the the first day of the month to paint, must not be null

paintDay

protected void paintDay(Graphics g,
                        int left,
                        int top,
                        Calendar calendar)

Paints a day the current month, represented by the calendar in a day-box located at left/top. The size of the day-box is defined by fullBoxWidth/Height. The appearance of the day depends on its state (like unselectable, flagged, selected)

Note: the given calendar must not be changed.

Parameters:

g - the Graphics to paint into.

left - the left boundary of the day-box to paint.

top - the upper boundary of the day-box to paint.

calendar - the calendar specifying the the day to paint, must not be null

paintTrailingDay

protected void paintTrailingDay(Graphics g,
                                int left,
                                int top,
                                Calendar calendar)

Paints a trailing day of the current month, represented by the calendar, in a day-box located at left/top. The size of the day-box is defined by fullBoxWidth/Height. Does nothing if the monthView's isShowingTrailingDates is false.

Note: the given calendar must not be changed.

Parameters:

g - the Graphics to paint into.

left - the left boundary of the day-box to paint.

top - the upper boundary of the day-box to paint.

calendar - the calendar specifying the the day to paint, must not be null

paintLeadingDay

protected void paintLeadingDay(Graphics g,
                               int left,
                               int top,
                               Calendar calendar)

Paints a leading day of the current month, represented by the calendar, in a day-box located at left/top. The size of the day-box is defined by fullBoxWidth/Height. Does nothing if the monthView's isShowingLeadingDates is false.

Note: the given calendar must not be changed.

Parameters:

g - the Graphics to paint into.

left - the left boundary of the day-box to paint.

top - the upper boundary of the day-box to paint.

calendar - the calendar specifying the the day to paint, must not be null

getWeeks

protected int getWeeks(Calendar month)

Returns the number of weeks to paint in the current month, as represented by the given calendar. Note: the given calendar must not be changed.

Parameters:

month - the calendar specifying the the first day of the month to paint, must not be null

Returns:

the number of weeks of this month.

paintWeeksOfYear

protected void paintWeeksOfYear(Graphics g,
                                int x,
                                int initialY,
                                int width,
                                Calendar cal)

Paints the weeks of year if the showingWeek property is true. Does nothing otherwise. It is assumed the given calendar is already set to the first day of the month. The calendar is unchanged when leaving this method. Note: the given calendar must not be changed. PENDING JW: this implementation doesn't need the height - should it be given anyway for symetry in case subclasses need it?

Parameters:

g - Graphics object.

x - x location of month

initialY - y the upper bound of the "weekNumbers-box"

width - width of month

cal - the calendar specifying the the first day of the month to paint, must not be null

paintDayOfTheWeekBackground

protected void paintDayOfTheWeekBackground(Graphics g,
                                           int x,
                                           int y,
                                           int width,
                                           int height,
                                           Calendar cal)

paintWeekOfYearBackground

protected void paintWeekOfYearBackground(Graphics g,
                                         int x,
                                         int y,
                                         int width,
                                         int height,
                                         Calendar cal)

paintWeekOfYearForeground

protected void paintWeekOfYearForeground(Graphics g,
                                         int x,
                                         int y,
                                         int width,
                                         int height,
                                         Calendar cal)

Paints the week of the year of the week of the year represented by the given calendar.

Note: the given calendar must not be changed.

Parameters:

g - Graphics object

x - x-coordinate of upper left corner.

y - y-coordinate of upper left corner.

width - width of bounding box

height - height of bounding box

paintMonthStringBackground

protected void paintMonthStringBackground(Graphics g,
                                          int x,
                                          int y,
                                          int width,
                                          int height,
                                          Calendar cal)

Paints the background of the month string. The bounding box for this background can be modified by setting its insets via setMonthStringInsets. The color of the background can be set via setMonthStringBackground. Note: the given calendar must not be changed.

Parameters:

g - Graphics object to paint to.

x - x-coordinate of upper left corner.

y - y-coordinate of upper left corner.

width - width of the bounding box.

height - height of the bounding box.

See Also:

JXMonthView.setMonthStringBackground(java.awt.Color), JXMonthView.setMonthStringInsets(java.awt.Insets)

paintMonthStringForeground

protected void paintMonthStringForeground(Graphics g,
                                          int x,
                                          int y,
                                          int width,
                                          int height,
                                          Calendar cal)

Note: the given calendar must not be changed.

Parameters:

g - Graphics object to paint to.

x - x-coordinate of upper left corner.

y - y-coordinate of upper left corner.

width - width of the bounding box.

height - height of the bounding box.

cal - the calendar specifying the day to use, must not be null

paintMonthStringForeground

protected void paintMonthStringForeground(Graphics g,
                                          String monthName,
                                          int monthX,
                                          int monthY,
                                          String yearName,
                                          int yearX,
                                          int yearY,
                                          Calendar cal)

Paints only text for month and year. No calculations made. Used by custom LAFs.

Note: the given calendar must not be changed.

Parameters:

g - Graphics to paint into.

monthName - Name of the month.

monthX - Month string x coordinate.

monthY - Month string y coordinate.

yearName - Name (number) of the year.

yearX - Year string x coordinate.

yearY - Year string y coordinate.

paintDayBackground

protected void paintDayBackground(Graphics g,
                                  int x,
                                  int y,
                                  int width,
                                  int height,
                                  Calendar cal)

Paint the background for the day specified by the given calendar.

Note: the given calendar must not be changed.

Parameters:

g - Graphics object to paint to

x - x-coordinate of upper left corner

y - y-coordinate of upper left corner

width - width of bounding box for the day

height - height of bounding box for the day

cal - the calendar specifying the day to paint, must not be null

See Also:

org.jdesktop.swingx.JXMonthView#isSelectedDate, isToday(java.util.Date)

paintDayForeground

protected void paintDayForeground(Graphics g,
                                  int x,
                                  int y,
                                  int width,
                                  int height,
                                  Calendar cal)

Paint the foreground for the specified day.

Note: the given calendar must not be changed.

Parameters:

g - Graphics object to paint to

x - x-coordinate of upper left corner

y - y-coordinate of upper left corner

width - width of bounding box for the day

height - height of bounding box for the day

cal - the calendar specifying the day to paint, must not be null

paintDayForeground

protected void paintDayForeground(Graphics g,
                                  String numericDay,
                                  int x,
                                  int y,
                                  Calendar cal)

Paints string of the day. No calculations made. Used by LAFs.

Note: the given calendar must not be changed.

Parameters:

g - Graphics to paint on.

numericDay - Text representation of the day.

x - X coordinate of the upper right corner.

y - Y coordinate of the upper right corner.

paintFlaggedDayBackground

protected void paintFlaggedDayBackground(Graphics g,
                                         int x,
                                         int y,
                                         int width,
                                         int height,
                                         Calendar cal)

Paint the background for the specified flagged day. The default implementation just calls paintDayBackground.

Note: the given calendar must not be changed.

Parameters:

g - Graphics object to paint to

x - x-coordinate of upper left corner

y - y-coordinate of upper left corner

width - width of bounding box for the day

height - height of bounding box for the day

cal - the calendar specifying the day to paint, must not be null

paintFlaggedDayForeground

protected void paintFlaggedDayForeground(Graphics g,
                                         int x,
                                         int y,
                                         int width,
                                         int height,
                                         Calendar cal)

Paint the foreground for the specified flagged day.

Note: the given calendar must not be changed.

Parameters:

g - Graphics object to paint to

x - x-coordinate of upper left corner

y - y-coordinate of upper left corner

width - width of bounding box for the day

height - height of bounding box for the day

cal - the calendar specifying the day to paint, must not be null

paintUnselectableDayBackground

protected void paintUnselectableDayBackground(Graphics g,
                                              int x,
                                              int y,
                                              int width,
                                              int height,
                                              Calendar cal)

Paint the foreground for the specified unselectable day.

Note: the given calendar must not be changed.

Parameters:

g - Graphics object to paint to

x - x-coordinate of upper left corner

y - y-coordinate of upper left corner

width - width of bounding box for the day

height - height of bounding box for the day

cal - the calendar specifying the day to paint, must not be null

paintUnselectableDayForeground

protected void paintUnselectableDayForeground(Graphics g,
                                              int x,
                                              int y,
                                              int width,
                                              int height,
                                              Calendar cal)

Paint the foreground for the specified unselectable day.

Note: the given calendar must not be changed.

Parameters:

g - Graphics object to paint to

x - x-coordinate of upper left corner

y - y-coordinate of upper left corner

width - width of bounding box for the day

height - height of bounding box for the day

cal - the calendar specifying the day to paint, must not be null

paintLeadingDayBackground

protected void paintLeadingDayBackground(Graphics g,
                                         int x,
                                         int y,
                                         int width,
                                         int height,
                                         Calendar cal)

Paint the background for the specified leading day.

Note: the given calendar must not be changed.

Parameters:

g - Graphics object to paint to

x - x-coordinate of upper left corner

y - y-coordinate of upper left corner

width - width of bounding box for the day

height - height of bounding box for the day

cal - the calendar specifying the day to paint, must not be null

paintLeadingDayForeground

protected void paintLeadingDayForeground(Graphics g,
                                         int x,
                                         int y,
                                         int width,
                                         int height,
                                         Calendar cal)

Paint the foreground for the specified leading day.

Note: the given calendar must not be changed.

Parameters:

g - Graphics object to paint to

x - x-coordinate of upper left corner

y - y-coordinate of upper left corner

width - width of bounding box for the day

height - height of bounding box for the day

cal - the calendar specifying the day to paint, must not be null

paintTrailingDayBackground

protected void paintTrailingDayBackground(Graphics g,
                                          int x,
                                          int y,
                                          int width,
                                          int height,
                                          Calendar cal)

Paint the background for the specified trailing day.

Note: the given calendar must not be changed.

Parameters:

g - Graphics object to paint to

x - x-coordinate of upper left corner

y - y-coordinate of upper left corner

width - width of bounding box for the day

height - height of bounding box for the day

cal - the calendar specifying the day to paint, must not be null

paintTrailingDayForeground

protected void paintTrailingDayForeground(Graphics g,
                                          int x,
                                          int y,
                                          int width,
                                          int height,
                                          Calendar cal)

Paint the foreground for the specified trailing day.

Note: the given calendar must not be changed.

Parameters:

g - Graphics object to paint to

x - x-coordinate of upper left corner

y - y-coordinate of upper left corner

width - width of bounding box for the day

height - height of bounding box for the day

cal - the calendar specifying the day to paint, must not be null

paintBackground

protected void paintBackground(Rectangle clip,
                               Graphics g)

getCalendar

protected Calendar getCalendar()

Returns the monthViews calendar configured to the firstDisplayedDate. NOTE: it's safe to change the calendar state without resetting because it's JXMonthView's responsibility to protect itself.

Returns:

the monthView's calendar, configured with the firstDisplayedDate.

getCalendar

protected Calendar getCalendar(Date date)

Returns the monthViews calendar configured to the given time. NOTE: it's safe to change the calendar state without resetting because it's JXMonthView's responsibility to protect itself.

Parameters:

date - the date to configure the calendar with

Returns:

the monthView's calendar, configured with the given date.

getLastDisplayedDay

public Date getLastDisplayedDay()

Returns the last possible date that can be displayed. This is implemented by the UI since it is in control of layout and may possibly yeild different results based on implementation.

It's up to the UI to keep this property, based on internal state and the firstDisplayed as controlled by the JXMonthView.

Specified by:

getLastDisplayedDay in class MonthViewUI

Returns:

Date The date.

setFirstDisplayedDay

protected void setFirstDisplayedDay(Date firstDisplayedDate)

Sets the firstDisplayedDate property to the given value. Must update dependent state as well. Here: updated lastDisplayedDatefirstDisplayedMonth/Year accordingly.

Parameters:

firstDisplayedDate - the firstDisplayedDate to set

getFirstDisplayedDay

protected Date getFirstDisplayedDay()

Returns:

the firstDisplayedDate

getFirstDisplayedMonth

protected int getFirstDisplayedMonth()

Returns:

the firstDisplayedMonth

getFirstDisplayedYear

protected int getFirstDisplayedYear()

Returns:

the firstDisplayedYear

getSelection

protected SortedSet<Date> getSelection()

Returns:

the selection

getToday

protected Date getToday()

Returns:

the start of today.

isToday

protected boolean isToday(Date date)

Returns true if the date passed in is the same as today. PENDING JW: really want the exact test?

Parameters:

date - long representing the date you want to compare to today.

Returns:

true if the date passed is the same as today.