TimePickerDialog (library 1.0.0 API)

java.lang.Object
- android.app.Fragment
- - android.app.DialogFragment
  - - com.kenmeidearu.materialdatetimepicker.time.TimePickerDialog

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, android.content.DialogInterface.OnCancelListener, android.content.DialogInterface.OnDismissListener, android.view.View.OnCreateContextMenuListener, RadialPickerLayout.OnValueSelectedListener, TimePickerController
```
public class TimePickerDialog
extends android.app.DialogFragment
implements RadialPickerLayout.OnValueSelectedListener, TimePickerController
```
Dialog to set a time.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TimePickerDialog.OnTimeSetListener` The callback interface used to indicate the user is done filling in the time (they clicked on the 'Set' button).

Nested classes/interfaces inherited from class android.app.Fragment
android.app.Fragment.InstantiationException, android.app.Fragment.SavedState

Field Summary

Fields
Modifier and Type Field and Description

static int AM

static int HOUR_INDEX

static int MINUTE_INDEX

static int PM

static int SECOND_INDEX
- Fields inherited from class android.app.DialogFragment
  STYLE_NO_FRAME, STYLE_NO_INPUT, STYLE_NO_TITLE, STYLE_NORMAL
- Fields inherited from interface android.content.ComponentCallbacks2
  TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Fields
Modifier and Type	Field and Description
`static int`	`AM`
`static int`	`HOUR_INDEX`
`static int`	`MINUTE_INDEX`
`static int`	`PM`
`static int`	`SECOND_INDEX`

Constructor Summary

Constructors
Constructor and Description

TimePickerDialog()

Constructors
Constructor and Description
`TimePickerDialog()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`advancePicker(int index)`
`void`	`dismissOnPause(boolean dismissOnPause)` Set whether the picker should dismiss itself when it's pausing or whether it should try to survive an orientation change
`void`	`enableMinutes(boolean enableMinutes)` Set whether the picker for minutes should be shown Will disable seconds if minutes are disbled
`void`	`enablePicker()`
`void`	`enableSeconds(boolean enableSeconds)` Set whether an additional picker for seconds should be shown Will enable minutes picker as well if seconds picker should be shown
`int`	`getAccentColor()`
`java.lang.String`	`getTitle()`
`void`	`initialize(TimePickerDialog.OnTimeSetListener callback, int hourOfDay, int minute, int second, boolean is24HourMode)`
`boolean`	`is24HourMode()`
`boolean`	`isAmDisabled()`
`boolean`	`isOutOfRange(Timepoint current)`
`boolean`	`isOutOfRange(Timepoint current, int index)`
`boolean`	`isPmDisabled()`
`boolean`	`isThemeDark()`
`static TimePickerDialog`	`newInstance(TimePickerDialog.OnTimeSetListener callback, int hourOfDay, int minute, boolean is24HourMode)`
`static TimePickerDialog`	`newInstance(TimePickerDialog.OnTimeSetListener callback, int hourOfDay, int minute, int second, boolean is24HourMode)`
`void`	`notifyOnDateListener()`
`void`	`onCancel(android.content.DialogInterface dialog)`
`void`	`onConfigurationChanged(android.content.res.Configuration newConfig)`
`void`	`onCreate(android.os.Bundle savedInstanceState)`
`android.app.Dialog`	`onCreateDialog(android.os.Bundle savedInstanceState)`
`android.view.View`	`onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)`
`void`	`onDismiss(android.content.DialogInterface dialog)`
`void`	`onPause()`
`void`	`onResume()`
`void`	`onSaveInstanceState(android.os.Bundle outState)`
`void`	`onValueSelected(Timepoint newValue)` Called by the picker for updating the header display.
`Timepoint`	`roundToNearest(Timepoint time, Timepoint.TYPE type)` Will round the given Timepoint to the nearest valid Timepoint given the following restrictions: - TYPE.HOUR, it will just round to the next valid point, possible adjusting minutes and seconds - TYPE.MINUTE, it will round to the next valid point, without adjusting the hour, but possibly adjusting the seconds - TYPE.SECOND, it will round to the next valid point, only adjusting the seconds
`void`	`setAccentColor(int color)` Set the accent color of this dialog
`void`	`setAccentColor(java.lang.String color)` Set the accent color of this dialog
`void`	`setCancelText(int cancelResid)` Set the label for the Cancel button (max 12 characters)
`void`	`setCancelText(java.lang.String cancelString)` Set the label for the Cancel button (max 12 characters)
`void`	`setMaxTime(int hour, int minute, int second)`
`void`	`setMaxTime(Timepoint maxTime)`
`void`	`setMinTime(int hour, int minute, int second)`
`void`	`setMinTime(Timepoint minTime)`
`void`	`setOkText(int okResid)` Set the label for the Ok button (max 12 characters)
`void`	`setOkText(java.lang.String okString)` Set the label for the Ok button (max 12 characters)
`void`	`setOnCancelListener(android.content.DialogInterface.OnCancelListener onCancelListener)`
`void`	`setOnDismissListener(android.content.DialogInterface.OnDismissListener onDismissListener)`
`void`	`setOnTimeSetListener(TimePickerDialog.OnTimeSetListener callback)`
`void`	`setSelectableTimes(Timepoint[] selectableTimes)`
`void`	`setStartTime(int hourOfDay, int minute)`
`void`	`setStartTime(int hourOfDay, int minute, int second)`
`void`	`setThemeDark(boolean dark)` Set a dark or light theme.
`void`	`setTimeInterval(int hourInterval)` Set the interval for selectable times in the TimePickerDialog This is a convenience wrapper around setSelectableTimes The interval for all three time components can be set independently
`void`	`setTimeInterval(int hourInterval, int minuteInterval)` Set the interval for selectable times in the TimePickerDialog This is a convenience wrapper around setSelectableTimes The interval for all three time components can be set independently
`void`	`setTimeInterval(int hourInterval, int minuteInterval, int secondInterval)` Set the interval for selectable times in the TimePickerDialog This is a convenience wrapper around setSelectableTimes The interval for all three time components can be set independently
`void`	`setTitle(java.lang.String title)` Set a title.
`void`	`tryVibrate()` Request the device to vibrate
`void`	`vibrate(boolean vibrate)` Set whether the device should vibrate when touching fields

