org.rcfaces.core.component
Class AbstractCalendarComponent

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

All Implemented Interfaces:

EditableValueHolder, StateHolder, ValueHolder, IAccessKeyCapability, IClientDataCapability, IClientDatesStrategyCapability, IComponentLocaleCapability, IComponentTimeZoneCapability, IDisabledCapability, IErrorEventCapability, IFocusBlurEventCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImmediateCapability, IInitEventCapability, IKeyDownEventCapability, IKeyEventCapability, IKeyPressEventCapability, IKeyUpEventCapability, ILayoutPositionCapability, ILiteralLocaleCapability, ILiteralTimeZoneCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, 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

Direct Known Subclasses:

CalendarComponent, DateChooserComponent, DateEntryComponent

public abstract class AbstractCalendarComponent
extends AbstractInputComponent
implements ISelectionEventCapability, IReadOnlyCapability, ILiteralLocaleCapability, ILiteralTimeZoneCapability, IComponentLocaleCapability, IComponentTimeZoneCapability, IClientDatesStrategyCapability

Technical component, used as a basis for building new RCFaces components.

Field Summary

protected static Set

CAMELIA_ATTRIBUTES

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

engine

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 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

AbstractCalendarComponent()

Method Summary

void	addSelectionListener(ISelectionListener listener) Adds a listener to the component for the selection event
protected Set	getCameliaFields()
int	getClientDatesStrategy() Returns an int value indicating the AJAX transfert strategy for the calendar component : the dates' characteristics (styleClass, toolTip ...).
int	getClientDatesStrategy(FacesContext facesContext) See getClientDatesStrategy() for more details
Locale	getComponentLocale() Returns the locale defined for the component
Locale	getComponentLocale(FacesContext facesContext) See getComponentLocale() for more details
TimeZone	getComponentTimeZone() Returns the timeZone defined for the component.
TimeZone	getComponentTimeZone(FacesContext facesContext) See getComponentTimeZone() for more details
Date	getCursorDate()
Date	getCursorDate(FacesContext facesContext)
Date	getDate()
int	getDisabledWeekDays() Returns a list of disabled week days (depending on the locale specified for the component).
int	getDisabledWeekDays(FacesContext facesContext) Returns a list of disabled week days (depending on the locale specified for the component).
Locale	getLiteralLocale() Returns the locale defined for literal attributes.
Locale	getLiteralLocale(FacesContext facesContext) See getLiteralLocale() for more details
TimeZone	getLiteralTimeZone() Returns the timeZone defined for literal attributes.
TimeZone	getLiteralTimeZone(FacesContext facesContext) See getLiteralTimeZone() for more details
Date	getMaxDate() Returns a date value indicating the maximum acceptable date for the component.
Date	getMaxDate(FacesContext facesContext)
Date	getMinDate() Returns a date value indicating the minimum acceptable date for the component. the first accepted value is minDate plus one day.
Date	getMinDate(FacesContext facesContext)
Date	getTwoDigitYearStart() Returns a string value specifying the year considered as base for selecting a date when the associated dateEntry's value's year has only two digits.
Date	getTwoDigitYearStart(FacesContext facesContext)
boolean	isClientDatesStrategySetted() Returns true if the attribute "clientDatesStrategy" is set.
boolean	isComponentLocaleSetted() Returns true if the attribute "componentLocale" is set.
boolean	isComponentTimeZoneSetted() Returns true if the attribute "componentTimeZone" is set.
boolean	isCursorDateSetted() Returns true if the attribute "cursorDate" is set.
boolean	isDisabledWeekDaysSetted() Returns true if the attribute "disabledWeekDays" is set.
boolean	isLiteralLocaleSetted() Returns true if the attribute "literalLocale" is set.
boolean	isLiteralTimeZoneSetted() Returns true if the attribute "literalTimeZone" is set.
boolean	isMaxDateSetted() Returns true if the attribute "maxDate" is set.
boolean	isMinDateSetted() Returns true if the attribute "minDate" is set.
boolean	isReadOnly() Returns a boolean value indicating that this component will prohibit changes by the user.
boolean	isReadOnly(FacesContext facesContext) See isReadOnly() for more details
boolean	isReadOnlySetted() Returns true if the attribute "readOnly" is set.
boolean	isTwoDigitYearStartSetted() Returns true if the attribute "twoDigitYearStart" is set.
FacesListener[]	listSelectionListeners() Returns a list of selection listener for the component
void	removeSelectionListener(ISelectionListener listener) Removes a listener from the component for the selection event
void	setClientDatesStrategy(int clientDatesStrategy) Sets an int value indicating the AJAX transfert strategy for the calendar component : the dates' characteristics (styleClass, toolTip ...).
void	setClientDatesStrategy(String strategy)
void	setComponentLocale(Locale componentLocale) Sets the locale for the component
void	setComponentLocale(String locale)
void	setComponentTimeZone(String timeZone)
void	setComponentTimeZone(TimeZone componentTimeZone) Sets the timeZone for component.
void	setCursorDate(Date cursorDate)
void	setCursorDate(String date)
void	setDate(Date date)
void	setDisabledWeekDays(int disabledWeekDays) Sets a list of disabled week days (depending on the locale specified for the component).
void	setDisabledWeekDays(String disabledWeekDays)
void	setLiteralLocale(Locale literalLocale) Sets the locale for literal attributes.
void	setLiteralLocale(String locale)
void	setLiteralTimeZone(String timeZone)
void	setLiteralTimeZone(TimeZone literalTimeZone) Sets the timeZone for literal attributes.
void	setMaxDate(Date maxDate) Sets a date value indicating the maximum acceptable date for the component.
void	setMaxDate(String date)
void	setMinDate(Date minDate) Sets a date value indicating the minimum acceptable date for the component. the first accepted value is minDate plus one day.
void	setMinDate(String date)
void	setReadOnly(boolean readOnly) Sets a boolean value indicating that this component will prohibit changes by the user.
void	setTwoDigitYearStart(Date twoDigitYearStart) Sets a string value specifying the year considered as base for selecting a date when the associated dateEntry's value's year has only two digits.
void	setTwoDigitYearStart(String date)

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

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES

Constructor Detail

AbstractCalendarComponent

public AbstractCalendarComponent()

Method Detail

getDate

public Date getDate()

setDate

public void setDate(Date date)

setTwoDigitYearStart

public void setTwoDigitYearStart(String date)

getTwoDigitYearStart

public Date getTwoDigitYearStart(FacesContext facesContext)

setClientDatesStrategy

public void setClientDatesStrategy(String strategy)

setMinDate

public void setMinDate(String date)

getMinDate

public Date getMinDate(FacesContext facesContext)

setMaxDate

public void setMaxDate(String date)

getMaxDate

public Date getMaxDate(FacesContext facesContext)

setLiteralLocale

public void setLiteralLocale(String locale)

setComponentLocale

public void setComponentLocale(String locale)

setLiteralTimeZone

public void setLiteralTimeZone(String timeZone)

setComponentTimeZone

public void setComponentTimeZone(String timeZone)

setCursorDate

public void setCursorDate(String date)

getCursorDate

public Date getCursorDate(FacesContext facesContext)

setDisabledWeekDays

public void setDisabledWeekDays(String disabledWeekDays)

addSelectionListener

public final void addSelectionListener(ISelectionListener listener)

Description copied from interface: ISelectionEventCapability

Adds a listener to the component for the selection event

Specified by:

addSelectionListener in interface ISelectionEventCapability

Parameters:

listener - the selection listener to add

removeSelectionListener

public final void removeSelectionListener(ISelectionListener listener)

Description copied from interface: ISelectionEventCapability

Removes a listener from the component for the selection event

Specified by:

removeSelectionListener in interface ISelectionEventCapability

Parameters:

listener - the selection listener to remove

listSelectionListeners

public final FacesListener[] listSelectionListeners()

Description copied from interface: ISelectionEventCapability

