Added in API level 1

Summary: Nested Classes | Inherited Constants | Ctors | Methods | Inherited Methods

TimePickerDialog

Kotlin |Java

public class TimePickerDialog
extends AlertDialog implements DialogInterface.OnClickListener, TimePicker.OnTimeChangedListener

java.lang.Object
↳	android.app.Dialog
	↳	android.app.AlertDialog
		↳	android.app.TimePickerDialog

A dialog that prompts the user for the time of day using a TimePicker.

See the Pickers guide.

Summary

Nested classes
`interface`	`TimePickerDialog.OnTimeSetListener` The callback interface used to indicate the user is done filling in the time (e.g. they clicked on the 'OK' button).

Inherited constants

From class android.app.AlertDialog

`int`	`THEME_DEVICE_DEFAULT_DARK` This constant was deprecated in API level 23. Use `R.style.Theme_DeviceDefault_Dialog_Alert`.
`int`	`THEME_DEVICE_DEFAULT_LIGHT` This constant was deprecated in API level 23. Use `R.style.Theme_DeviceDefault_Light_Dialog_Alert`.
`int`	`THEME_HOLO_DARK` This constant was deprecated in API level 23. Use `R.style.Theme_Material_Dialog_Alert`.
`int`	`THEME_HOLO_LIGHT` This constant was deprecated in API level 23. Use `R.style.Theme_Material_Light_Dialog_Alert`.
`int`	`THEME_TRADITIONAL` This constant was deprecated in API level 23. Use `R.style.Theme_Material_Dialog_Alert`.

From interface android.content.DialogInterface

`int`	`BUTTON1` This constant was deprecated in API level 15. Use `BUTTON_POSITIVE`
`int`	`BUTTON2` This constant was deprecated in API level 15. Use `BUTTON_NEGATIVE`
`int`	`BUTTON3` This constant was deprecated in API level 15. Use `BUTTON_NEUTRAL`
`int`	`BUTTON_NEGATIVE` The identifier for the negative button.
`int`	`BUTTON_NEUTRAL` The identifier for the neutral button.
`int`	`BUTTON_POSITIVE` The identifier for the positive button.

Public constructors
`TimePickerDialog(Context context, TimePickerDialog.OnTimeSetListener listener, int hourOfDay, int minute, boolean is24HourView)` Creates a new time picker dialog.
`TimePickerDialog(Context context, int themeResId, TimePickerDialog.OnTimeSetListener listener, int hourOfDay, int minute, boolean is24HourView)` Creates a new time picker dialog with the specified theme.

Public methods
`void`	`onClick(DialogInterface dialog, int which)` This method will be invoked when a button in the dialog is clicked.
`void`	`onRestoreInstanceState(Bundle savedInstanceState)` Restore the state of the dialog from a previously saved bundle.
`Bundle`	`onSaveInstanceState()` Saves the state of the dialog into a bundle.
`void`	`onTimeChanged(TimePicker view, int hourOfDay, int minute)`
`void`	`show()` Start the dialog and display it on screen.
`void`	`updateTime(int hourOfDay, int minuteOfHour)` Sets the current time.

Inherited methods

From class


        
          android.app.AlertDialog