Methods inherited from class android.app.DialogFragment
dismiss, dismissAllowingStateLoss, dump, getDialog, getShowsDialog, getTheme, isCancelable, onActivityCreated, onAttach, onDestroyView, onDetach, onStart, onStop, setCancelable, setShowsDialog, setStyle, show, show

Methods inherited from class android.app.Fragment
equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, hashCode, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isRemoving, isResumed, isVisible, onActivityResult, onAttach, onContextItemSelected, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroy, onDestroyOptionsMenu, onHiddenChanged, onInflate, onInflate, onInflate, onLowMemory, onOptionsItemSelected, onOptionsMenuClosed, onPrepareOptionsMenu, onRequestPermissionsResult, onTrimMemory, onViewCreated, onViewStateRestored, registerForContextMenu, requestPermissions, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - HOUR_INDEX
```
public static final int HOUR_INDEX
```
    See Also:
    
    Constant Field Values
  - MINUTE_INDEX
```
public static final int MINUTE_INDEX
```
    See Also:
    
    Constant Field Values
  - SECOND_INDEX
```
public static final int SECOND_INDEX
```
    See Also:
    
    Constant Field Values
  - AM
```
public static final int AM
```
    See Also:
    
    Constant Field Values
  - PM
```
public static final int PM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TimePickerDialog
```
public TimePickerDialog()
```
- Method Detail
  - newInstance
```
public static TimePickerDialog newInstance(TimePickerDialog.OnTimeSetListener callback,
                                           int hourOfDay,
                                           int minute,
                                           int second,
                                           boolean is24HourMode)
```
  - newInstance
```
public static TimePickerDialog newInstance(TimePickerDialog.OnTimeSetListener callback,
                                           int hourOfDay,
                                           int minute,
                                           boolean is24HourMode)
```
  - initialize
```
public void initialize(TimePickerDialog.OnTimeSetListener callback,
                       int hourOfDay,
                       int minute,
                       int second,
                       boolean is24HourMode)
```
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Set a title. NOTE: this will only take effect with the next onCreateView
  - getTitle
```
public java.lang.String getTitle()
```
  - setThemeDark
```
public void setThemeDark(boolean dark)
```
    Set a dark or light theme. NOTE: this will only take effect for the next onCreateView.
  - setAccentColor
```
public void setAccentColor(java.lang.String color)
```
    Set the accent color of this dialog
    
    Parameters:
    
    color - the accent color you want
  - setAccentColor
```
public void setAccentColor(int color)
```
    Set the accent color of this dialog
    
    Parameters:
    
    color - the accent color you want
  - isThemeDark
```
public boolean isThemeDark()
```
    Specified by:
    
    isThemeDark in interface TimePickerController
    
    Returns:
    
    boolean - true if the dark theme should be used
  - is24HourMode
```
public boolean is24HourMode()
```
    Specified by:
    
    is24HourMode in interface TimePickerController
    
    Returns:
    
    boolean - true if 24 hour mode is used / false if AM/PM is used
  - getAccentColor
```
public int getAccentColor()
```
    Specified by:
    
    getAccentColor in interface TimePickerController
    
    Returns:
    
    int - the accent color currently in use
  - vibrate
```
public void vibrate(boolean vibrate)
```
    Set whether the device should vibrate when touching fields
    
    Parameters:
    
    vibrate - true if the device should vibrate when touching a field
  - dismissOnPause
```
public void dismissOnPause(boolean dismissOnPause)
```
    Set whether the picker should dismiss itself when it's pausing or whether it should try to survive an orientation change
    
    Parameters:
    
    dismissOnPause - true if the picker should dismiss itself
  - enableSeconds
```
public void enableSeconds(boolean enableSeconds)
```
    Set whether an additional picker for seconds should be shown Will enable minutes picker as well if seconds picker should be shown
    
    Parameters:
    
    enableSeconds - true if the seconds picker should be shown
  - enableMinutes
```
public void enableMinutes(boolean enableMinutes)
```
    Set whether the picker for minutes should be shown Will disable seconds if minutes are disbled
    
    Parameters:
    
    enableMinutes - true if minutes picker should be shown
  - setMinTime
```
public void setMinTime(int hour,
                       int minute,
                       int second)
