Join us on the livestream at Android Dev Summit on 7-8 November 2018, starting at 10AM PDT!
added in API level 1

MonthDisplayHelper

public class MonthDisplayHelper
extends Object

java.lang.Object
   ↳ android.util.MonthDisplayHelper


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.

Inherited methods

Public constructors

MonthDisplayHelper

added in API level 1
public MonthDisplayHelper (int year, 
                int month, 
                int weekStartDay)

Parameters
year int: The year.

month int: The month.

weekStartDay int: What day of the week the week should start.

MonthDisplayHelper

added in API level 1
public MonthDisplayHelper (int year, 
                int month)

Parameters
year int

month int

Public methods

getColumnOf

added in API level 1
public int getColumnOf (int day)

Parameters
day int

Returns
int Which column day is in.

getDayAt

added in API level 1
public int getDayAt (int row, 
                int column)

Parameters
row int: The row, 0-5, starting from the top.

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

Returns
int The day at a particular row, column

getDigitsForRow

added in API level 1
public int[] getDigitsForRow (int row)

Parameters
row int: Which row (0-5).

Returns
int[] the digits of the month to display in one of the 6 rows of a calendar month display.

getFirstDayOfMonth

added in API level 1
public int getFirstDayOfMonth ()

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

getMonth

added in API level 1
public int getMonth ()

Returns
int

getNumberOfDaysInMonth

added in API level 1
public int getNumberOfDaysInMonth ()

Returns
int The number of days in the month.

getOffset

added in API level 1
public int getOffset ()

Returns
int 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.

getRowOf

added in API level 1
public int getRowOf (int day)

Parameters
day int

Returns
int Which row day is in.

getWeekStartDay

added in API level 1
public int getWeekStartDay ()

Returns
int

getYear

added in API level 1
public int getYear ()

Returns
int

isWithinCurrentMonth

added in API level 1
public boolean isWithinCurrentMonth (int row, 
                int column)

Parameters
row int

column int

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

nextMonth

added in API level 1
public void nextMonth ()

Increment the month.

previousMonth

added in API level 1
public void previousMonth ()

Decrement the month.