ilog.views.util.swing.calendar.plaf
Class CalendarPanelUI

java.lang.Object
  javax.swing.plaf.ComponentUI
      ilog.views.util.swing.calendar.plaf.CalendarPanelUI

Direct Known Subclasses:

BasicCalendarPanelUI

public abstract class CalendarPanelUI
extends ComponentUI

This interface defines the pluggable look and feel for IlvJCalendarPanel components.

Since:

JViews 5.5

See Also:

BasicCalendarPanelUI

Constructor Summary

CalendarPanelUI()
Creates a new CalendarPanelUI.

Method Summary

abstract Calendar	getCellDate(IlvJCalendarPanel calendarPanel, int row, int column) Returns the date displayed in the day cell that lies at the intersection of the specified week row and day-of-week column.
abstract Rectangle	getCellRect(IlvJCalendarPanel calendarPanel, int row, int column) Returns a rectangle for the day cell that lies at the intersection of the specified week row and day-of-week column.
abstract int	getColumnAtPoint(IlvJCalendarPanel calendarPanel, Point point) Returns the index of the day-of-week column that point lies in.
abstract int	getColumnCount(IlvJCalendarPanel calendarPanel) Returns the number of day-of-week columns in the specified calendar panel.
abstract int	getColumnWidth(IlvJCalendarPanel calendarPanel) Returns the width of the day-of-week columns in the specified calendar panel.
abstract int	getRowAtPoint(IlvJCalendarPanel calendarPanel, Point point) Returns the index of the week row that point lies in.
abstract int	getRowCount(IlvJCalendarPanel calendarPanel) Returns the number of week rows in the specified calendar panel.
abstract int	getRowHeight(IlvJCalendarPanel calendarPanel) Returns the height of the week rows in the specified calendar panel.

Methods inherited from class javax.swing.plaf.ComponentUI

contains, createUI, getAccessibleChild, getAccessibleChildrenCount, getMaximumSize, getMinimumSize, getPreferredSize, installUI, paint, uninstallUI, update

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarPanelUI

public CalendarPanelUI()

Creates a new CalendarPanelUI.

Method Detail

getRowCount

public abstract int getRowCount(IlvJCalendarPanel calendarPanel)

Returns the number of week rows in the specified calendar panel.

Parameters:

calendarPanel - The calendar panel.

Returns:

The number of week rows.

getColumnCount

public abstract int getColumnCount(IlvJCalendarPanel calendarPanel)

Returns the number of day-of-week columns in the specified calendar panel.

Parameters:

calendarPanel - The calendar panel.

Returns:

The number of day-of-week columns.

getRowHeight

public abstract int getRowHeight(IlvJCalendarPanel calendarPanel)

Returns the height of the week rows in the specified calendar panel.

Parameters:

calendarPanel - The calendar panel.

Returns:

The height of a week row, in pixels.

getColumnWidth

public abstract int getColumnWidth(IlvJCalendarPanel calendarPanel)

Returns the width of the day-of-week columns in the specified calendar panel.

Parameters:

calendarPanel - The calendar panel.

Returns:

The width of a day-of-week column, in pixels.

getCellRect

public abstract Rectangle getCellRect(IlvJCalendarPanel calendarPanel,
                                      int row,
                                      int column)

Returns a rectangle for the day cell that lies at the intersection of the specified week row and day-of-week column. A value of -1 can be specified for the row to indicate the days-of-week header. If the specified cell coordinates are out of range, then null is returned.

Parameters:

calendarPanel - The calendar panel.

row - The week row, or -1 to indicate the days-of-week header.

column - The day-of-week column.

Returns:

The rectangle of the day cell.

getRowAtPoint

public abstract int getRowAtPoint(IlvJCalendarPanel calendarPanel,
                                  Point point)

Returns the index of the week row that point lies in. This method returns -1 if the point lies in the days-of-week header. Otherwise, this method returns -2 if the result is not in the range [0, getRowCount(ilog.views.util.swing.calendar.IlvJCalendarPanel)-1].

Parameters:

calendarPanel - The calendar panel.

point - The location of interest.

Returns:

The index of the week row that point lies in, or -1 if point lies in the days-of-week header, or -2 if the result is not in the range [0, getRowCount(ilog.views.util.swing.calendar.IlvJCalendarPanel)-1].

See Also:

getColumnAtPoint(ilog.views.util.swing.calendar.IlvJCalendarPanel, java.awt.Point)

getColumnAtPoint

public abstract int getColumnAtPoint(IlvJCalendarPanel calendarPanel,
                                     Point point)

Returns the index of the day-of-week column that point lies in. This method returns -1 if the point is not in the range [0, getColumnCount(ilog.views.util.swing.calendar.IlvJCalendarPanel)-1].

Parameters:

calendarPanel - The calendar panel.

point - The location of interest.

Returns:

The index of the day-of-week column that point lies in, or -1 if the result is not in the range [0, getColumnCount(ilog.views.util.swing.calendar.IlvJCalendarPanel)-1].

See Also:

getRowAtPoint(ilog.views.util.swing.calendar.IlvJCalendarPanel, java.awt.Point)

getCellDate

public abstract Calendar getCellDate(IlvJCalendarPanel calendarPanel,
                                     int row,
                                     int column)

Returns the date displayed in the day cell that lies at the intersection of the specified week row and day-of-week column. If the specified cell coordinates are out of range, then null is returned.

Parameters:

calendarPanel - The calendar panel.

row - The week row.

column - The day-of-week column.

Returns:

The date displayed in the day cell.