```
  - setMinTime
```
public void setMinTime(Timepoint minTime)
```
  - setMaxTime
```
public void setMaxTime(int hour,
                       int minute,
                       int second)
```
  - setMaxTime
```
public void setMaxTime(Timepoint maxTime)
```
  - setSelectableTimes
```
public void setSelectableTimes(Timepoint[] selectableTimes)
```
  - setTimeInterval
```
public void setTimeInterval(int hourInterval,
                            int minuteInterval,
                            int secondInterval)
```
    Set the interval for selectable times in the TimePickerDialog This is a convenience wrapper around setSelectableTimes The interval for all three time components can be set independently
    
    Parameters:
    
    hourInterval - The interval between 2 selectable hours ([1,24])
    
    minuteInterval - The interval between 2 selectable minutes ([1,60])
    
    secondInterval - The interval between 2 selectable seconds ([1,60])
  - setTimeInterval
```
public void setTimeInterval(int hourInterval,
                            int minuteInterval)
```
    Set the interval for selectable times in the TimePickerDialog This is a convenience wrapper around setSelectableTimes The interval for all three time components can be set independently
    
    Parameters:
    
    hourInterval - The interval between 2 selectable hours ([1,24])
    
    minuteInterval - The interval between 2 selectable minutes ([1,60])
  - setTimeInterval
```
public void setTimeInterval(int hourInterval)
```
    Set the interval for selectable times in the TimePickerDialog This is a convenience wrapper around setSelectableTimes The interval for all three time components can be set independently
    
    Parameters:
    
    hourInterval - The interval between 2 selectable hours ([1,24])
  - setOnTimeSetListener
```
public void setOnTimeSetListener(TimePickerDialog.OnTimeSetListener callback)
```
  - setOnCancelListener
```
public void setOnCancelListener(android.content.DialogInterface.OnCancelListener onCancelListener)
```
  - setOnDismissListener
```
public void setOnDismissListener(android.content.DialogInterface.OnDismissListener onDismissListener)
```
  - setStartTime
```
public void setStartTime(int hourOfDay,
                         int minute,
                         int second)
```
  - setStartTime
```
public void setStartTime(int hourOfDay,
                         int minute)
```
  - setOkText
```
public void setOkText(java.lang.String okString)
```
    Set the label for the Ok button (max 12 characters)
    
    Parameters:
    
    okString - A literal String to be used as the Ok button label
  - setOkText
```
public void setOkText(int okResid)
```
    Set the label for the Ok button (max 12 characters)
    
    Parameters:
    
    okResid - A resource ID to be used as the Ok button label
  - setCancelText
```
public void setCancelText(java.lang.String cancelString)
```
    Set the label for the Cancel button (max 12 characters)
    
    Parameters:
    
    cancelString - A literal String to be used as the Cancel button label
  - setCancelText
```
public void setCancelText(int cancelResid)
```
    Set the label for the Cancel button (max 12 characters)
    
    Parameters:
    
    cancelResid - A resource ID to be used as the Cancel button label
  - onCreate
```
public void onCreate(android.os.Bundle savedInstanceState)
```
    Overrides:
    
    onCreate in class android.app.DialogFragment
  - onCreateView
```
public android.view.View onCreateView(android.view.LayoutInflater inflater,
                                      android.view.ViewGroup container,
                                      android.os.Bundle savedInstanceState)
