to top
Android APIs
public class

MonthDisplayHelper

extends Object
java.lang.Object
   ↳ android.util.MonthDisplayHelper

Class Overview

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

Summary

Public Constructors
MonthDisplayHelper(int year, int month, int weekStartDay)
MonthDisplayHelper(int year, int month)
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

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

Since: API Level 1

Parameters
year The year.
month The month.
weekStartDay What day of the week the week should start.

public MonthDisplayHelper (int year, int month)

Since: API Level 1

Public Methods

public int getColumnOf (int day)

Since: API Level 1

Returns
  • Which column day is in.

public int getDayAt (int row, int column)

Since: API Level 1

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

public int[] getDigitsForRow (int row)

Since: API Level 1

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.

public int getFirstDayOfMonth ()

Since: API Level 1

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

public int getMonth ()

Since: API Level 1

public int getNumberOfDaysInMonth ()

Since: API Level 1

Returns
  • The number of days in the month.

public int getOffset ()

Since: API Level 1

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.

public int getRowOf (int day)

Since: API Level 1

Returns
  • Which row day is in.

public int getWeekStartDay ()

Since: API Level 1

public int getYear ()

Since: API Level 1

public boolean isWithinCurrentMonth (int row, int column)

Since: API Level 1

Returns
  • Whether the row and column fall within the month.

public void nextMonth ()

Since: API Level 1

Increment the month.

public void previousMonth ()

Since: API Level 1

Decrement the month.