org.rcfaces.core.component
Class CalendarComponent

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  org.rcfaces.core.internal.component.CameliaInputComponent
                      org.rcfaces.core.component.AbstractInputComponent
                          org.rcfaces.core.component.AbstractCalendarComponent
                              org.rcfaces.core.component.CalendarComponent

All Implemented Interfaces:

EditableValueHolder, StateHolder, ValueHolder, IAccessKeyCapability, IBorderCapability, ICalendarLayoutCapability, ICalendarModeCapability, IClientDataCapability, IClientDatesStrategyCapability, IComponentLocaleCapability, IComponentTimeZoneCapability, IDisabledCapability, IErrorEventCapability, IFocusBlurEventCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImmediateCapability, IInitEventCapability, IKeyDownEventCapability, IKeyEventCapability, IKeyPressEventCapability, IKeyUpEventCapability, ILayoutPositionCapability, ILiteralLocaleCapability, ILiteralTimeZoneCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IMultipleSelectCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IReadOnlyCapability, ISelectionEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, ITabIndexCapability, ITextAlignmentCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IValidationEventCapability, IValueLockedCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IConvertValueHolder, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.capability.ISubmittedExternalValue, org.rcfaces.core.internal.manager.IClientDataManager, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.IServerDataManager, org.rcfaces.core.internal.manager.ITransientAttributesManager

public class CalendarComponent
extends AbstractCalendarComponent
implements IBorderCapability, ICalendarLayoutCapability, IMultipleSelectCapability, ICalendarModeCapability

The calendar Component shows a calendar. It can be customized in differents ways (days off, holidays, tool tips ...).

The calendar Component has the following capabilities :

• ISelectionEventCapability
• IReadOnlyCapability
• ILiteralLocaleCapability
• ILiteralTimeZoneCapability
• IComponentLocaleCapability
• IComponentTimeZoneCapability
• IClientDatesStrategyCapability
• IBorderCapability
• ICalendarLayoutCapability
• IMultipleSelectCapability
• ICalendarModeCapability

The default calendar renderer is linked to the f_calendar javascript class. f_calendar extends f_component, fa_readOnly, fa_disabled, fa_itemsWrapper

Table of the main component style classes:

Style Name	Description
f_calendar_yearCursor	Defines styles for the wrapper Table element used to change years of the calendar. Contains other style
f_calendar_monthList	Defines styles for the wrapper Table element the element containing the months of year
f_calendar_dayList	Defines styles for the wrapper Table element the element containing the day list of year
f_calendar_day	Defines styles for the A element

Field Summary

protected static Set	CAMELIA_ATTRIBUTES
static String	COMPONENT_TYPE

Fields inherited from class org.rcfaces.core.internal.component.CameliaInputComponent

engine

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID

Fields inherited from class javax.faces.component.UIComponent

bindings

Fields inherited from interface org.rcfaces.core.component.capability.ICalendarLayoutCapability

DEFAULT_LAYOUT, FULL_LAYOUT, LONG_LAYOUT, MEDIUM_LAYOUT, SHORT_LAYOUT

Fields inherited from interface org.rcfaces.core.component.capability.ICalendarModeCapability

DATE_CALENDAR_MODE, DATE_CALENDAR_MODE_NAME, DEFAULT_CALENDAR_MODE, DEFAULT_CALENDAR_MODE_NAME, PERIOD_CALENDAR_MODE, PERIOD_CALENDAR_MODE_NAME

Fields inherited from interface org.rcfaces.core.component.capability.IClientDatesStrategyCapability

ALL_DATES_STRATEGY, DEFAULT_DATES_STRATEGY, MONTH_DATES_STRATEGY, YEAR_DATES_STRATEGY

Fields inherited from interface org.rcfaces.core.component.capability.IHiddenModeCapability

CLIENT_HIDDEN_MODE, DEFAULT_HIDDEN_MODE, IGNORE_HIDDEN_MODE, PHANTOM_HIDDEN_MODE, SERVER_HIDDEN_MODE

Constructor Summary

CalendarComponent()

CalendarComponent(String componentId)

Method Summary

int	getCalendarLayout()
int	getCalendarLayout(FacesContext facesContext) See getCalendarLayout() for more details
protected Set	getCameliaFields()
int	getMode() Returns a int value specifying the selection mode.
int	getMode(FacesContext facesContext) See getMode() for more details
boolean	isAutoSelection()
boolean	isAutoSelection(FacesContext facesContext)
boolean	isAutoSelectionSetted() Returns true if the attribute "autoSelection" is set.
boolean	isBorder() Returns a boolean value that indicates if the component should show a border or not.
boolean	isBorder(FacesContext facesContext) See isBorder() for more details
boolean	isBorderSetted() Returns true if the attribute "border" is set.
boolean	isCalendarLayoutSetted() Returns true if the attribute "calendarLayout" is set.
boolean	isModeSetted() Returns true if the attribute "mode" is set.
boolean	isMultipleSelect() Returns a boolean value indicating wether multiple selection is permitted.
boolean	isMultipleSelect(FacesContext facesContext) See isMultipleSelect() for more details
boolean	isMultipleSelectSetted() Returns true if the attribute "multipleSelect" is set.
void	setAutoSelection(boolean autoSelection)
void	setBorder(boolean border) Sets a boolean value that indicates if the component should show a border or not.
void	setCalendarLayout(int calendarLayout)
void	setCalendarLayout(String layout)
void	setMode(int mode) Sets a int value specifying the selection mode.
void	setMode(String calendarMode)
void	setMultipleSelect(boolean multipleSelect) Sets a boolean value indicating wether multiple selection is permitted.

