DatePickerDialog (library API)

java.lang.Object
- AppCompatDialogFragment
- - com.wdullaer.materialdatetimepicker.date.DatePickerDialog

All Implemented Interfaces:: android.view.View.OnClickListener, DatePickerController

public class DatePickerDialog
extends AppCompatDialogFragment
implements android.view.View.OnClickListener, DatePickerController

Dialog allowing users to select a date.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`DatePickerDialog.OnDateChangedListener` The callback used to notify other date picker components of a change in selected date.
`static interface`	`DatePickerDialog.OnDateSetListener` The callback used to indicate the user is done filling in the date.
`static class`	`DatePickerDialog.ScrollOrientation`
`static class`	`DatePickerDialog.Version`

Constructor Summary

Constructors
Constructor and Description

DatePickerDialog()

Constructors
Constructor and Description
`DatePickerDialog()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`autoDismiss(boolean autoDismiss)` Set whether the picker should dismiss itself when a day is selected
`void`	`dismissOnPause(boolean dismissOnPause)` Set whether the picker should dismiss itself when being paused or whether it should try to survive an orientation change
`int`	`getAccentColor()` Get the accent color of this dialog
`java.util.Calendar[]`	`getDisabledDays()`
`java.util.Calendar`	`getEndDate()`
`int`	`getFirstDayOfWeek()`
`java.util.Calendar[]`	`getHighlightedDays()`
`java.util.Locale`	`getLocale()` Return the current locale (default or other)
`java.util.Calendar`	`getMaxDate()`
`int`	`getMaxYear()`
`java.util.Calendar`	`getMinDate()`
`int`	`getMinYear()`
`DatePickerDialog.OnDateSetListener`	`getOnDateSetListener()` Get a reference to the callback
`DatePickerDialog.ScrollOrientation`	`getScrollOrientation()` Get which way the user needs to swipe to switch months in the MonthView
`java.util.Calendar[]`	`getSelectableDays()`
`MonthAdapter.CalendarDay`	`getSelectedDay()`
`java.util.Calendar`	`getStartDate()`
`java.util.TimeZone`	`getTimeZone()`
`DatePickerDialog.Version`	`getVersion()` Get the layout version the Dialog is using
`void`	`initialize(DatePickerDialog.OnDateSetListener callBack, java.util.Calendar initialSelection)`
`void`	`initialize(DatePickerDialog.OnDateSetListener callBack, int year, int monthOfYear, int dayOfMonth)`
`boolean`	`isHighlighted(int year, int month, int day)`
`boolean`	`isOutOfRange(int year, int month, int day)`
`boolean`	`isThemeDark()` Returns true when the dark theme should be used
`static DatePickerDialog`	`newInstance(DatePickerDialog.OnDateSetListener callback)` Create a new DatePickerDialog instance initialised to the current system date.
`static DatePickerDialog`	`newInstance(DatePickerDialog.OnDateSetListener callback, java.util.Calendar initialSelection)` Create a new DatePickerDialog instance with a specific initial selection.
`static DatePickerDialog`	`newInstance(DatePickerDialog.OnDateSetListener callBack, int year, int monthOfYear, int dayOfMonth)` Create a new DatePickerDialog instance with a specific initial selection.
`void`	`notifyOnDateListener()`
`void`	`onCancel(android.content.DialogInterface dialog)`
`void`	`onClick(android.view.View v)`
`void`	`onConfigurationChanged(android.content.res.Configuration newConfig)`
`void`	`onCreate(android.os.Bundle savedInstanceState)`
`android.view.View`	`onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)`
`void`	`onDayOfMonthSelected(int year, int month, int day)`
`void`	`onDismiss(android.content.DialogInterface dialog)`
`void`	`onPause()`
`void`	`onResume()`
`void`	`onSaveInstanceState(android.os.Bundle outState)`
`void`	`onYearSelected(int year)`
`void`	`registerOnDateChangedListener(DatePickerDialog.OnDateChangedListener listener)`
`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`	`setCancelColor(int color)` Set the text color of the Cancel button
`void`	`setCancelColor(java.lang.String color)` Set the text color of the Cancel button
`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`	`setDateRangeLimiter(DateRangeLimiter dateRangeLimiter)` Provide a DateRangeLimiter for full control over which dates are enabled and disabled in the picker
`void`	`setDisabledDays(java.util.Calendar[] disabledDays)` Sets a list of days that are not selectable in the picker Setting this value will take precedence over using setMinDate() and setMaxDate(), but stacks with setSelectableDays()
`void`	`setFirstDayOfWeek(int startOfWeek)`
`void`	`setHighlightedDays(java.util.Calendar[] highlightedDays)` Sets an array of dates which should be highlighted when the picker is drawn
`void`	`setLocale(java.util.Locale locale)` Set a custom locale to be used when generating various strings in the picker
`void`	`setMaxDate(java.util.Calendar calendar)` Sets the minimal date supported by this DatePicker.
`void`	`setMinDate(java.util.Calendar calendar)` Sets the minimal date supported by this DatePicker.
`void`	`setOkColor(int color)` Set the text color of the OK button
`void`	`setOkColor(java.lang.String color)` Set the text color of the OK button
`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`	`setOnDateSetListener(DatePickerDialog.OnDateSetListener listener)`
`void`	`setOnDismissListener(android.content.DialogInterface.OnDismissListener onDismissListener)`
`void`	`setScrollOrientation(DatePickerDialog.ScrollOrientation orientation)` Set which way the user needs to swipe to switch months in the MonthView
`void`	`setSelectableDays(java.util.Calendar[] selectableDays)` Sets a list of days which are the only valid selections.
`void`	`setThemeDark(boolean themeDark)` Set whether the dark theme should be used
`void`	`setTimeZone(java.util.TimeZone timeZone)` Deprecated.
`void`	`setTitle(java.lang.String title)` Set a title to be displayed instead of the weekday
`void`	`setVersion(DatePickerDialog.Version version)` Set which layout version the picker should use
`void`	`setYearRange(int startYear, int endYear)`
`void`	`showYearPickerFirst(boolean yearPicker)` Set whether the year picker of the month and day picker is shown first
`void`	`tryVibrate()`
`void`	`unregisterOnDateChangedListener(DatePickerDialog.OnDateChangedListener listener)`
`void`	`vibrate(boolean vibrate)` Set whether the device should vibrate when touching fields

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

- Constructor Detail
  - DatePickerDialog
```
public DatePickerDialog()
```
- Method Detail
  - newInstance
```
public static DatePickerDialog newInstance(DatePickerDialog.OnDateSetListener callBack,
                                           int year,
                                           int monthOfYear,
                                           int dayOfMonth)