`Button`	`getButton(int whichButton)` Gets one of the buttons used in the dialog.
`ListView`	`getListView()` Gets the list view used in the dialog.
`void`	`onCreate(Bundle savedInstanceState)` Similar to `Activity.onCreate`, you should initialize your dialog in this method, including calling `setContentView(View)`.
`boolean`	`onKeyDown(int keyCode, KeyEvent event)` A key was pressed down.
`boolean`	`onKeyUp(int keyCode, KeyEvent event)` A key was released.
`void`	`setButton(CharSequence text, DialogInterface.OnClickListener listener)` This method was deprecated in API level 15. Use `setButton(int, java.lang.CharSequence, android.content.DialogInterface.OnClickListener)` with `DialogInterface.BUTTON_POSITIVE`
`void`	`setButton(int whichButton, CharSequence text, DialogInterface.OnClickListener listener)` Set a listener to be invoked when the specified button of the dialog is pressed.
`void`	`setButton(CharSequence text, Message msg)` This method was deprecated in API level 15. Use `setButton(int, java.lang.CharSequence, android.os.Message)` with `DialogInterface.BUTTON_POSITIVE`.
`void`	`setButton(int whichButton, CharSequence text, Message msg)` Set a message to be sent when a button is pressed.
`void`	`setButton2(CharSequence text, Message msg)` This method was deprecated in API level 15. Use `setButton(int, java.lang.CharSequence, android.os.Message)` with `DialogInterface.BUTTON_NEGATIVE`.
`void`	`setButton2(CharSequence text, DialogInterface.OnClickListener listener)` This method was deprecated in API level 15. Use `setButton(int, java.lang.CharSequence, android.content.DialogInterface.OnClickListener)` with `DialogInterface.BUTTON_NEGATIVE`
`void`	`setButton3(CharSequence text, Message msg)` This method was deprecated in API level 15. Use `setButton(int, java.lang.CharSequence, android.os.Message)` with `DialogInterface.BUTTON_NEUTRAL`.
`void`	`setButton3(CharSequence text, DialogInterface.OnClickListener listener)` This method was deprecated in API level 15. Use `setButton(int, java.lang.CharSequence, android.content.DialogInterface.OnClickListener)` with `DialogInterface.BUTTON_NEUTRAL`
`void`	`setCustomTitle(View customTitleView)`
`void`	`setIcon(Drawable icon)`
`void`	`setIcon(int resId)` Set resId to 0 if you don't want an icon.
`void`	`setIconAttribute(int attrId)` Set an icon as supplied by a theme attribute.
`void`	`setInverseBackgroundForced(boolean forceInverseBackground)`
`void`	`setMessage(CharSequence message)`
`void`	`setTitle(CharSequence title)` Set the title text for this dialog's window.
`void`	`setView(View view, int viewSpacingLeft, int viewSpacingTop, int viewSpacingRight, int viewSpacingBottom)` Set the view to display in that dialog, specifying the spacing to appear around that view.
`void`	`setView(View view)` Set the view to display in that dialog.

From class


        
          android.app.Dialog

