public class BasicMonthViewUI extends MonthViewUI
JXMonthView
UI.Note: The api changed considerably between releases 0.9.4 and 0.9.5.
The general drift of the change was to delegate all text rendering to a dedicated rendering controller (currently named RenderingHandler), similar to the collection view rendering. The UI itself keeps layout and positioning of the rendering components. Plus updating on property changes received from the monthView.
Painting: coordinate systems.
Added support (doesn't do anything yet, zoom-logic must yet be defined) by way of an active calendar header which is added to the monthView if zoomable. It is disabled by default. In this mode, the view is always traversable and shows exactly one calendar. It is orthogonal to the classic mode, that is client code should not be effected in any way as long as the mode is not explicitly enabled.
NOTE to LAF implementors: the active calendar header is very, very, very raw and sure to change without much notice. Better not yet to support it right now.
Modifier and Type | Class and Description |
---|---|
protected static class |
BasicMonthViewUI.RenderingHandler
Empty subclass for backward compatibility.
|
Modifier and Type | Field and Description |
---|---|
protected java.awt.Rectangle |
calendarGrid
The bounding box of the grid of visible months.
|
protected static int |
DAY_HEADER_ROW |
protected static int |
DAYS_IN_WEEK |
protected static int |
FIRST_DAY_COLUMN |
protected static int |
FIRST_WEEK_ROW |
protected boolean |
isLeftToRight |
protected static int |
LAST_DAY_COLUMN |
protected static int |
LAST_WEEK_ROW |
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 javax.swing.Icon |
monthDownImage |
protected java.lang.String[] |
monthsOfTheYear
Deprecated.
pre-0.9.6
no longer used in paint/layout with renderer.
|
protected javax.swing.Icon |
monthUpImage |
protected JXMonthView |
monthView
the component we are installed for.
|
protected static int |
WEEK_HEADER_COLUMN |
protected static int |
WEEKS_IN_MONTH |
Constructor and Description |
---|
BasicMonthViewUI() |
Modifier and Type | Method and Description |
---|---|
protected CalendarHeaderHandler |
createCalendarHeaderHandler()
Creates and returns a calendar header handler which provides and configures
a component for use in a zoomable monthView.
|
protected java.awt.Font |
createDerivedFont()
Deprecated.
KEEP re-added usage in preliminary zoomable support
no longer used in paint/layout with renderer.
|
protected java.awt.LayoutManager |
createLayoutManager() |
protected java.awt.event.MouseListener |
createMouseListener() |
protected java.awt.event.MouseMotionListener |
createMouseMotionListener() |
protected java.beans.PropertyChangeListener |
createPropertyChangeListener() |
protected CalendarRenderingHandler |
createRenderingHandler()
Returns the
CalendarRenderingHandler to use. |
static javax.swing.plaf.ComponentUI |
createUI(javax.swing.JComponent c) |
protected java.util.Calendar |
getCalendar()
Returns the monthViews calendar configured to the firstDisplayedDate.
|
protected java.util.Calendar |
getCalendar(java.util.Date date)
Returns the monthViews calendar configured to the given time.
|
protected CalendarHeaderHandler |
getCalendarHeaderHandler() |
java.util.Date |
getDayAtLocation(int x,
int y)
Returns the Date at the given location.
|
protected java.awt.Rectangle |
getDayBounds(java.util.Date date)
Returns the bounds of the given day.
|
protected java.awt.Rectangle |
getDayBoundsAtLocation(int x,
int y)
Returns the bounds of the day in the grid of days which contains the
given location.
|
protected java.awt.Rectangle |
getDayBoundsInMonth(java.util.Date month,
int row,
int column)
Returns the bounds of the day box at logical coordinates in the given month.
|
protected java.awt.Point |
getDayGridPosition(java.util.Date date)
Returns the given date's position in the grid of the month it is contained in.
|
protected java.awt.Point |
getDayGridPositionAtLocation(int x,
int y)
Returns the logical coordinates of the day which contains the given
location.
|
protected java.util.Date |
getDayInMonth(java.util.Date month,
int row,
int column)
Returns the Date defined by the logical
grid coordinates relative to the given month.
|
protected java.awt.Dimension |
getDaySize()
Returns the size of a day including the padding.
|
java.lang.String[] |
getDaysOfTheWeek()
Returns an array of String to use as names for the days of the week.
|
protected java.util.Date |
getFirstDisplayedDay()
Returns the first displayed day.
|
protected int |
getFirstDisplayedMonth() |
protected int |
getFirstDisplayedYear() |
protected CalendarHeaderHandler |
getHeaderFromUIManager()
Returns a CalendarHeaderHandler looked up in the UIManager.
|
java.util.Date |
getLastDisplayedDay()
Returns the last possible date that can be displayed.
|
protected java.util.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 java.util.Date |
getMonthAtLocation(int x,
int y)
Returns the Date representing the start of the month which
contains the given location.
|
protected java.awt.Rectangle |
getMonthBounds(java.util.Date date)
Returns the bounds of the month containing the given date.
|
protected java.awt.Rectangle |
getMonthBounds(int row,
int column)
Returns the bounds of the month at the given logical coordinates
in the grid of visible months.
|
protected java.awt.Rectangle |
getMonthBoundsAtLocation(int x,
int y)
Returns the bounds of the month which contains the
given location.
|
protected java.awt.Rectangle |
getMonthDetailsBoundsAtLocation(int x,
int y)
Returns the bounds of the month details which contains the
given location.
|
protected java.awt.Point |
getMonthGridPosition(java.util.Date date)
Returns the logical grid position of the month containing the given date.
|
protected java.awt.Point |
getMonthGridPositionAtLocation(int x,
int y)
Returns the logical coordinates of the month which contains
the given location.
|
protected java.awt.Rectangle |
getMonthHeaderBounds(java.util.Date date,
boolean includeInsets)
Returns the bounds of the month containing the given date.
|
protected java.awt.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 java.awt.Dimension |
getMonthSize()
Returns the size of a month.
|
protected CalendarRenderingHandler |
getRenderingHandler() |
protected java.util.SortedSet<java.util.Date> |
getSelection() |
protected java.util.Date |
getToday() |
protected int |
getTraversableGridPositionAtLocation(int x,
int y)
Mapping pixel to bounds.
|
protected int |
getWeeks(java.util.Calendar month)
Returns the number of weeks to paint in the current month, as represented
by the given calendar.
|
protected void |
installComponents()
Creates and installs the calendar header handler.
|
protected void |
installDefaults()
Installs default values.
|
protected void |
installDelegate()
Installs this ui delegate's properties.
|
protected void |
installKeyboardActions() |
protected void |
installListeners() |
protected void |
installRenderingHandler()
Creates and installs the renderingHandler and infrastructure to use it.
|
void |
installUI(javax.swing.JComponent c)
Installs the component as appropriate for the current lf.
|
protected boolean |
isToday(java.util.Date date)
Returns true if the date passed in is the same as today.
|
protected boolean |
isUIInstallable(java.lang.Object property)
Deprecated.
pre-0.9.6 use
SwingXUtilities.isUIInstallable(Object) |
boolean |
isUsingKeyboard() |
protected boolean |
isZoomable() |
void |
paint(java.awt.Graphics g,
javax.swing.JComponent c) |
protected void |
paintBackground(java.awt.Graphics g)
Paints the background of the component.
|
protected void |
paintDayHeader(java.awt.Graphics g,
java.util.Calendar month)
Paints the day column header.
|
protected void |
paintDayOfMonth(java.awt.Graphics g,
java.awt.Rectangle bounds,
java.util.Calendar calendar,
CalendarState state)
Paints a day which is of the current month with the given state.
|
protected void |
paintDays(java.awt.Graphics g,
java.util.Calendar month)
Paints the days of the given month.
|
protected void |
paintDaysOfWeekSeparator(java.awt.Graphics g,
java.util.Calendar month)
Paints the separator between column header (days of week) and days.
|
protected void |
paintMonth(java.awt.Graphics g,
java.util.Calendar month)
Paints the month represented by the given Calendar.
|
protected void |
paintMonthHeader(java.awt.Graphics g,
java.util.Calendar month)
Paints the header of a month.
|
protected void |
paintWeekHeader(java.awt.Graphics g,
java.util.Calendar month)
Paints the day column header.
|
protected void |
paintWeekOfYearSeparator(java.awt.Graphics g,
java.util.Calendar month)
Paints the separator between row header (weeks of year) and days.
|
protected void |
setCalendarHeaderHandler(CalendarHeaderHandler calendarHeaderHandler) |
protected void |
setFirstDisplayedDay(java.util.Date firstDisplayedDay)
Updates internal state that depends on the MonthView's firstDisplayedDay
property.
|
protected void |
setRenderingHandler(CalendarRenderingHandler renderingHandler) |
void |
setUsingKeyboard(boolean val) |
protected void |
uninstallComponents()
Uninstalls the calendar header handler.
|
protected void |
uninstallDefaults() |
protected void |
uninstallKeyboardActions() |
protected void |
uninstallListeners() |
protected void |
uninstallRenderingHandler()
Uninstalls the renderingHandler and infrastructure that used it.
|
void |
uninstallUI(javax.swing.JComponent c) |
void |
update(java.awt.Graphics g,
javax.swing.JComponent c)
Overridden to extract the background painting for ease-of-use of
subclasses.
|
protected void |
updateComponentInputMap()
Binds/clears the keystrokes in the component input map,
based on the monthView's componentInputMap enabled property.
|
protected void |
updateLocale(boolean revalidate)
Updates internal state according to monthView's locale.
|
protected void |
updateZoomable()
Updates state after the monthView's zoomable property has been changed.
|
public static final int MONTH_DOWN
public static final int MONTH_UP
protected static final int WEEK_HEADER_COLUMN
protected static final int DAYS_IN_WEEK
protected static final int FIRST_DAY_COLUMN
protected static final int LAST_DAY_COLUMN
protected static final int DAY_HEADER_ROW
protected static final int WEEKS_IN_MONTH
protected static final int FIRST_WEEK_ROW
protected static final int LAST_WEEK_ROW
@Deprecated protected java.lang.String[] monthsOfTheYear
protected JXMonthView monthView
protected boolean isLeftToRight
protected javax.swing.Icon monthUpImage
protected javax.swing.Icon monthDownImage
protected java.awt.Rectangle calendarGrid
public static javax.swing.plaf.ComponentUI createUI(javax.swing.JComponent c)
public void installUI(javax.swing.JComponent c)
installUI
in class javax.swing.plaf.ComponentUI
public void uninstallUI(javax.swing.JComponent c)
uninstallUI
in class javax.swing.plaf.ComponentUI
protected void installComponents()
protected void uninstallComponents()
protected void installDefaults()
This is refactored to only install default properties on the monthView. Extracted install of this delegate's properties into installDelegate.
protected void installDelegate()
@Deprecated protected boolean isUIInstallable(java.lang.Object property)
SwingXUtilities.isUIInstallable(Object)
property
- the property to check.protected void uninstallDefaults()
protected void installKeyboardActions()
protected void uninstallKeyboardActions()
protected void installListeners()
protected void uninstallListeners()
protected void installRenderingHandler()
protected void uninstallRenderingHandler()
protected CalendarRenderingHandler createRenderingHandler()
CalendarRenderingHandler
to use. Subclasses may override to
plug-in custom implementations. This implementation returns an instance of RenderingHandler.
protected void setRenderingHandler(CalendarRenderingHandler renderingHandler)
renderingHandler
- the renderingHandler to setprotected CalendarRenderingHandler getRenderingHandler()
protected void updateComponentInputMap()
JXMonthView.isComponentInputMapEnabled()
protected void updateLocale(boolean revalidate)
revalidate
- a boolean indicating whether the monthView should be
revalidated after the change.public java.lang.String[] getDaysOfTheWeek()
MonthViewUI
getDaysOfTheWeek
in class MonthViewUI
protected java.beans.PropertyChangeListener createPropertyChangeListener()
protected java.awt.LayoutManager createLayoutManager()
protected java.awt.event.MouseListener createMouseListener()
protected java.awt.event.MouseMotionListener createMouseMotionListener()
public boolean isUsingKeyboard()
public void setUsingKeyboard(boolean val)
protected java.awt.Rectangle getDayBoundsAtLocation(int x, int y)
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.
x
- the x position of the location in pixely
- the y position of the location in pixelprotected java.awt.Rectangle getDayBoundsInMonth(java.util.Date month, int row, int column)
month
- the month containing the day boxrow
- the logical row (== week) coordinate in the day gridcolumn
- the logical column (== day) coordinate in the day gridjava.lang.IllegalArgumentException
- if row or column are out off range.getDayGridPositionAtLocation(int, int)
protected java.awt.Point getDayGridPositionAtLocation(int x, int y)
Note: 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.
x
- the x position of the location in pixely
- the y position of the location in pixelgetDayBoundsInMonth(Date, int, int)
protected java.util.Date getDayInMonth(java.util.Date month, int row, int column)
PENDING JW: relax the startOfMonth pre? Why did I require it?
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 monthcolumn
- the logical column index in the day grid of the monthjava.lang.IllegalStateException
- if the month is not the start of the month.getDayGridPosition(Date)
protected java.awt.Point getDayGridPosition(java.util.Date date)
date
- the Date to get the logical position for, must not be null.getDayInMonth(Date, int, int)
public java.util.Date getDayAtLocation(int x, int y)
getDayAtLocation
in class MonthViewUI
x
- the x position of the location in pixely
- the y position of the location in pixelgetDayBounds(Date)
protected java.awt.Rectangle getDayBounds(java.util.Date date)
PENDING JW: this most probably should be public as it is the logical reverse of getDayAtLocation
date
- the Date to return the bounds for. Must not be null.getDayAtLocation(int, int)
protected int getTraversableGridPositionAtLocation(int x, int y)
PENDING JW: define the "action grid". Currently this replaces the old version to remove all internal usage of deprecated methods.
x
- the x position of the location in pixely
- the y position of the location in pixelprotected java.awt.Rectangle getMonthHeaderBoundsAtLocation(int x, int y)
x
- the x position of the location in pixely
- the y position of the location in pixelprotected java.awt.Rectangle getMonthDetailsBoundsAtLocation(int x, int y)
x
- the x position of the location in pixely
- the y position of the location in pixelprotected java.awt.Rectangle getMonthBoundsAtLocation(int x, int y)
Mapping pixel to bounds.
x
- the x position of the location in pixely
- the y position of the location in pixelprotected java.awt.Point getMonthGridPositionAtLocation(int x, int y)
Mapping pixel to logical grid coordinates.
x
- the x position of the location in pixely
- the y position of the location in pixelprotected java.util.Date getMonthAtLocation(int x, int y)
Mapping pixel to calendar day.
x
- the x position of the location in pixely
- the y position of the location in pixelprotected java.util.Date getMonth(int row, int column)
Mapping logical grid coordinates to Calendar.
row
- the rowIndex in the grid of months.column
- the columnIndex in the grid months.getMonthGridPosition(Date)
protected java.awt.Point getMonthGridPosition(java.util.Date date)
date
- the Date to return the bounds for. Must not be null.getMonth(int, int)
,
getMonthBounds(int, int)
protected java.awt.Rectangle getMonthBounds(int row, int column)
Mapping logical grip position to pixel.
row
- the rowIndex in the grid of months.column
- the columnIndex in the grid months.getMonthGridPositionAtLocation(int, int)
,
getMonthBoundsAtLocation(int, int)
protected java.awt.Rectangle getMonthBounds(java.util.Date date)
Mapping Date to pixel.
date
- the Date to return the bounds for. Must not be null.getMonthAtLocation(int, int)
protected java.awt.Rectangle getMonthHeaderBounds(java.util.Date date, boolean includeInsets)
Mapping Date to pixel.
date
- the Date to return the bounds for. Must not be null.getMonthAtLocation(int, int)
protected java.awt.Dimension getMonthSize()
protected java.awt.Dimension getDaySize()
protected int getMonthHeaderHeight()
protected boolean isZoomable()
public void update(java.awt.Graphics g, javax.swing.JComponent c)
update
in class javax.swing.plaf.ComponentUI
protected void paintBackground(java.awt.Graphics g)
g
- the Graphics to fill.public void paint(java.awt.Graphics g, javax.swing.JComponent c)
paint
in class javax.swing.plaf.ComponentUI
protected void paintMonth(java.awt.Graphics g, java.util.Calendar month)
g
- the graphics to paint intomonth
- the calendar specifying the first day of the month to
paint, must not be nullprotected void paintMonthHeader(java.awt.Graphics g, java.util.Calendar month)
g
- the graphics to paint intomonth
- the calendar specifying the first day of the month to
paint, must not be nullprotected void paintDayHeader(java.awt.Graphics g, java.util.Calendar month)
g
- the graphics to paint intomonth
- the calendar specifying the first day of the month to
paint, must not be nullprotected void paintWeekHeader(java.awt.Graphics g, java.util.Calendar month)
g
- the graphics to paint intomonth
- the calendar specifying the first day of the month to
paint, must not be nullprotected void paintDays(java.awt.Graphics g, java.util.Calendar month)
g
- the graphics to paint intomonth
- the calendar specifying the first day of the month to
paint, must not be nullprotected void paintDayOfMonth(java.awt.Graphics g, java.awt.Rectangle bounds, java.util.Calendar calendar, CalendarState state)
PENDING JW: mis-nomer - this is in fact called for rendering any day-related state (including weekOfYear, dayOfWeek headers) and for rendering the month header as well, that is from everywhere. Rename to paintSomethingGeneral. Think about impact for subclasses (what do they really need? feedback please!)
g
- the graphics to paint into.bounds
- the rectangle to paint the day intocalendar
- the calendar representing the day to paintstate
- the calendar stateprotected void paintWeekOfYearSeparator(java.awt.Graphics g, java.util.Calendar month)
g
- the graphics to paint intomonth
- the calendar specifying the first day of the month to
paint, must not be nullprotected void paintDaysOfWeekSeparator(java.awt.Graphics g, java.util.Calendar month)
g
- the graphics to paint intomonth
- the calendar specifying the the first day of the month to
paint, must not be nullprotected int getWeeks(java.util.Calendar month)
month
- the calendar specifying the the first day of the month to
paint, must not be nullprotected java.util.Calendar getCalendar()
protected java.util.Calendar getCalendar(java.util.Date date)
date
- the date to configure the calendar withpublic java.util.Date getLastDisplayedDay()
It's up to the UI to keep this property, based on internal state and the firstDisplayed as controlled by the JXMonthView.
getLastDisplayedDay
in class MonthViewUI
protected void setFirstDisplayedDay(java.util.Date firstDisplayedDay)
Here: updates lastDisplayedDay.
firstDisplayedDay
- the firstDisplayedDate to setprotected java.util.Date getFirstDisplayedDay()
protected int getFirstDisplayedMonth()
protected int getFirstDisplayedYear()
protected java.util.SortedSet<java.util.Date> getSelection()
protected java.util.Date getToday()
protected boolean isToday(java.util.Date date)
date
- long representing the date you want to compare to today.protected void updateZoomable()
protected CalendarHeaderHandler createCalendarHeaderHandler()
This implementation first queries the UIManager for class to use and returns that if available, returns a BasicCalendarHeaderHandler if not.
getHeaderFromUIManager()
,
CalendarHeaderHandler
,
BasicCalendarHeaderHandler
protected CalendarHeaderHandler getHeaderFromUIManager()
protected void setCalendarHeaderHandler(CalendarHeaderHandler calendarHeaderHandler)
calendarHeaderHandler
- the calendarHeaderHandler to setprotected CalendarHeaderHandler getCalendarHeaderHandler()
@Deprecated protected java.awt.Font createDerivedFont()