```
    Create a new DatePickerDialog instance with a specific initial selection.
    
    Parameters:
    
    callBack - How the parent is notified that the date is set.
    
    year - The initial year of the dialog.
    
    monthOfYear - The initial month of the dialog.
    
    dayOfMonth - The initial day of the dialog.
    
    Returns:
    
    a new DatePickerDialog instance.
  - newInstance
```
public static DatePickerDialog newInstance(DatePickerDialog.OnDateSetListener callback)
```
    Create a new DatePickerDialog instance initialised to the current system date.
    
    Parameters:
    
    callback - How the parent is notified that the date is set.
    
    Returns:
    
    a new DatePickerDialog instance
  - newInstance
```
public static DatePickerDialog newInstance(DatePickerDialog.OnDateSetListener callback,
                                           java.util.Calendar initialSelection)
```
    Create a new DatePickerDialog instance with a specific initial selection.
    
    Parameters:
    
    callback - How the parent is notified that the date is set.
    
    initialSelection - A Calendar object containing the original selection of the picker. (Time is ignored by trimming the Calendar to midnight in the current TimeZone of the Calendar object)
    
    Returns:
    
    a new DatePickerDialog instance
  - initialize
```
public void initialize(DatePickerDialog.OnDateSetListener callBack,
                       java.util.Calendar initialSelection)
