android.util
Class MonthDisplayHelper

java.lang.Object
  android.util.MonthDisplayHelper

public class MonthDisplayHelper
extends Object

Helps answer common questions that come up when displaying a month in a 6 row calendar grid format. Not thread safe.

Constructor Summary

MonthDisplayHelper(int year, int month)

MonthDisplayHelper(int year, int month, int weekStartDay)

Method Summary

int	getColumnOf(int day)
int	getDayAt(int row, int column)
int[]	getDigitsForRow(int row)
int	getFirstDayOfMonth()
int	getMonth()
int	getNumberOfDaysInMonth()
int	getOffset()
int	getRowOf(int day)
int	getWeekStartDay()
int	getYear()
boolean	isWithinCurrentMonth(int row, int column)
void	nextMonth() Increment the month.
void	previousMonth() Decrement the month.

Methods inherited from class java.lang.Object

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

Constructor Detail

MonthDisplayHelper

public MonthDisplayHelper(int year,
                          int month,
                          int weekStartDay)

Parameters:

year - The year.

month - The month.

weekStartDay - What day of the week the week should start.

MonthDisplayHelper

public MonthDisplayHelper(int year,
                          int month)

Method Detail

getYear

public int getYear()

getMonth

public int getMonth()

getWeekStartDay

public int getWeekStartDay()

getFirstDayOfMonth

public int getFirstDayOfMonth()

Returns:

The first day of the month using a constants such as SUNDAY.

getNumberOfDaysInMonth

public int getNumberOfDaysInMonth()

Returns:

The number of days in the month.

getOffset

public int getOffset()

Returns:

The offset from displaying everything starting on the very first box. For example, if the calendar is set to display the first day of the week as Sunday, and the month starts on a Wednesday, the offset is 3.

getDigitsForRow

public int[] getDigitsForRow(int row)

Parameters:

row - Which row (0-5).

Returns:

the digits of the month to display in one of the 6 rows of a calendar month display.

getDayAt

public int getDayAt(int row,
                    int column)

Parameters:

row - The row, 0-5, starting from the top.

column - The column, 0-6, starting from the left.

Returns:

The day at a particular row, column

getRowOf

public int getRowOf(int day)

Returns:

Which row day is in.

getColumnOf

public int getColumnOf(int day)

Returns:

Which column day is in.

previousMonth

public void previousMonth()

Decrement the month.

nextMonth

public void nextMonth()

Increment the month.

isWithinCurrentMonth

public boolean isWithinCurrentMonth(int row,
                                    int column)

Returns:

Whether the row and column fall within the month.