com.imagine.component.calendar.metrics
Class CalendarMetricsProvider

java.lang.Object
  com.imagine.component.calendar.metrics.CalendarMetricsProvider

Direct Known Subclasses:

CalendarMetricsProviderDefault, CalendarMetricsProviderTight

public abstract class CalendarMetricsProvider

extends java.lang.Object

Define a metrics provider. A metrics provider choses the metrics which will be actually used to calculate the table cells size, the header cells size, the week cells size and the status panel size.

Field Summary

protected CalendarComponent

calendarComponent

Constructor Summary

CalendarMetricsProvider()

Method Summary

CalendarComponent	getCalendarComponent() Get the calendar component associated.
abstract CalendarHeaderCellMetrics	getHeaderCellMetrics(CalendarHeaderCellInfo calendarHeaderCellInfo) Get the header cell metrics which will be used to calculate the size of the header cell.
abstract java.lang.String	getName() Get the name of the provider.
abstract CalendarStatusPanelMetrics	getStatusPanelMetrics(CalendarStatusPanelInfo calendarStatusPanelInfo) Get the status panel metrics which will be used to calculate the size of the status panel.
abstract CalendarTableCellMetrics	getTableCellMetrics(CalendarTableCellInfo calendarTableCellInfo) Get the table cell metrics which will be used to calculate the size of the table cell.
abstract CalendarWeekCellMetrics	getWeekCellMetrics(CalendarWeekCellInfo calendarWeekCellInfo) Get the week cell metrics which will be used to calculate the size of the week cell.
void	setCalendarComponent(CalendarComponent calendarComponent) Set the calendar component associated.
java.lang.String	toString() A string representation of this provider.

Methods inherited from class java.lang.Object

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

Field Detail

calendarComponent

protected CalendarComponent calendarComponent

Constructor Detail

CalendarMetricsProvider

public CalendarMetricsProvider()

Method Detail

setCalendarComponent

public final void setCalendarComponent(CalendarComponent calendarComponent)

Set the calendar component associated.

Parameters:

calendarComponent -

getCalendarComponent

public final CalendarComponent getCalendarComponent()

Get the calendar component associated.

Returns:

The calendar component associated.

getTableCellMetrics

public abstract CalendarTableCellMetrics getTableCellMetrics(CalendarTableCellInfo calendarTableCellInfo)

Get the table cell metrics which will be used to calculate the size of the table cell.

Parameters:

calendarTableCellInfo - The calendar table cell info which contains informations about the current table cell.

Returns:

The cell metrics which will be used to calculate the size of the table cell.

getHeaderCellMetrics

public abstract CalendarHeaderCellMetrics getHeaderCellMetrics(CalendarHeaderCellInfo calendarHeaderCellInfo)

Get the header cell metrics which will be used to calculate the size of the header cell.

Parameters:

calendarHeaderCellInfo - The calendar header cell info which contains informations about the current header cell.

Returns:

The cell metrics which will be used to calculate the size of the header cell.

getWeekCellMetrics

public abstract CalendarWeekCellMetrics getWeekCellMetrics(CalendarWeekCellInfo calendarWeekCellInfo)

Get the week cell metrics which will be used to calculate the size of the week cell.

Parameters:

calendarWeekCellInfo - The calendar week cell info which contains informations about the current week cell.

Returns:

The cell metrics which will be used to calculate the size of the week cell.

getStatusPanelMetrics

public abstract CalendarStatusPanelMetrics getStatusPanelMetrics(CalendarStatusPanelInfo calendarStatusPanelInfo)

Get the status panel metrics which will be used to calculate the size of the status panel.

Parameters:

calendarStatusPanelInfo - The calendar status panel info which contains informations about the status panel.

Returns:

The metrics which will be used to calculate the size of the status panel.

getName

public abstract java.lang.String getName()

Get the name of the provider.

Returns:

The name of the provider.

toString

public java.lang.String toString()

A string representation of this provider.