```
  - initialize
```
public void initialize(DatePickerDialog.OnDateSetListener callBack,
                       int year,
                       int monthOfYear,
                       int dayOfMonth)
```
  - onCreate
```
public void onCreate(android.os.Bundle savedInstanceState)
```
  - onSaveInstanceState
```
public void onSaveInstanceState(android.os.Bundle outState)
```
  - onCreateView
```
public android.view.View onCreateView(android.view.LayoutInflater inflater,
                                      android.view.ViewGroup container,
                                      android.os.Bundle savedInstanceState)
```
  - onConfigurationChanged
```
public void onConfigurationChanged(android.content.res.Configuration newConfig)
```
  - onResume
```
public void onResume()
```
  - onPause
```
public void onPause()
```
  - onCancel
```
public void onCancel(android.content.DialogInterface dialog)
```
  - onDismiss
```
public void onDismiss(android.content.DialogInterface dialog)
```
  - 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 being paused or whether it should try to survive an orientation change
    
    Parameters:
    
    dismissOnPause - true if the dialog should dismiss itself when it's pausing
  - autoDismiss
```
public void autoDismiss(boolean autoDismiss)
```
    Set whether the picker should dismiss itself when a day is selected
    
    Parameters:
    
    autoDismiss - true if the dialog should dismiss itself when a day is selected
  - setThemeDark
```
public void setThemeDark(boolean themeDark)
```
    Set whether the dark theme should be used
    
    Parameters:
    
    themeDark - true if the dark theme should be used, false if the default theme should be used
  - isThemeDark
```
public boolean isThemeDark()
```
    Returns true when the dark theme should be used
    
    Specified by:
    
    isThemeDark in interface DatePickerController
    
    Returns:
    
    true if the dark theme should be used, false if the default theme should be used
  - 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
  - setOkColor
```
public void setOkColor(java.lang.String color)
```
    Set the text color of the OK button
    
    Parameters:
    
    color - the color you want
  - setOkColor
```
public void setOkColor(int color)
```
    Set the text color of the OK button
    
    Parameters:
    
    color - the color you want
  - setCancelColor
```
public void setCancelColor(java.lang.String color)
```
    Set the text color of the Cancel button
    
    Parameters:
    
    color - the color you want
  - setCancelColor
```
public void setCancelColor(int color)
```
    Set the text color of the Cancel button
    
    Parameters:
    
    color - the color you want
  - getAccentColor
```
public int getAccentColor()
```
    Get the accent color of this dialog
    
    Specified by:
    
    getAccentColor in interface DatePickerController
    
    Returns:
    
    accent color
  - showYearPickerFirst
```
public void showYearPickerFirst(boolean yearPicker)
```
    Set whether the year picker of the month and day picker is shown first
    
    Parameters:
    
    yearPicker - boolean
  - setFirstDayOfWeek
```
public void setFirstDayOfWeek(int startOfWeek)
```
  - setYearRange
```
public void setYearRange(int startYear,
                         int endYear)
```
  - setMinDate
```
public void setMinDate(java.util.Calendar calendar)
```
    Sets the minimal date supported by this DatePicker. Dates before (but not including) the specified date will be disallowed from being selected.
    
    Parameters:
    
    calendar - a Calendar object set to the year, month, day desired as the mindate.
  - getMinDate
```
public java.util.Calendar getMinDate()
```
    Returns:
    
    The minimal date supported by this DatePicker. Null if it has not been set.
  - setMaxDate
```
public void setMaxDate(java.util.Calendar calendar)
```
    Sets the minimal date supported by this DatePicker. Dates after (but not including) the specified date will be disallowed from being selected.
    
    Parameters:
    
    calendar - a Calendar object set to the year, month, day desired as the maxdate.
  - getMaxDate
```
public java.util.Calendar getMaxDate()
```
    Returns:
    
    The maximal date supported by this DatePicker. Null if it has not been set.
  - setHighlightedDays
```
public void setHighlightedDays(java.util.Calendar[] highlightedDays)
```
    Sets an array of dates which should be highlighted when the picker is drawn
    
    Parameters:
    
    highlightedDays - an Array of Calendar objects containing the dates to be highlighted
  - getHighlightedDays
```
public java.util.Calendar[] getHighlightedDays()
```
    Returns:
    
    The list of dates, as Calendar Objects, which should be highlighted. null is no dates should be highlighted
  - isHighlighted
```
public boolean isHighlighted(int year,
                             int month,
                             int day)
