com.infragistics.faces.input.component
Class DateChooser

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  com.infragistics.faces.input.component.BaseInput
                      com.infragistics.faces.input.component.DateChooser

All Implemented Interfaces:

javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

Direct Known Subclasses:

HtmlDateChooser

public class DateChooser

extends BaseInput

This component displays a popup calendar to allow for easy selection of a date. It is fully localised and supports a very rich set of functionality as described below:

Internationalisation
DateChooser is fully localised. For instance, the label for days and months are displayed according to the default locale or the locale specified for the dateChooser. As an example dateChooser displays 'M', 'Mon' or 'Monday' for the US locale (short, medium and long dayHeaderFormat). an another example it automatically display 'L', 'Lun' or 'Lundi' for a French Locale.
The editMasks property is automatically determined based upon the default locale.

Customizable Look and Feel
The showDayHeader, showHeader and dayHeaderFormat properties allow to customize the dateChooser's look and feel.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DAY_HEADER_FORMAT_LONG
static java.lang.String	DAY_HEADER_FORMAT_MEDIUM
static java.lang.String	DAY_HEADER_FORMAT_SHORT
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Constructor Summary

DateChooser()

Method Summary

javax.faces.convert.Converter	getConverter()
java.lang.String	getDayHeaderFormat() Returns the format used to display week days in the day header section
java.lang.String	getEditMasks()
java.lang.String	getFamily()
int	getFirstDayOfWeek() Returns the first day of the week ; e.g., Sunday in US, Monday in France.
java.util.Locale	getLocale()
java.util.Date	getMaximumDate() Returns the maximum date allowed by the component
java.util.Date	getMinimumDate() Returns the minimum date allowed by the component
boolean	getShowDayHeader() Returns whether the day header section is displayed or not
boolean	getShowHeader() Returns whether the header section is displayed or not The header contains the navigation bar to display the fist/previous/next/last year and or month)
java.util.TimeZone	getTimeZone()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setConverter(javax.faces.convert.Converter arg0)
void	setDayHeaderFormat(java.lang.String dayHeaderFormat) Sets the format used to display week days in the day header section.
void	setEditMasks(java.lang.String editMasks)
void	setFirstDayOfWeek(int integer) Sets the first day of week - 1: Sunday, 2: monday, etc..
void	setLocale(java.util.Locale locale)
void	setMaximumDate(java.util.Date maximumDate) Sets the maximum date allowed by the component
void	setMinimumDate(java.util.Date minimumDate) Sets the minimum date allowed by the component
void	setShowDayHeader(boolean value) Sets whether the day header section is displayed or not
void	setShowHeader(boolean value) Sets whether the header section is displayed or not The header contains the navigation bar to display the fist/previous/next/last year and or month)
void	setTimeZone(java.util.TimeZone timeZone)

Methods inherited from class com.infragistics.faces.input.component.BaseInput

getShortcut, getTooltip, isDisabled, isReadOnly, setDisabled, setReadOnly, setShortcut, setTooltip, validate

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, decode, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, updateModel

Methods inherited from class javax.faces.component.UIOutput

getLocalValue, getValue

Methods inherited from class javax.faces.component.UIComponentBase

encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.ValueHolder

getLocalValue, getValue

Field Detail

COMPONENT_FAMILY

public static java.lang.String COMPONENT_FAMILY

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

DAY_HEADER_FORMAT_LONG

public static final java.lang.String DAY_HEADER_FORMAT_LONG

See Also:

Constant Field Values

DAY_HEADER_FORMAT_MEDIUM

public static final java.lang.String DAY_HEADER_FORMAT_MEDIUM

See Also:

Constant Field Values

DAY_HEADER_FORMAT_SHORT

public static final java.lang.String DAY_HEADER_FORMAT_SHORT

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

DateChooser

public DateChooser()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class BaseInput

getConverter

public javax.faces.convert.Converter getConverter()

getDayHeaderFormat

public java.lang.String getDayHeaderFormat()

Returns the format used to display week days in the day header section

Returns:

the current dayHeaderFormat

getFirstDayOfWeek

public int getFirstDayOfWeek()

Returns the first day of the week ; e.g., Sunday in US, Monday in France.

Returns:

the first day of the week (1 = Sunday, 2 = Monday, ...)

getMaximumDate

public java.util.Date getMaximumDate()

Returns the maximum date allowed by the component

Returns:

the current maximumDate

getMinimumDate

public java.util.Date getMinimumDate()

Returns the minimum date allowed by the component

Returns:

the current minimumDate

getShowDayHeader

public boolean getShowDayHeader()

Returns whether the day header section is displayed or not

Returns:

true || false

getShowHeader

public boolean getShowHeader()

Returns whether the header section is displayed or not The header contains the navigation bar to display the fist/previous/next/last year and or month)

Returns:

true || false

setConverter

public void setConverter(javax.faces.convert.Converter arg0)

setDayHeaderFormat

public void setDayHeaderFormat(java.lang.String dayHeaderFormat)

Sets the format used to display week days in the day header section. Valid values : Short, Medium, Long

setFirstDayOfWeek

public void setFirstDayOfWeek(int integer)

Sets the first day of week - 1: Sunday, 2: monday, etc..

Parameters:

integer -

setMaximumDate

public void setMaximumDate(java.util.Date maximumDate)

Sets the maximum date allowed by the component

setMinimumDate

public void setMinimumDate(java.util.Date minimumDate)

Sets the minimum date allowed by the component

setShowDayHeader

public void setShowDayHeader(boolean value)

Sets whether the day header section is displayed or not

setShowHeader

public void setShowHeader(boolean value)

Sets whether the header section is displayed or not The header contains the navigation bar to display the fist/previous/next/last year and or month)

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class BaseInput

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class BaseInput

getTimeZone

public java.util.TimeZone getTimeZone()

setTimeZone

public void setTimeZone(java.util.TimeZone timeZone)

getLocale

public java.util.Locale getLocale()

setLocale

public void setLocale(java.util.Locale locale)

setEditMasks

public void setEditMasks(java.lang.String editMasks)

getEditMasks

public java.lang.String getEditMasks()