Methods inherited from class org.rcfaces.core.component.AbstractCalendarComponent

addSelectionListener, getClientDatesStrategy, getClientDatesStrategy, getComponentLocale, getComponentLocale, getComponentTimeZone, getComponentTimeZone, getCursorDate, getCursorDate, getDate, getDisabledWeekDays, getDisabledWeekDays, getLiteralLocale, getLiteralLocale, getLiteralTimeZone, getLiteralTimeZone, getMaxDate, getMaxDate, getMinDate, getMinDate, getTwoDigitYearStart, getTwoDigitYearStart, isClientDatesStrategySetted, isComponentLocaleSetted, isComponentTimeZoneSetted, isCursorDateSetted, isDisabledWeekDaysSetted, isLiteralLocaleSetted, isLiteralTimeZoneSetted, isMaxDateSetted, isMinDateSetted, isReadOnly, isReadOnly, isReadOnlySetted, isTwoDigitYearStartSetted, listSelectionListeners, removeSelectionListener, setClientDatesStrategy, setClientDatesStrategy, setComponentLocale, setComponentLocale, setComponentTimeZone, setComponentTimeZone, setCursorDate, setCursorDate, setDate, setDisabledWeekDays, setDisabledWeekDays, setLiteralLocale, setLiteralLocale, setLiteralTimeZone, setLiteralTimeZone, setMaxDate, setMaxDate, setMinDate, setMinDate, setReadOnly, setTwoDigitYearStart, setTwoDigitYearStart

Methods inherited from class org.rcfaces.core.component.AbstractInputComponent

addBlurListener, addErrorListener, addFocusListener, addInitListener, addKeyDownListener, addKeyPressListener, addKeyUpListener, addMouseOutListener, addMouseOverListener, addPropertyChangeListener, addUserEventListener, addValidationListener, getAccessKey, getAccessKey, getAriaLabel, getAriaLabel, getAriaLevel, getAriaLevel, getBackgroundColor, getBackgroundColor, getBottom, getBottom, getClientData, getClientData, getClientDataCount, getClientDataMap, getClientDataMap, getFontBold, getFontBold, getFontItalic, getFontItalic, getFontName, getFontName, getFontSize, getFontSize, getFontUnderline, getFontUnderline, getForegroundColor, getForegroundColor, getHeight, getHeight, getHelpMessage, getHelpMessage, getHelpURL, getHelpURL, getHiddenMode, getHiddenMode, getLeft, getLeft, getLookId, getLookId, getMarginBottom, getMarginBottom, getMarginLeft, getMarginLeft, getMarginRight, getMarginRight, getMarginTop, getMarginTop, getRight, getRight, getServerData, getServerData, getServerDataCount, getServerDataMap, getServerDataMap, getStyleClass, getStyleClass, getTabIndex, getTabIndex, getTextAlignment, getTextAlignment, getToolTipText, getToolTipText, getTop, getTop, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, getVisibleState, getVisibleState, getWaiRole, getWaiRole, getWidth, getWidth, getX, getX, getY, getY, isAccessKeySetted, isAriaLabelSetted, isAriaLevelSetted, isBackgroundColorSetted, isBottomSetted, isDisabled, isDisabled, isDisabledSetted, isFontBoldSetted, isFontItalicSetted, isFontNameSetted, isFontSizeSetted, isFontUnderlineSetted, isForegroundColorSetted, isHeightSetted, isHelpMessageSetted, isHelpURLSetted, isHiddenModeSetted, isLeftSetted, isLookIdSetted, isMarginBottomSetted, isMarginLeftSetted, isMarginRightSetted, isMarginTopSetted, isPartialRendering, isPartialRendering, isPartialRenderingSetted, isRightSetted, isStyleClassSetted, isTabIndexSetted, isTextAlignmentSetted, isToolTipTextSetted, isTopSetted, isUnlockedClientAttributeNamesSetted, isValueLocked, isValueLocked, isValueLockedSetted, isVisible, isVisible, isVisibleSetted, isWaiRoleSetted, isWidthSetted, isXSetted, isYSetted, listBlurListeners, listClientDataKeys, listClientDataKeys, listErrorListeners, listFocusListeners, listInitListeners, listKeyDownListeners, listKeyPressListeners, listKeyUpListeners, listMouseOutListeners, listMouseOverListeners, listPropertyChangeListeners, listServerDataKeys, listServerDataKeys, listUserEventListeners, listValidationListeners, removeBlurListener, removeClientData, removeErrorListener, removeFocusListener, removeInitListener, removeKeyDownListener, removeKeyPressListener, removeKeyUpListener, removeMouseOutListener, removeMouseOverListener, removePropertyChangeListener, removeServerData, removeUserEventListener, removeValidationListener, setAccessKey, setAriaLabel, setAriaLevel, setBackgroundColor, setBottom, setClientData, setClientData, setDisabled, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline, setForegroundColor, setHeight, setHelpMessage, setHelpURL, setHiddenMode, setHiddenMode, setLeft, setLookId, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPartialRendering, setRight, setServerData, setServerData, setStyleClass, setTabIndex, setTextAlignment, setToolTipText, setTop, setUnlockedClientAttributeNames, setValueLocked, setVisible, setWaiRole, setWidth, setX, setY