```
    Specified by:
    
    isHighlighted in interface DatePickerController
  - setSelectableDays
```
public void setSelectableDays(java.util.Calendar[] selectableDays)
```
    Sets a list of days which are the only valid selections. Setting this value will take precedence over using setMinDate() and setMaxDate()
    
    Parameters:
    
    selectableDays - an Array of Calendar Objects containing the selectable dates
  - getSelectableDays
```
public java.util.Calendar[] getSelectableDays()
```
    Returns:
    
    an Array of Calendar objects containing the list with selectable items. null if no restriction is set
  - setDisabledDays
```
public void setDisabledDays(java.util.Calendar[] disabledDays)
```
    Sets a list of days that are not selectable in the picker Setting this value will take precedence over using setMinDate() and setMaxDate(), but stacks with setSelectableDays()
    
    Parameters:
    
    disabledDays - an Array of Calendar Objects containing the disabled dates
  - getDisabledDays
```
public java.util.Calendar[] getDisabledDays()
```
    Returns:
    
    an Array of Calendar objects containing the list of days that are not selectable. null if no restriction is set
  - setDateRangeLimiter
```
public void setDateRangeLimiter(DateRangeLimiter dateRangeLimiter)
```
    Provide a DateRangeLimiter for full control over which dates are enabled and disabled in the picker
    
    Parameters:
    
    dateRangeLimiter - An implementation of the DateRangeLimiter interface
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Set a title to be displayed instead of the weekday
    
    Parameters:
    
    title - String - The title to be displayed
  - 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
  - setVersion
```
public void setVersion(DatePickerDialog.Version version)
```
    Set which layout version the picker should use
    
    Parameters:
    
    version - The version to use
  - getVersion
```
public DatePickerDialog.Version getVersion()
```
    Get the layout version the Dialog is using
    
    Specified by:
    
    getVersion in interface DatePickerController
    
    Returns:
    
    Version
  - setScrollOrientation
```
public void setScrollOrientation(DatePickerDialog.ScrollOrientation orientation)
```
    Set which way the user needs to swipe to switch months in the MonthView
    
    Parameters:
    
    orientation - The orientation to use
  - getScrollOrientation
```
public DatePickerDialog.ScrollOrientation getScrollOrientation()
```
    Get which way the user needs to swipe to switch months in the MonthView
    
    Specified by:
    
    getScrollOrientation in interface DatePickerController
    
    Returns:
    
    SwipeOrientation
  - setTimeZone
```
@Deprecated
public void setTimeZone(java.util.TimeZone timeZone)
```
    Deprecated.
    
    Set which timezone the picker should use This has been deprecated in favor of setting the TimeZone using the constructor that takes a Calendar object
    
    Parameters:
    
    timeZone - The timezone to use
  - setLocale
```
public void setLocale(java.util.Locale locale)
```
    Set a custom locale to be used when generating various strings in the picker
    
    Parameters:
    
    locale - Locale
  - getLocale
```
public java.util.Locale getLocale()
```
    Return the current locale (default or other)
    
    Specified by:
    
    getLocale in interface DatePickerController
    
    Returns:
    
    Locale
  - setOnDateSetListener
```
public void setOnDateSetListener(DatePickerDialog.OnDateSetListener listener)
```
  - setOnCancelListener
```
public void setOnCancelListener(android.content.DialogInterface.OnCancelListener onCancelListener)
```
  - setOnDismissListener
```
public void setOnDismissListener(android.content.DialogInterface.OnDismissListener onDismissListener)
```
  - getOnDateSetListener
```
public DatePickerDialog.OnDateSetListener getOnDateSetListener()
```
    Get a reference to the callback
    
    Returns:
    
    OnDateSetListener the callback
  - onClick
```
public void onClick(android.view.View v)
```
    Specified by:
    
    onClick in interface android.view.View.OnClickListener
  - onYearSelected
```
public void onYearSelected(int year)
```
    Specified by:
    
    onYearSelected in interface DatePickerController
  - onDayOfMonthSelected
```
public void onDayOfMonthSelected(int year,
                                 int month,
                                 int day)
