com.sun.rave.web.ui.component
Class Calendar

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by com.sun.rave.web.ui.component.HiddenFieldBase
                      extended by com.sun.rave.web.ui.component.HiddenField
                          extended by com.sun.rave.web.ui.component.FieldBase
                              extended by com.sun.rave.web.ui.component.Field
                                  extended by com.sun.rave.web.ui.component.CalendarBase
                                      extended by com.sun.rave.web.ui.component.Calendar
All Implemented Interfaces:
ComplexComponent, DateManager, javax.faces.component.EditableValueHolder, javax.faces.component.NamingContainer, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class Calendar
extends CalendarBase
implements DateManager, javax.faces.component.NamingContainer

Defines a Calendar component.


Field Summary
static java.lang.String PATTERN_ID
           
 
Fields inherited from class com.sun.rave.web.ui.component.Field
INPUT_ID, LABEL_FACET, LABEL_ID, READONLY_FACET, READONLY_ID
 
Fields inherited from class javax.faces.component.UIInput
COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
Calendar()
          Creates a new instance of Calendar
 
Method Summary
 javax.faces.convert.Converter getConverter()
           
 java.text.DateFormat getDateFormat()
           
 CalendarMonth getDatePicker()
           
 ImageHyperlink getDatePickerLink(javax.faces.context.FacesContext context)
          This method returns the ImageHyperlink that serves as the "button" to show or hide the calendar date picker display.
 java.util.Date getFirstAvailableDate()
           
 java.lang.String getJavaScriptObjectName(javax.faces.context.FacesContext context)
           
 java.util.Date getLastAvailableDate()
           
 java.lang.String getReadOnlyValueString(javax.faces.context.FacesContext context)
          Return the value to be rendered as a string when the component is readOnly.
 void setDateFormatPattern(java.lang.String dateFormatPattern)
          The date format pattern to use (i.e.
 
Methods inherited from class com.sun.rave.web.ui.component.CalendarBase
getDateFormatPattern, getDateFormatPatternHelp, getFamily, getMaxDate, getMinDate, getSelectedDate, getTimeZone, getValueBinding, restoreState, saveState, setDateFormatPatternHelp, setMaxDate, setMinDate, setSelectedDate, setTimeZone, setValueBinding
 
Methods inherited from class com.sun.rave.web.ui.component.Field
getColumns, getLabelComponent, getPrimaryElementID, getReadOnlyComponent, log, setText
 
Methods inherited from class com.sun.rave.web.ui.component.FieldBase
getLabel, getLabelLevel, getMaxLength, getOnBlur, getOnChange, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getOnSelect, getStyle, getStyleClass, getTabIndex, getText, getToolTip, isDisabled, isReadOnly, isTrim, isVisible, setColumns, setDisabled, setLabel, setLabelLevel, setMaxLength, setOnBlur, setOnChange, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setOnSelect, setReadOnly, setStyle, setStyleClass, setTabIndex, setToolTip, setTrim, setVisible
 
Methods inherited from class com.sun.rave.web.ui.component.HiddenField
getConvertedValue, getValueAsString
 
Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, compareValues, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue
 
Methods inherited from class javax.faces.component.UIOutput
getLocalValue, getValue, setConverter
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.sun.rave.web.ui.component.DateManager
getDateFormatPattern, getTimeZone
 
Methods inherited from interface javax.faces.component.ValueHolder
getLocalValue, getValue, setConverter
 

Field Detail

PATTERN_ID

public static final java.lang.String PATTERN_ID
See Also:
Constant Field Values
Constructor Detail

Calendar

public Calendar()
Creates a new instance of Calendar

Method Detail

getDatePickerLink

public ImageHyperlink getDatePickerLink(javax.faces.context.FacesContext context)
This method returns the ImageHyperlink that serves as the "button" to show or hide the calendar date picker display.

Parameters:
context - The current FacesContext.
Returns:
The ImageHyperlink to show or hide the calendar date picker.

getDatePicker

public CalendarMonth getDatePicker()

getJavaScriptObjectName

public java.lang.String getJavaScriptObjectName(javax.faces.context.FacesContext context)

getConverter

public javax.faces.convert.Converter getConverter()
Specified by:
getConverter in interface javax.faces.component.ValueHolder
Overrides:
getConverter in class javax.faces.component.UIOutput

getReadOnlyValueString

public java.lang.String getReadOnlyValueString(javax.faces.context.FacesContext context)
Description copied from class: HiddenField

Return the value to be rendered as a string when the component is readOnly. The default behaviour is to invoke getValueAsString(). Override this method in case a component needs specialized behaviour.

Overrides:
getReadOnlyValueString in class HiddenField
Parameters:
context - FacesContext for the current request
Returns:
A String value of the component

getDateFormat

public java.text.DateFormat getDateFormat()
Specified by:
getDateFormat in interface DateManager

getFirstAvailableDate

public java.util.Date getFirstAvailableDate()
Specified by:
getFirstAvailableDate in interface DateManager

getLastAvailableDate

public java.util.Date getLastAvailableDate()
Specified by:
getLastAvailableDate in interface DateManager

setDateFormatPattern

public void setDateFormatPattern(java.lang.String dateFormatPattern)
Description copied from class: CalendarBase

The date format pattern to use (i.e. yyyy-MM-dd). The component uses an instance of java.text.SimpleDateFormat and you may specify a pattern to be used by this component, with the following restriction: the format pattern must include yyyy (not yy), MM, and dd; and no other parts of time may be displayed. If a pattern is not specified, a locale-specific default is used.

If you change the date format pattern, you may also need to change the dateFormatPatternHelp attribute. See the documentation for that attribute.

Overrides:
setDateFormatPattern in class CalendarBase
See Also:
CalendarBase.getDateFormatPattern()