Methods inherited from class org.rcfaces.core.internal.component.CameliaInputComponent

broadcast, clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getCameliaValueAlias, getChildren, getChildrenListState, getConvertedValue, getFamily, getLocalValue, getRendererType, getSubmittedExternalValue, getTransientAttribute, getValue, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isSubmittedValueSetted, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setConverter, setConverter, setDefaultProperties, setRendered, setSubmittedExternalValue, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase, verifyAsyncDecode

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, compareValues, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, 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

getConverter, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, findComponent, getAttributes, getChildCount, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.rcfaces.core.component.capability.IImmediateCapability

isImmediate, setImmediate

Methods inherited from interface org.rcfaces.core.internal.manager.IContainerManager

getChildCount

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, setConverter, setValue

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES

Constructor Detail

CalendarComponent

public CalendarComponent()

CalendarComponent

public CalendarComponent(String componentId)

Method Detail

setMode

public void setMode(String calendarMode)

setCalendarLayout

public void setCalendarLayout(String layout)

isBorder

public boolean isBorder()

Description copied from interface: IBorderCapability

Returns a boolean value that indicates if the component should show a border or not.

Specified by:

isBorder in interface IBorderCapability

Returns:

border

isBorder

public boolean isBorder(FacesContext facesContext)

See isBorder() for more details

isBorderSetted

public final boolean isBorderSetted()

Returns true if the attribute "border" is set.

Returns:

true if the attribute is set.

setBorder

public void setBorder(boolean border)

Description copied from interface: IBorderCapability

Sets a boolean value that indicates if the component should show a border or not.

Specified by:

setBorder in interface IBorderCapability

Parameters:

border - boolean

getCalendarLayout

public int getCalendarLayout()

Specified by:

getCalendarLayout in interface ICalendarLayoutCapability

getCalendarLayout

public int getCalendarLayout(FacesContext facesContext)

See getCalendarLayout() for more details

isCalendarLayoutSetted

public final boolean isCalendarLayoutSetted()

Returns true if the attribute "calendarLayout" is set.

Returns:

true if the attribute is set.

setCalendarLayout

public void setCalendarLayout(int calendarLayout)

Specified by:

setCalendarLayout in interface ICalendarLayoutCapability

isMultipleSelect

public boolean isMultipleSelect()

Description copied from interface: IMultipleSelectCapability

Returns a boolean value indicating wether multiple selection is permitted.

Specified by:

isMultipleSelect in interface IMultipleSelectCapability

Returns:

boolean

isMultipleSelect

public boolean isMultipleSelect(FacesContext facesContext)

See isMultipleSelect() for more details

isMultipleSelectSetted

public final boolean isMultipleSelectSetted()

Returns true if the attribute "multipleSelect" is set.

Returns:

true if the attribute is set.

setMultipleSelect

public void setMultipleSelect(boolean multipleSelect)

Description copied from interface: IMultipleSelectCapability

Sets a boolean value indicating wether multiple selection is permitted.

Specified by:

setMultipleSelect in interface IMultipleSelectCapability

Parameters:

multipleSelect - boolean

getMode

public int getMode()

Description copied from interface: ICalendarModeCapability

Returns a int value specifying the selection mode.

Specified by:

getMode in interface ICalendarModeCapability

Returns:

mode

See Also:

ICalendarModeCapability.DATE_CALENDAR_MODE, ICalendarModeCapability.PERIOD_CALENDAR_MODE

getMode

public int getMode(FacesContext facesContext)

See getMode() for more details

isModeSetted

public final boolean isModeSetted()

Returns true if the attribute "mode" is set.

Returns:

true if the attribute is set.

setMode

public void setMode(int mode)

Description copied from interface: ICalendarModeCapability

Sets a int value specifying the selection mode.

Specified by:

setMode in interface ICalendarModeCapability

See Also:

ICalendarModeCapability.DATE_CALENDAR_MODE, ICalendarModeCapability.PERIOD_CALENDAR_MODE

isAutoSelection

public boolean isAutoSelection()

isAutoSelection

public boolean isAutoSelection(FacesContext facesContext)

setAutoSelection

public void setAutoSelection(boolean autoSelection)

isAutoSelectionSetted

public boolean isAutoSelectionSetted()

Returns true if the attribute "autoSelection" is set.

Returns:

true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()

Overrides:

getCameliaFields in class AbstractCalendarComponent