com.wdullaer.materialdatetimepicker.time

Interface TimepointLimiter

All Superinterfaces:

android.os.Parcelable

public interface TimepointLimiter
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
boolean	isAmDisabled() isAmDisabled ndicates whether any times before midday are selectable This method is called when the picker is initialized or when the user clicks / taps the AM or PM buttons.
boolean	isOutOfRange(Timepoint point, int index, Timepoint.TYPE resolution) isOutOfRange indicates whether a particular timepoint is selectable or not It is called multiple times in the rendering path, so it should be fast The index parameter indicates which picker is currently visible.
boolean	isPmDisabled() isPmDisabled ndicates whether any times after midday are selectable This method is called when the picker is initialized or when the user clicks / taps the AM or PM buttons.
Timepoint	roundToNearest(Timepoint time, Timepoint.TYPE type, Timepoint.TYPE resolution) roundToNearest returns the nearest selectable timepoint given a particular input It is called whenever the user touches the screen, which means it can get called very frequently if the user performs a drag operation Both the currently showing picker and the overall resolution are passed in, for similar reasons as in isOutOfRange

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Method Detail

isOutOfRange

boolean isOutOfRange(Timepoint point,
                     int index,
                     Timepoint.TYPE resolution)

isOutOfRange indicates whether a particular timepoint is selectable or not It is called multiple times in the rendering path, so it should be fast The index parameter indicates which picker is currently visible. This is necessary because you typically only want to compare with a resolution up to the visible component. (The implementation should ensure that 8 is selectable, if any valid timepoint with 8 as the hour is selectable, when the hour picker is showing) Similarly the overall resolution of the picker is passed in, because it can impact the comparisons an implementation does (especially when comparing with a disabled list) The scope of this method is most likely too broad, which makes it hard to reason about. It is one of the main reasons the DefaultTimeLimiter implementation of this contains extensive example and generate tests. The default implementation should cover 90% of use cases, but if I ever notice that a substantial amount of people are trying to implement this themselves, it might need to be redesigned.

Parameters:

point - A timepoint to validate

index - The currently showing picker (hour, minute, second)

resolution - The overall resolution of the picker

Returns:

whether the Timepoint is out of range or selectable

isAmDisabled

boolean isAmDisabled()

isAmDisabled ndicates whether any times before midday are selectable This method is called when the picker is initialized or when the user clicks / taps the AM or PM buttons. This means that it's result can't be updated when the picker is already being rendered

Returns:

true if the AM selector should be disabled

isPmDisabled

boolean isPmDisabled()

isPmDisabled ndicates whether any times after midday are selectable This method is called when the picker is initialized or when the user clicks / taps the AM or PM buttons. This means that it's result can't be updated when the picker is already being rendered

Returns:

true if the PM selector should be disabled

roundToNearest

Timepoint roundToNearest(Timepoint time,
                         Timepoint.TYPE type,
                         Timepoint.TYPE resolution)

roundToNearest returns the nearest selectable timepoint given a particular input It is called whenever the user touches the screen, which means it can get called very frequently if the user performs a drag operation Both the currently showing picker and the overall resolution are passed in, for similar reasons as in isOutOfRange

Parameters:

time - the proposed selection

type - the currently showing picker (hour, minute, second)

resolution - the overall resolution of the picker

Returns:

a selectable timepoint