Returns a list of selection listener for the component

Specified by:

listSelectionListeners in interface ISelectionEventCapability

Returns:

selection listeners' list

isReadOnly

public boolean isReadOnly()

Description copied from interface: IReadOnlyCapability

Returns a boolean value indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled.

Specified by:

isReadOnly in interface IReadOnlyCapability

Returns:

readOnly boolean property

isReadOnly

public boolean isReadOnly(FacesContext facesContext)

See isReadOnly() for more details

isReadOnlySetted

public final boolean isReadOnlySetted()

Returns true if the attribute "readOnly" is set.

Returns:

true if the attribute is set.

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: IReadOnlyCapability

Sets a boolean value indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled.

Specified by:

setReadOnly in interface IReadOnlyCapability

Parameters:

readOnly - readOnly boolean property

getLiteralLocale

public Locale getLiteralLocale()

Description copied from interface: ILiteralLocaleCapability

Returns the locale defined for literal attributes. (date, number)

Specified by:

getLiteralLocale in interface ILiteralLocaleCapability

Returns:

the defined locale

getLiteralLocale

public Locale getLiteralLocale(FacesContext facesContext)

See getLiteralLocale() for more details

isLiteralLocaleSetted

public final boolean isLiteralLocaleSetted()

Returns true if the attribute "literalLocale" is set.

Returns:

true if the attribute is set.

setLiteralLocale

public void setLiteralLocale(Locale literalLocale)

Description copied from interface: ILiteralLocaleCapability

Sets the locale for literal attributes. (date, number)

Specified by:

setLiteralLocale in interface ILiteralLocaleCapability

Parameters:

literalLocale - locale to define

getLiteralTimeZone

public TimeZone getLiteralTimeZone()

Description copied from interface: ILiteralTimeZoneCapability

Returns the timeZone defined for literal attributes. (date)

Specified by:

getLiteralTimeZone in interface ILiteralTimeZoneCapability

Returns:

the defined timeZone

getLiteralTimeZone

public TimeZone getLiteralTimeZone(FacesContext facesContext)

See getLiteralTimeZone() for more details

isLiteralTimeZoneSetted

public final boolean isLiteralTimeZoneSetted()

Returns true if the attribute "literalTimeZone" is set.

Returns:

true if the attribute is set.

setLiteralTimeZone

public void setLiteralTimeZone(TimeZone literalTimeZone)

Description copied from interface: ILiteralTimeZoneCapability

Sets the timeZone for literal attributes. (date)

Specified by:

setLiteralTimeZone in interface ILiteralTimeZoneCapability

Parameters:

literalTimeZone - timeZone to define

getComponentLocale

public Locale getComponentLocale()

Description copied from interface: IComponentLocaleCapability

Returns the locale defined for the component

Specified by:

getComponentLocale in interface IComponentLocaleCapability

Returns:

the defined locale

getComponentLocale

public Locale getComponentLocale(FacesContext facesContext)

See getComponentLocale() for more details

isComponentLocaleSetted

public final boolean isComponentLocaleSetted()

Returns true if the attribute "componentLocale" is set.

Returns:

true if the attribute is set.

setComponentLocale

public void setComponentLocale(Locale componentLocale)

Description copied from interface: IComponentLocaleCapability

Sets the locale for the component

Specified by:

setComponentLocale in interface IComponentLocaleCapability

Parameters:

componentLocale - locale to define

getComponentTimeZone

public TimeZone getComponentTimeZone()

Description copied from interface: IComponentTimeZoneCapability

Returns the timeZone defined for the component.

Specified by:

getComponentTimeZone in interface IComponentTimeZoneCapability

Returns:

the defined timeZone

getComponentTimeZone

public TimeZone getComponentTimeZone(FacesContext facesContext)

See getComponentTimeZone() for more details

isComponentTimeZoneSetted

public final boolean isComponentTimeZoneSetted()

Returns true if the attribute "componentTimeZone" is set.

Returns:

true if the attribute is set.

setComponentTimeZone