```
    Specified by:
    
    onDayOfMonthSelected in interface DatePickerController
  - getSelectedDay
```
public MonthAdapter.CalendarDay getSelectedDay()
```
    Specified by:
    
    getSelectedDay in interface DatePickerController
  - getStartDate
```
public java.util.Calendar getStartDate()
```
    Specified by:
    
    getStartDate in interface DatePickerController
  - getEndDate
```
public java.util.Calendar getEndDate()
```
    Specified by:
    
    getEndDate in interface DatePickerController
  - getMinYear
```
public int getMinYear()
```
    Specified by:
    
    getMinYear in interface DatePickerController
  - getMaxYear
```
public int getMaxYear()
```
    Specified by:
    
    getMaxYear in interface DatePickerController
  - isOutOfRange
```
public boolean isOutOfRange(int year,
                            int month,
                            int day)
```
    Specified by:
    
    isOutOfRange in interface DatePickerController
  - getFirstDayOfWeek
```
public int getFirstDayOfWeek()
```
    Specified by:
    
    getFirstDayOfWeek in interface DatePickerController
  - registerOnDateChangedListener
```
public void registerOnDateChangedListener(DatePickerDialog.OnDateChangedListener listener)
```
    Specified by:
    
    registerOnDateChangedListener in interface DatePickerController
  - unregisterOnDateChangedListener
```
public void unregisterOnDateChangedListener(DatePickerDialog.OnDateChangedListener listener)
```
    Specified by:
    
    unregisterOnDateChangedListener in interface DatePickerController
  - tryVibrate
```
public void tryVibrate()
```
    Specified by:
    
    tryVibrate in interface DatePickerController
  - getTimeZone
```
public java.util.TimeZone getTimeZone()
```
    Specified by:
    
    getTimeZone in interface DatePickerController
  - notifyOnDateListener
```
public void notifyOnDateListener()
```

Class DatePickerDialog

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DatePickerDialog

Method Detail

newInstance

newInstance

newInstance

initialize

initialize

onCreate

onSaveInstanceState

onCreateView

onConfigurationChanged

onResume

onPause

onCancel

onDismiss

vibrate

dismissOnPause

autoDismiss

setThemeDark

isThemeDark

setAccentColor

setAccentColor

setOkColor

setOkColor

setCancelColor

setCancelColor

getAccentColor

showYearPickerFirst

setFirstDayOfWeek

setYearRange

setMinDate

getMinDate

setMaxDate

getMaxDate

setHighlightedDays

getHighlightedDays

isHighlighted

setSelectableDays

getSelectableDays

setDisabledDays

getDisabledDays

setDateRangeLimiter

setTitle

setOkText

setOkText

setCancelText

setCancelText

setVersion

getVersion

setScrollOrientation

getScrollOrientation

setTimeZone

setLocale

getLocale

setOnDateSetListener

setOnCancelListener

setOnDismissListener

getOnDateSetListener

onClick

onYearSelected

onDayOfMonthSelected

getSelectedDay

getStartDate

getEndDate

getMinYear

getMaxYear

isOutOfRange

getFirstDayOfWeek

registerOnDateChangedListener

unregisterOnDateChangedListener

tryVibrate

getTimeZone

notifyOnDateListener