DatePicker

java.lang.Object
- com.redhat.rhn.common.util.DatePicker

```
public class DatePicker
extends java.lang.Object
```
A bean to support date picking in the UI. To add a date picker to a form, add inputs for the year, day, month etc. to the form, and name them with a common prefix; to support a date picker with name date, you would add inputs with names date_year, date_month, date_day, date_hour, date_minute, and date_am_pm to the form. All this form variables need to be declared as type java.util.Integer
In your Struts action, you can initialize the form fields with
```
   Date d = ...;
   DynaActionForm dynaForm = ...;
   DatePicker p = new DatePicker("date", timeZone, locale, yearDirection);
   p.setDate(d);
   p.writeForm(dynaForm.getMap());
 
```
Once the form is submitted, you can extract the date with
```
   DynaActionForm dynaForm = ...;
   DatePicker p = new DatePicker("date", timeZone, locale, yearDirection);
   p.readForm(dynaForm.getMap());
   Date result = p.getDate();
   if ( result == null ) {
     ... tell user that date was incorrect ...
   }
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`AM_PM`
`static java.lang.String`	`DAY`
`static java.lang.String`	`HOUR`
`static java.lang.String`	`MINUTE`
`static java.lang.String`	`MONTH`
`static java.lang.String`	`USE_DATE` Typical form field when dealing with a date picker.
`static java.lang.String`	`YEAR`
`static int`	`YEAR_RANGE_NEGATIVE`
`static int`	`YEAR_RANGE_POSITIVE`

Constructor Summary

Constructors
Constructor and Description
`DatePicker(java.lang.String name0, java.util.Locale locale0, int yearRangeDirection0)` Create a new date picker that extracts fields prefixed with `name0 + "_"` and works with the given locale.
`DatePicker(java.lang.String name0, java.util.TimeZone tz, java.util.Locale locale0, int yearRangeDirection0)` Create a new date picker that extracts fields prefixed with `name0 + "_"` and works with the given time zone and locale.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Integer`	`getAmPm()` Return `0` to indicate AM and `1` to indicate PM.
`java.util.Calendar`	`getCalendar()` The calendar underlying this date picker.
`java.util.Date`	`getDate()`
`java.text.DateFormatSymbols`	`getDateFormatSymbols()` Return date format symbols for the locale associated with this date picker.
`java.lang.Integer`	`getDay()` Return the day, a number from 1 to 31.
`boolean`	`getDisableDate()` Returns disableDate property
`boolean`	`getDisableTime()` Returns disableTime property
`java.lang.Integer`	`getHour()` Return the hour, a number between 1 and 12 if `isLatin` is `true`, and a number from 0 to 23 otherwise.
`java.lang.Integer`	`getHourOfDay()`
`int[]`	`getHourRange()` Get the range of valid hour values, 1 to 12 if `isLatin` is `true` and 0 to 23 otherwise.
`java.util.Locale`	`getLocale()`
`java.lang.Integer`	`getMinute()` Return the minute, a number from 0 to 59.
`java.lang.Integer`	`getMonth()` Return the month, a number from 0 to 12.
`java.lang.String`	`getName()` Return the name of this picker.
`java.lang.Integer`	`getYear()` Return the year
`int[]`	`getYearRange()` Get a list of years for display.
`int`	`getYearRangeDirection()`
`boolean`	`isDayBeforeMonth()` Return `true` if in the given locale the day is written before the month, `false` otherwise.
`boolean`	`isLatin()` Return `true` if the locale uses 12 hour time formats with the additional am/pm designation (like certain anglo-saxon countries).
`void`	`readForm(org.apache.struts.action.DynaActionForm form)` Reads the form fields to populate date fields.
`void`	`readMap(java.util.Map map)` Parse the values in `map` into the internal date.
`void`	`setAmPm(java.lang.Integer v)` Set am or pm
`void`	`setDate(java.util.Date date)` Set the internal date of the picker to `date`
`void`	`setDay(java.lang.Integer v)` Set the day.
`void`	`setDisableDate()` Set disableDate property (Picker doesn't offer to set date)
`void`	`setDisableTime()` Set disableTime property (Picker doesn't offer to set time)
`void`	`setHour(java.lang.Integer v)` Set the hour
`void`	`setHourOfDay(java.lang.Integer v)` set the hour of the day This also sets the am/pm flag
`void`	`setMinute(java.lang.Integer v)` Set the minute
`void`	`setMonth(java.lang.Integer v)` Set the month.
`void`	`setYear(java.lang.Integer v)` Set the year
`void`	`writeToForm(org.apache.struts.action.DynaActionForm form)` Write the internal date into `form`.
`void`	`writeToMap(java.util.Map map)` Write the internal date into `map`.

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

- Field Detail
  - USE_DATE
```
public static final java.lang.String USE_DATE
```
    Typical form field when dealing with a date picker.
    
    See Also:
    
    StrutsDelegate, Constant Field Values
  - YEAR
```
public static final java.lang.String YEAR
```
    See Also:
    
    Constant Field Values
  - MONTH
```
public static final java.lang.String MONTH
```
    See Also:
    
    Constant Field Values
  - DAY
```
public static final java.lang.String DAY
```
    See Also:
    
    Constant Field Values
  - HOUR
```
public static final java.lang.String HOUR
```
    See Also:
    
    Constant Field Values
  - MINUTE
```
public static final java.lang.String MINUTE
```
    See Also:
    
    Constant Field Values
  - AM_PM
```
public static final java.lang.String AM_PM
```
    See Also:
    
    Constant Field Values
  - YEAR_RANGE_POSITIVE
```
public static final int YEAR_RANGE_POSITIVE
```
    See Also:
    
    Constant Field Values
  - YEAR_RANGE_NEGATIVE
```
public static final int YEAR_RANGE_NEGATIVE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DatePicker
```
public DatePicker(java.lang.String name0,
                  java.util.TimeZone tz,
                  java.util.Locale locale0,
                  int yearRangeDirection0)
```
    Create a new date picker that extracts fields prefixed with name0 + "_" and works with the given time zone and locale.
    
    Parameters:
    
    name0 - the prefix for the subfields for the date picker
    
    tz - the timezone in which values are to be interpreted
    
    locale0 - the locale to use
    
    yearRangeDirection0 - direction of the year range to use. YEAR_RANGE_POSATIVE means the year selection will go from now until YEAR_RANGE_SIZE in the future (2005-2010). YEAR_RANGE_NEGATIVE will include a range from now until YEAR_RANGE_SIZE in the past (2000 - 2005)
  - DatePicker
```
public DatePicker(java.lang.String name0,
                  java.util.Locale locale0,
                  int yearRangeDirection0)
```
    Create a new date picker that extracts fields prefixed with name0 + "_" and works with the given locale.
    
    Parameters:
    
    name0 - the prefix for the subfields for the date picker
    
    locale0 - the locale to use
    
    yearRangeDirection0 - direction of the year range to use. YEAR_RANGE_POSATIVE means the year selection will go from now until YEAR_RANGE_SIZE in the future (2005-2010). YEAR_RANGE_NEGATIVE will include a range from now until YEAR_RANGE_SIZE in the past (2000 - 2005)
- Method Detail
  - isLatin
```
public boolean isLatin()
```
    Return true if the locale uses 12 hour time formats with the additional am/pm designation (like certain anglo-saxon countries). A return value of false indicates that the locale uses a 24 hour clock.
    
    Returns:
    
    true if the locale uses 12 hour times with am/pm, false if it uses a 24 hour clock.
  - isDayBeforeMonth
```
public boolean isDayBeforeMonth()
```
    Return true if in the given locale the day is written before the month, false otherwise.
    
    Returns:
    
    true if in the given locale the day is written before the month, false otherwise.
  - getName
```
public java.lang.String getName()
```
    Return the name of this picker.
    
    Returns:
    
    the name of this picker
  - getMonth
```
public java.lang.Integer getMonth()
```
    Return the month, a number from 0 to 12.
    
    Returns:
    
    the month, a number from 0 to 12.
  - getDay
```
public java.lang.Integer getDay()
```
    Return the day, a number from 1 to 31.
    
    Returns:
    
    the day, a number from 1 to 31.
  - getYear
```
public java.lang.Integer getYear()
```
    Return the year
    
    Returns:
    
    the year
  - getHour
```
public java.lang.Integer getHour()
```
    Return the hour, a number between 1 and 12 if isLatin is true, and a number from 0 to 23 otherwise.
    
    Returns:
    
    the hour, a number between 1 and 12 if isLatin is true, and a number from 0 to 23 otherwise.
  - getHourOfDay
```
public java.lang.Integer getHourOfDay()
```
    Returns:
    
    The hour in 24 hour format (0 to 23)
  - getMinute
```
public java.lang.Integer getMinute()
```
    Return the minute, a number from 0 to 59.
    
    Returns:
    
    the minute, a number from 0 to 59.
  - getAmPm
```
public java.lang.Integer getAmPm()
```
    Return 0 to indicate AM and 1 to indicate PM.
    
    Returns:
    
    0 to indicate AM and 1 to indicate PM.
  - setMonth
```
public void setMonth(java.lang.Integer v)
```
    Set the month.
    
    Parameters:
    
    v - the month, a number from 0 to 11
  - setDay
```
public void setDay(java.lang.Integer v)
```
    Set the day.
    
    Parameters:
    
    v - the day, a number from 1 to 31
  - setYear
```
public void setYear(java.lang.Integer v)
```
    Set the year
    
    Parameters:
    
    v - the year
  - setHour
```
public void setHour(java.lang.Integer v)
```
    Set the hour
    
    Parameters:
    
    v - the hour
    
    See Also:
    
    getHour()
  - setHourOfDay
```
public void setHourOfDay(java.lang.Integer v)
```
    set the hour of the day This also sets the am/pm flag
    
    Parameters:
    
    v - the hour (0 to 23)
  - setMinute
```
public void setMinute(java.lang.Integer v)
```
    Set the minute
    
    Parameters:
    
    v - the minute, a number from 0 to 59
  - setAmPm
```
public void setAmPm(java.lang.Integer v)
```
    Set am or pm
    
    Parameters:
    
    v - 0 to indicate AM and 1 to indicate PM.
  - getYearRange
```
public int[] getYearRange()
```
    Get a list of years for display. The list starts with the current year and descends YEAR_RANGE_SIZE years down.
    
    Returns:
    
    a list of years for display
  - getHourRange
```
public int[] getHourRange()
```
    Get the range of valid hour values, 1 to 12 if isLatin is true and 0 to 23 otherwise.
    
    Returns:
    
    the range of valid hour values, 1 to 12 if isLatin is true and 0 to 23 otherwise.
  - getDate
```
public java.util.Date getDate()
```
    Returns:
    
    The date constructed from the individual field values of this bean instance, or null if the date is invalid.
  - setDate
```
public void setDate(java.util.Date date)
```
    Set the internal date of the picker to date
    
    Parameters:
    
    date - the date to which the internal date should be set to
  - getCalendar
```
public java.util.Calendar getCalendar()
```
    The calendar underlying this date picker. It will use the timezone and locale that was given to the picker.
    
    Returns:
    
    the calendar underlying this picker
  - readMap
```
public void readMap(java.util.Map map)
```
    Parse the values in map into the internal date. The map must map the names of the date widget fields like date_year etc. to Integer or parsable String values. If the map does not contain all of the required fields, the default date of now will be used.
    
    Parameters:
    
    map - a map from date widget field names to Integer or String values.
  - readForm
```
public void readForm(org.apache.struts.action.DynaActionForm form)
```
    Reads the form fields to populate date fields. If a form does not have all of the fields, the inital date will be now.
    
    Parameters:
    
    form - The form containing date picker fields.
  - writeToMap
```
public void writeToMap(java.util.Map map)
```
    Write the internal date into map. The map will map the names of the date widget fields like date_year etc. to Integer values.
    
    Parameters:
    
    map - a map from date widget field names to Integer values
  - writeToForm
```
public void writeToForm(org.apache.struts.action.DynaActionForm form)
```
    Write the internal date into form. The form will map the names of the date widget fields like date_year etc. to Integer values.
    
    Parameters:
    
    form - a dyna action form with date widget field names to Integer values
  - getDateFormatSymbols
```
public java.text.DateFormatSymbols getDateFormatSymbols()
```
    Return date format symbols for the locale associated with this date picker. This method is mainly provided as a conveniece for generating month names and am/pm designations in the user interface.
    
    Returns:
    
    the date format symbols for the locale associated with this picker
  - getYearRangeDirection
```
public int getYearRangeDirection()
```
    Returns:
    
    Returns the yearRangeDirection.
  - setDisableTime
```
public void setDisableTime()
```
    Set disableTime property (Picker doesn't offer to set time)
  - getDisableTime
```
public boolean getDisableTime()
```
    Returns disableTime property
    
    Returns:
    
    disableTime property
  - setDisableDate
```
public void setDisableDate()
```
    Set disableDate property (Picker doesn't offer to set date)
  - getDisableDate
```
public boolean getDisableDate()
```
    Returns disableDate property
    
    Returns:
    
    disableDate property
  - getLocale
```
public java.util.Locale getLocale()
```
    Returns:
    
    locale for this picker

Class DatePicker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USE_DATE

YEAR

MONTH

DAY

HOUR

MINUTE

AM_PM

YEAR_RANGE_POSITIVE

YEAR_RANGE_NEGATIVE

Constructor Detail

DatePicker

DatePicker

Method Detail

isLatin

isDayBeforeMonth

getName

getMonth

getDay

getYear

getHour

getHourOfDay

getMinute

getAmPm

setMonth

setDay

setYear

setHour

setHourOfDay

setMinute

setAmPm

getYearRange

getHourRange

getDate

setDate

getCalendar

readMap

readForm

writeToMap

writeToForm

getDateFormatSymbols

getYearRangeDirection

setDisableTime

getDisableTime

setDisableDate

getDisableDate

getLocale