Added in API level 1

Summary: Ctors | Methods | Inherited Methods

MonthDisplayHelper

---

Kotlin |Java

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)
MonthDisplayHelper(int year, int month, int weekStartDay)

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

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

MonthDisplayHelper

Added in API level 1

public MonthDisplayHelper (int year, 
                int month)

Parameters
year	int
month	int

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.

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.