```
    Overrides:
    
    onCreateView in class android.app.Fragment
  - onConfigurationChanged
```
public void onConfigurationChanged(android.content.res.Configuration newConfig)
```
    Specified by:
    
    onConfigurationChanged in interface android.content.ComponentCallbacks
    
    Overrides:
    
    onConfigurationChanged in class android.app.Fragment
  - onCreateDialog
```
public android.app.Dialog onCreateDialog(android.os.Bundle savedInstanceState)
```
    Overrides:
    
    onCreateDialog in class android.app.DialogFragment
  - onResume
```
public void onResume()
```
    Overrides:
    
    onResume in class android.app.Fragment
  - onPause
```
public void onPause()
```
    Overrides:
    
    onPause in class android.app.Fragment
  - onCancel
```
public void onCancel(android.content.DialogInterface dialog)
```
    Specified by:
    
    onCancel in interface android.content.DialogInterface.OnCancelListener
    
    Overrides:
    
    onCancel in class android.app.DialogFragment
  - onDismiss
```
public void onDismiss(android.content.DialogInterface dialog)
```
    Specified by:
    
    onDismiss in interface android.content.DialogInterface.OnDismissListener
    
    Overrides:
    
    onDismiss in class android.app.DialogFragment
  - tryVibrate
```
public void tryVibrate()
```
    Description copied from interface: TimePickerController
    
    Request the device to vibrate
    
    Specified by:
    
    tryVibrate in interface TimePickerController
  - onSaveInstanceState
```
public void onSaveInstanceState(android.os.Bundle outState)
```
    Overrides:
    
    onSaveInstanceState in class android.app.DialogFragment
  - onValueSelected
```
public void onValueSelected(Timepoint newValue)
```
    Called by the picker for updating the header display.
    
    Specified by:
    
    onValueSelected in interface RadialPickerLayout.OnValueSelectedListener
  - advancePicker
```
public void advancePicker(int index)
```
    Specified by:
    
    advancePicker in interface RadialPickerLayout.OnValueSelectedListener
  - enablePicker
```
public void enablePicker()
```
    Specified by:
    
    enablePicker in interface RadialPickerLayout.OnValueSelectedListener
  - isOutOfRange
```
public boolean isOutOfRange(Timepoint current)
```
  - isOutOfRange
```
public boolean isOutOfRange(Timepoint current,
                            int index)
```
    Specified by:
    
    isOutOfRange in interface TimePickerController
    
    Parameters:
    
    current - Timepoint - the selected point in time
    
    index - int - The current view to consider when calculating the range
    
    Returns:
    
    boolean - true if this is not a selectable value
  - isAmDisabled
```
public boolean isAmDisabled()
```
    Specified by:
    
    isAmDisabled in interface TimePickerController
    
    Returns:
    
    boolean - true if AM times are outside the range of valid selections
  - isPmDisabled
```
public boolean isPmDisabled()
```
    Specified by:
    
    isPmDisabled in interface TimePickerController
    
    Returns:
    
    boolean - true if PM times are outside the range of valid selections
  - roundToNearest
```
public Timepoint roundToNearest(Timepoint time,
                                Timepoint.TYPE type)
```
    Description copied from interface: TimePickerController
    
    Will round the given Timepoint to the nearest valid Timepoint given the following restrictions: - TYPE.HOUR, it will just round to the next valid point, possible adjusting minutes and seconds - TYPE.MINUTE, it will round to the next valid point, without adjusting the hour, but possibly adjusting the seconds - TYPE.SECOND, it will round to the next valid point, only adjusting the seconds
    
    Specified by:
    
    roundToNearest in interface TimePickerController
    
    Parameters:
    
    time - Timepoint - the timepoint to validate
    
    type - Timepoint.TYPE - whether we should round the hours, minutes or seconds
    
    Returns:
    
    timepoint - the nearest valid timepoint
  - notifyOnDateListener
```
public void notifyOnDateListener()
```

Class TimePickerDialog

Nested Class Summary

Nested classes/interfaces inherited from class android.app.Fragment

Field Summary

Fields inherited from class android.app.DialogFragment

Fields inherited from interface android.content.ComponentCallbacks2

Constructor Summary

Method Summary

Methods inherited from class android.app.DialogFragment

Methods inherited from class android.app.Fragment

Methods inherited from class java.lang.Object

Field Detail

HOUR_INDEX

MINUTE_INDEX

SECOND_INDEX

AM

PM

Constructor Detail

TimePickerDialog

Method Detail

newInstance

newInstance

initialize

setTitle

getTitle

setThemeDark

setAccentColor

setAccentColor

isThemeDark

is24HourMode

getAccentColor

vibrate

dismissOnPause

enableSeconds

enableMinutes

setMinTime

setMinTime

setMaxTime

setMaxTime

setSelectableTimes

setTimeInterval

setTimeInterval

setTimeInterval

setOnTimeSetListener

setOnCancelListener

setOnDismissListener

setStartTime

setStartTime

setOkText

setOkText

setCancelText

setCancelText

onCreate

onCreateView

onConfigurationChanged

onCreateDialog

onResume

onPause

onCancel

onDismiss

tryVibrate

onSaveInstanceState

onValueSelected

advancePicker

enablePicker

isOutOfRange

isOutOfRange

isAmDisabled

isPmDisabled

roundToNearest

notifyOnDateListener