`void`	`addContentView(View view, ViewGroup.LayoutParams params)` Add an additional content view to the screen.
`void`	`cancel()` Cancel the dialog.
`void`	`closeOptionsMenu()`
`void`	`create()` Forces immediate creation of the dialog.
`void`	`dismiss()` Dismiss this dialog, removing it from the screen.
`boolean`	`dispatchGenericMotionEvent(MotionEvent ev)` Called to process generic motion events.
`boolean`	`dispatchKeyEvent(KeyEvent event)` Called to process key events.
`boolean`	`dispatchKeyShortcutEvent(KeyEvent event)` Called to process a key shortcut event.
`boolean`	`dispatchPopulateAccessibilityEvent(AccessibilityEvent event)` Called to process population of `AccessibilityEvent`s.
`boolean`	`dispatchTouchEvent(MotionEvent ev)` Called to process touch screen events.
`boolean`	`dispatchTrackballEvent(MotionEvent ev)` Called to process trackball events.
`<T extends View> T`	`findViewById(int id)` Finds the first descendant view with the given ID or `null` if the ID is invalid (< 0), there is no matching view in the hierarchy, or the dialog has not yet been fully created (for example, via `show()` or `create()`).
`ActionBar`	`getActionBar()` Retrieve the `ActionBar` attached to this dialog, if present.
`final Context`	`getContext()` Retrieve the Context this Dialog is running in.
`View`	`getCurrentFocus()` Call `Window.getCurrentFocus()` on the Window if this Activity to return the currently focused view.
`LayoutInflater`	`getLayoutInflater()`
`OnBackInvokedDispatcher`	`getOnBackInvokedDispatcher()` Returns the `OnBackInvokedDispatcher` instance associated with the window that this dialog is attached to.
`final Activity`	`getOwnerActivity()` Returns the Activity that owns this Dialog.
`final SearchEvent`	`getSearchEvent()` During the onSearchRequested() callbacks, this function will return the `SearchEvent` that triggered the callback, if it exists.
`final int`	`getVolumeControlStream()`
`Window`	`getWindow()` Retrieve the current Window for the activity.
`void`	`hide()` Hide the dialog, but do not dismiss it.
`void`	`invalidateOptionsMenu()`
`boolean`	`isShowing()`
`void`	`onActionModeFinished(ActionMode mode)` Called when an action mode has been finished. Note that if you override this method you should always call through to the superclass implementation by calling super.onActionModeFinished(mode).
`void`	`onActionModeStarted(ActionMode mode)` Called when an action mode has been started. Note that if you override this method you should always call through to the superclass implementation by calling super.onActionModeStarted(mode).
`void`	`onAttachedToWindow()` Called when the window has been attached to the window manager.
`void`	`onBackPressed()` This method was deprecated in API level 33. Use `OnBackInvokedCallback` or `androidx.activity.OnBackPressedCallback` to handle back navigation instead. Starting from Android 13 (API level 33), back event handling is moving to an ahead-of-time model and `onBackPressed()` and `KeyEvent.KEYCODE_BACK` should not be used to handle back events (back gesture or back button click). Instead, an `OnBackInvokedCallback` should be registered using `Dialog.getOnBackInvokedDispatcher()` `.registerOnBackInvokedCallback(priority, callback)`.
`void`	`onContentChanged()` This hook is called whenever the content view of the screen changes (due to a call to `Window.setContentView` or `Window.addContentView`).
`boolean`	`onContextItemSelected(MenuItem item)`
`void`	`onContextMenuClosed(Menu menu)`
`void`	`onCreate(Bundle savedInstanceState)` Similar to `Activity.onCreate`, you should initialize your dialog in this method, including calling `setContentView(View)`.
`void`	`onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)` Called when the context menu for this view is being built.
`boolean`	`onCreateOptionsMenu(Menu menu)` It is usually safe to proxy this call to the owner activity's `Activity.onCreateOptionsMenu(Menu)` if the client desires the same menu for this Dialog.
`boolean`	`onCreatePanelMenu(int featureId, Menu menu)` Initialize the contents of the menu for panel 'featureId'.
`View`	`onCreatePanelView(int featureId)` Instantiate the view to display in the panel for 'featureId'.
`void`	`onDetachedFromWindow()` Called when the window has been detached from the window manager.
`boolean`	`onGenericMotionEvent(MotionEvent event)` Called when a generic motion event was not handled by any of the views inside of the dialog.
`boolean`	`onKeyDown(int keyCode, KeyEvent event)` A key was pressed down.
`boolean`	`onKeyLongPress(int keyCode, KeyEvent event)` Default implementation of `KeyEvent.Callback.onKeyLongPress()`: always returns false (doesn't handle the event).
`boolean`	`onKeyMultiple(int keyCode, int repeatCount, KeyEvent event)` Default implementation of `KeyEvent.Callback.onKeyMultiple()`: always returns false (doesn't handle the event).
`boolean`	`onKeyShortcut(int keyCode, KeyEvent event)` Called when a key shortcut event is not handled by any of the views in the Dialog.
`boolean`	`onKeyUp(int keyCode, KeyEvent event)` A key was released.
`boolean`	`onMenuItemSelected(int featureId, MenuItem item)` Called when a panel's menu item has been selected by the user.
`boolean`	`onMenuOpened(int featureId, Menu menu)` Called when a panel's menu is opened by the user.
`boolean`	`onOptionsItemSelected(MenuItem item)`
`void`	`onOptionsMenuClosed(Menu menu)`
`void`	`onPanelClosed(int featureId, Menu menu)` Called when a panel is being closed.
`boolean`	`onPrepareOptionsMenu(Menu menu)` It is usually safe to proxy this call to the owner activity's `Activity.onPrepareOptionsMenu(Menu)` if the client desires the same menu for this Dialog.
`boolean`	`onPreparePanel(int featureId, View view, Menu menu)` Prepare a panel to be displayed.
`void`	`onRestoreInstanceState(Bundle savedInstanceState)` Restore the state of the dialog from a previously saved bundle.
`Bundle`	`onSaveInstanceState()` Saves the state of the dialog into a bundle.
`boolean`	`onSearchRequested(SearchEvent searchEvent)` This hook is called when the user signals the desire to start a search.
`boolean`	`onSearchRequested()` This hook is called when the user signals the desire to start a search.
`void`	`onStart()` Called when the dialog is starting.
`void`	`onStop()` Called to tell you that you're stopping.
`boolean`	`onTouchEvent(MotionEvent event)` Called when a touch screen event was not handled by any of the views under it.
`boolean`	`onTrackballEvent(MotionEvent event)` Called when the trackball was moved and not handled by any of the views inside of the activity.
`void`	`onWindowAttributesChanged(WindowManager.LayoutParams params)` This is called whenever the current window attributes change.
`void`	`onWindowFocusChanged(boolean hasFocus)` This hook is called whenever the window focus changes.
`ActionMode`	`onWindowStartingActionMode(ActionMode.Callback callback)` Called when an action mode is being started for this window.
`ActionMode`	`onWindowStartingActionMode(ActionMode.Callback callback, int type)` Called when an action mode is being started for this window.
`void`	`openContextMenu(View view)`
`void`	`openOptionsMenu()`
`void`	`registerForContextMenu(View view)`
`final boolean`	`requestWindowFeature(int featureId)` Enable extended window features.
`final <T extends View> T`	`requireViewById(int id)` Finds the first descendant view with the given ID or throws an IllegalArgumentException if the ID is invalid (< 0), there is no matching view in the hierarchy, or the dialog has not yet been fully created (for example, via `show()` or `create()`).
`void`	`setCancelMessage(Message msg)` Set a message to be sent when the dialog is canceled.
`void`	`setCancelable(boolean flag)` Sets whether this dialog is cancelable with the `BACK` key.
`void`	`setCanceledOnTouchOutside(boolean cancel)` Sets whether this dialog is canceled when touched outside the window's bounds.
`void`	`setContentView(int layoutResID)` Set the screen content from a layout resource.
`void`	`setContentView(View view, ViewGroup.LayoutParams params)` Set the screen content to an explicit view.
`void`	`setContentView(View view)` Set the screen content to an explicit view.
`void`	`setDismissMessage(Message msg)` Set a message to be sent when the dialog is dismissed.
`final void`	`setFeatureDrawable(int featureId, Drawable drawable)` Convenience for calling `Window.setFeatureDrawable(int, Drawable)`.
`final void`	`setFeatureDrawableAlpha(int featureId, int alpha)` Convenience for calling `Window.setFeatureDrawableAlpha(int, int)`.
`final void`	`setFeatureDrawableResource(int featureId, int resId)` Convenience for calling `Window.setFeatureDrawableResource(int, int)`.
`final void`	`setFeatureDrawableUri(int featureId, Uri uri)` Convenience for calling `Window.setFeatureDrawableUri(int, Uri)`.
`void`	`setOnCancelListener(DialogInterface.OnCancelListener listener)` Set a listener to be invoked when the dialog is canceled.
`void`	`setOnDismissListener(DialogInterface.OnDismissListener listener)` Set a listener to be invoked when the dialog is dismissed.
`void`	`setOnKeyListener(DialogInterface.OnKeyListener onKeyListener)` Sets the callback that will be called if a key is dispatched to the dialog.
`void`	`setOnShowListener(DialogInterface.OnShowListener listener)` Sets a listener to be invoked when the dialog is shown.
`final void`	`setOwnerActivity(Activity activity)` Sets the Activity that owns this dialog.
`void`	`setTitle(CharSequence title)` Set the title text for this dialog's window.
`void`	`setTitle(int titleId)` Set the title text for this dialog's window.
`final void`	`setVolumeControlStream(int streamType)` By default, this will use the owner Activity's suggested stream type.
`void`	`show()` Start the dialog and display it on screen.
`void`	`takeKeyEvents(boolean get)` Request that key events come to this dialog.
`void`	`unregisterForContextMenu(View view)`

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.

From interface


        
          android.content.DialogInterface

`abstract void`	`cancel()` Cancels the dialog, invoking the `OnCancelListener`.
`abstract void`	`dismiss()` Dismisses the dialog, invoking the `OnDismissListener`.

From interface


        
          android.view.KeyEvent.Callback

`abstract boolean`	`onKeyDown(int keyCode, KeyEvent event)` Called when a key down event has occurred.
`abstract boolean`	`onKeyLongPress(int keyCode, KeyEvent event)` Called when a long press has occurred.
`abstract boolean`	`onKeyMultiple(int keyCode, int count, KeyEvent event)` Called when a user's interaction with an analog control, such as flinging a trackball, generates simulated down/up events for the same key multiple times in quick succession.
`abstract boolean`	`onKeyUp(int keyCode, KeyEvent event)` Called when a key up event has occurred.

From interface


        
          android.view.View.OnCreateContextMenuListener


      onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)

Called when the context menu for this view is being built.

From interface


        
          android.view.Window.Callback

`abstract boolean`	`dispatchGenericMotionEvent(MotionEvent event)` Called to process generic motion events.
`abstract boolean`	`dispatchKeyEvent(KeyEvent event)` Called to process key events.
`abstract boolean`	`dispatchKeyShortcutEvent(KeyEvent event)` Called to process a key shortcut event.
`abstract boolean`	`dispatchPopulateAccessibilityEvent(AccessibilityEvent event)` Called to process population of `AccessibilityEvent`s.
`abstract boolean`	`dispatchTouchEvent(MotionEvent event)` Called to process touch screen events.
`abstract boolean`	`dispatchTrackballEvent(MotionEvent event)` Called to process trackball events.
`abstract void`	`onActionModeFinished(ActionMode mode)` Called when an action mode has been finished.
`abstract void`	`onActionModeStarted(ActionMode mode)` Called when an action mode has been started.
`abstract void`	`onAttachedToWindow()` Called when the window has been attached to the window manager.
`abstract void`	`onContentChanged()` This hook is called whenever the content view of the screen changes (due to a call to `Window.setContentView` or `Window.addContentView`).
`abstract boolean`	`onCreatePanelMenu(int featureId, Menu menu)` Initialize the contents of the menu for panel 'featureId'.
`abstract View`	`onCreatePanelView(int featureId)` Instantiate the view to display in the panel for 'featureId'.
`abstract void`	`onDetachedFromWindow()` Called when the window has been detached from the window manager.
`abstract boolean`	`onMenuItemSelected(int featureId, MenuItem item)` Called when a panel's menu item has been selected by the user.
`abstract boolean`	`onMenuOpened(int featureId, Menu menu)` Called when a panel's menu is opened by the user.
`abstract void`	`onPanelClosed(int featureId, Menu menu)` Called when a panel is being closed.
`default void`	`onPointerCaptureChanged(boolean hasCapture)` Called when pointer capture is enabled or disabled for the current window.
`abstract boolean`	`onPreparePanel(int featureId, View view, Menu menu)` Prepare a panel to be displayed.
`default void`	`onProvideKeyboardShortcuts(List<KeyboardShortcutGroup> data, Menu menu, int deviceId)` Called when Keyboard Shortcuts are requested for the current window.
`abstract boolean`	`onSearchRequested()` Called when the user signals the desire to start a search.
`abstract boolean`	`onSearchRequested(SearchEvent searchEvent)` Called when the user signals the desire to start a search.
`abstract void`	`onWindowAttributesChanged(WindowManager.LayoutParams attrs)` This is called whenever the current window attributes change.
`abstract void`	`onWindowFocusChanged(boolean hasFocus)` This hook is called whenever the window focus changes.
`abstract ActionMode`	`onWindowStartingActionMode(ActionMode.Callback callback)` Called when an action mode is being started for this window.
`abstract ActionMode`	`onWindowStartingActionMode(ActionMode.Callback callback, int type)` Called when an action mode is being started for this window.

From interface


        
          android.content.DialogInterface.OnClickListener


      onClick(DialogInterface dialog, int which)

This method will be invoked when a button in the dialog is clicked.

From interface


        
          android.widget.TimePicker.OnTimeChangedListener

abstract void onTimeChanged(TimePicker view, int hourOfDay, int minute)

Public constructors

TimePickerDialog

Added in API level 1

public TimePickerDialog (Context context, 
                TimePickerDialog.OnTimeSetListener listener, 
                int hourOfDay, 
                int minute, 
                boolean is24HourView)

Creates a new time picker dialog.

Parameters
`context`	`Context`: the parent context
`listener`	`TimePickerDialog.OnTimeSetListener`: the listener to call when the time is set
`hourOfDay`	`int`: the initial hour
`minute`	`int`: the initial minute
`is24HourView`	`boolean`: whether this is a 24 hour view or AM/PM

TimePickerDialog

Added in API level 1

public TimePickerDialog (Context context, 
                int themeResId, 
                TimePickerDialog.OnTimeSetListener listener, 
                int hourOfDay, 
                int minute, 
                boolean is24HourView)

Creates a new time picker dialog with the specified theme.

The theme is overlaid on top of the theme of the parent context. If themeResId is 0, the dialog will be inflated using the theme specified by the android:timePickerDialogTheme attribute on the parent context's theme.

Parameters
`context`	`Context`: the parent context
`themeResId`	`int`: the resource ID of the theme to apply to this dialog
`listener`	`TimePickerDialog.OnTimeSetListener`: the listener to call when the time is set
`hourOfDay`	`int`: the initial hour
`minute`	`int`: the initial minute
`is24HourView`	`boolean`: Whether this is a 24 hour view, or AM/PM.

Public methods

onClick

Added in API level 1

public void onClick (DialogInterface dialog, 
                int which)

This method will be invoked when a button in the dialog is clicked.

Parameters
`dialog`	`DialogInterface`: the dialog that received the click
`which`	`int`: the button that was clicked (ex. `DialogInterface.BUTTON_POSITIVE`) or the position of the item clicked

onRestoreInstanceState

Added in API level 1

public void onRestoreInstanceState (Bundle savedInstanceState)

Restore the state of the dialog from a previously saved bundle. The default implementation restores the state of the dialog's view hierarchy that was saved in the default implementation of onSaveInstanceState(), so be sure to call through to super when overriding unless you want to do all restoring of state yourself.

Parameters
`savedInstanceState`	`Bundle`: The state of the dialog previously saved by `onSaveInstanceState()`. This value cannot be `null`.

onSaveInstanceState

Added in API level 1

public Bundle onSaveInstanceState ()

Saves the state of the dialog into a bundle. The default implementation saves the state of its view hierarchy, so you'll likely want to call through to super if you override this to save additional state.

Returns
`Bundle`	A bundle with the state of the dialog. This value cannot be `null`.

Added in API level 1

public void onTimeChanged (TimePicker view, 
                int hourOfDay, 
                int minute)

Parameters
`view`	`TimePicker`
`hourOfDay`	`int`
`minute`	`int`

show

Added in API level 1

public void show ()

Start the dialog and display it on screen. The window is placed in the application layer and opaque. Note that you should not override this method to do initialization when the dialog is shown, instead implement that in onStart().

updateTime

Added in API level 1

public void updateTime (int hourOfDay, 
                int minuteOfHour)

Sets the current time.

Parameters
`hourOfDay`	`int`: The current hour within the day.
`minuteOfHour`	`int`: The current minute within the hour.

TimePickerDialog

Summary

Nested classes

Inherited constants

Public constructors

Public methods

Inherited methods

Public constructors

TimePickerDialog

TimePickerDialog

Public methods

onClick

onRestoreInstanceState

onSaveInstanceState

onTimeChanged

show

updateTime