public void setComponentTimeZone(TimeZone componentTimeZone)

Description copied from interface: IComponentTimeZoneCapability

Sets the timeZone for component.

Specified by:

setComponentTimeZone in interface IComponentTimeZoneCapability

Parameters:

componentTimeZone - timeZone to define

getClientDatesStrategy

public int getClientDatesStrategy()

Description copied from interface: IClientDatesStrategyCapability

Returns an int value indicating the AJAX transfert strategy for the calendar component : the dates' characteristics (styleClass, toolTip ...).

Specified by:

getClientDatesStrategy in interface IClientDatesStrategyCapability

Returns:

1:all|2:year|3:month

getClientDatesStrategy

public int getClientDatesStrategy(FacesContext facesContext)

See getClientDatesStrategy() for more details

isClientDatesStrategySetted

public final boolean isClientDatesStrategySetted()

Returns true if the attribute "clientDatesStrategy" is set.

Returns:

true if the attribute is set.

setClientDatesStrategy

public void setClientDatesStrategy(int clientDatesStrategy)

Description copied from interface: IClientDatesStrategyCapability

Sets an int value indicating the AJAX transfert strategy for the calendar component : the dates' characteristics (styleClass, toolTip ...).

Specified by:

setClientDatesStrategy in interface IClientDatesStrategyCapability

Parameters:

clientDatesStrategy - 1:all|2:year|3:month|1:default default=all

getTwoDigitYearStart

public Date getTwoDigitYearStart()

Returns a string value specifying the year considered as base for selecting a date when the associated dateEntry's value's year has only two digits.

Returns:

pivot year

setTwoDigitYearStart

public void setTwoDigitYearStart(Date twoDigitYearStart)

Sets a string value specifying the year considered as base for selecting a date when the associated dateEntry's value's year has only two digits.

Parameters:

twoDigitYearStart - pivot year

isTwoDigitYearStartSetted

public boolean isTwoDigitYearStartSetted()

Returns true if the attribute "twoDigitYearStart" is set.

Returns:

true if the attribute is set.

getMinDate

public Date getMinDate()

Returns a date value indicating the minimum acceptable date for the component. the first accepted value is minDate plus one day.

Returns:

min date

setMinDate

public void setMinDate(Date minDate)

Sets a date value indicating the minimum acceptable date for the component. the first accepted value is minDate plus one day.

Parameters:

minDate - min date

isMinDateSetted

public boolean isMinDateSetted()

Returns true if the attribute "minDate" is set.

Returns:

true if the attribute is set.

getMaxDate

public Date getMaxDate()

Returns a date value indicating the maximum acceptable date for the component. The last accepted value is maxDate minus one day.

Returns:

max date

setMaxDate

public void setMaxDate(Date maxDate)

Sets a date value indicating the maximum acceptable date for the component. The last accepted value is maxDate minus one day.

Parameters:

maxDate - max date

isMaxDateSetted

public boolean isMaxDateSetted()

Returns true if the attribute "maxDate" is set.

Returns:

true if the attribute is set.

getCursorDate

public Date getCursorDate()

setCursorDate

public void setCursorDate(Date cursorDate)

isCursorDateSetted

public boolean isCursorDateSetted()

Returns true if the attribute "cursorDate" is set.

Returns:

true if the attribute is set.

getDisabledWeekDays

public int getDisabledWeekDays()

Returns a list of disabled week days (depending on the locale specified for the component).

Returns:

list of days

getDisabledWeekDays

public int getDisabledWeekDays(FacesContext facesContext)

Returns a list of disabled week days (depending on the locale specified for the component).

Returns:

list of days

setDisabledWeekDays

public void setDisabledWeekDays(int disabledWeekDays)

Sets a list of disabled week days (depending on the locale specified for the component).

Parameters:

disabledWeekDays - list of days

isDisabledWeekDaysSetted

public boolean isDisabledWeekDaysSetted()

Returns true if the attribute "disabledWeekDays" is set.

Returns:

true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()

Overrides:

getCameliaFields in class AbstractInputComponent