com.wdullaer.materialdatetimepicker.date

Interface DateRangeLimiter

All Superinterfaces:

android.os.Parcelable

public interface DateRangeLimiter
extends android.os.Parcelable

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
java.util.Calendar	getEndDate() getEndDate returns the maximum selectable date of the picker It is called in various places, including the hot loop when rendering.
default int	getMaxYear() getMaxYear returns the maximum selectable year of the picker This method should semantically match getEndDate() It is recommended to keep the default implementation.
default int	getMinYear() getMinYear returns the minimum selectable year of the picker.
java.util.Calendar	getStartDate() getStartDate returns the minimum selectable date of the picker It is called in various places, including the hot loop when rendering.
boolean	isOutOfRange(int year, int month, int day) isOutOfRange is called for each date when it is about to be rendered Returning true from this function will cause that particular day to be non selectable Since this code is called in the inner loop when rendering, it is highly recommended to keep the logic as simple as possible
java.util.Calendar	setToNearestDate(java.util.Calendar day) setToNearestDate rounds a Date to the nearest selectable value.

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Method Detail

getMinYear

default int getMinYear()

getMinYear returns the minimum selectable year of the picker. This method should match getStartDate() It is recommended to keep the default implementation This method will be removed from this interface at the next semver major

Returns:

the minimum selectable year of the picker

getMaxYear

default int getMaxYear()

getMaxYear returns the maximum selectable year of the picker This method should semantically match getEndDate() It is recommended to keep the default implementation. This method will be removed from this interface at the next semver major

Returns:

the maximum selectable year of the picker

getStartDate

java.util.Calendar getStartDate()

getStartDate returns the minimum selectable date of the picker It is called in various places, including the hot loop when rendering. It is highly recommended to keep this method as simple as possible

Returns:

the minimum selectable date of the picker

getEndDate

java.util.Calendar getEndDate()

getEndDate returns the maximum selectable date of the picker It is called in various places, including the hot loop when rendering. It is highly recommended to keep this method as simple as possible

Returns:

the maximum selectable date of the picker

isOutOfRange

boolean isOutOfRange(int year,
                     int month,
                     int day)

isOutOfRange is called for each date when it is about to be rendered Returning true from this function will cause that particular day to be non selectable Since this code is called in the inner loop when rendering, it is highly recommended to keep the logic as simple as possible

Parameters:

year - the year of the date

month - the month of the date

day - the day of the month of the date

Returns:

true if the date should be disabled, false otherwise

setToNearestDate

java.util.Calendar setToNearestDate(java.util.Calendar day)

setToNearestDate rounds a Date to the nearest selectable value. It is called each time the user makes a year selection: the newly resulting date might not be valid according to the constraints set by the limiter. This method is not called when the user selects a day, since the picker prevents the selection of values which satisfy `isOutOfRange`

Parameters:

day - a date with the current user selection

Returns:

the date after rounding to a selectable value