org.icefaces.mobi.component.datespinner

Class DateSpinnerBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

org.icefaces.mobi.component.datespinner.DateSpinnerBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.icefaces.ace.api.IceClientBehaviorHolder, IDateSpinner

Direct Known Subclasses:

DateSpinner

public abstract class DateSpinnerBase
extends javax.faces.component.UIInput
implements IDateSpinner, org.icefaces.ace.api.IceClientBehaviorHolder

DateSpinner is an input component used for choosing a date.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DateSpinnerBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIInput

ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
DateSpinnerBase()

Method Summary

Modifier and Type	Method and Description
void	addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
java.lang.String	getDefaultEventName()
java.lang.String	getDefaultExecute(java.lang.String event)
java.lang.String	getDefaultRender(java.lang.String event)
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
java.lang.String	getListenerArgument(java.lang.String event)
java.lang.Object	getLocale() Return the value of the locale property.
java.lang.String	getPattern() Return the value of the pattern property.
java.lang.String	getSize() Return the value of the size property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.Object	getTimeZone() Return the value of the timeZone property.
int	getYearEnd() Return the value of the yearEnd property.
int	getYearStart() Return the value of the yearStart property.
boolean	isDisabled() Return the value of the disabled property.
protected boolean	isPropertySet(java.lang.String finder)
boolean	isReadonly() Return the value of the readonly property.
boolean	isUseNative() Return the value of the useNative property.
void	setDisabled(boolean disabled) Set the value of the disabled property.
void	setLocale(java.lang.Object locale) Set the value of the locale property.
void	setPattern(java.lang.String pattern) Set the value of the pattern property.
void	setReadonly(boolean readonly) Set the value of the readonly property.
void	setSize(java.lang.String size) Set the value of the size property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setTimeZone(java.lang.Object timeZone) Set the value of the timeZone property.
void	setUseNative(boolean useNative) Set the value of the useNative property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)
void	setYearEnd(int yearEnd) Set the value of the yearEnd property.
void	setYearStart(int yearStart) Set the value of the yearStart property.

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

DateSpinnerBase

public DateSpinnerBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

setDisabled

public void setDisabled(boolean disabled)

Set the value of the disabled property.

Contents: Disables this component, so it does not receive focus or get submitted.

Specified by:

setDisabled in interface IDateSpinner

isDisabled

public boolean isDisabled()

Return the value of the disabled property.

Contents: Disables this component, so it does not receive focus or get submitted. Default = 'false'.

Specified by:

isDisabled in interface IDateSpinner

setLocale

public void setLocale(java.lang.Object locale)

Set the value of the locale property.

Contents: The locale to be used for labels and conversion.

Specified by:

setLocale in interface IDateSpinner

getLocale

public java.lang.Object getLocale()

Return the value of the locale property.

Contents: The locale to be used for labels and conversion.

Specified by:

getLocale in interface IDateSpinner

setPattern

public void setPattern(java.lang.String pattern)

Set the value of the pattern property.

Contents: The DateFormat pattern for the non-native widget only. If useNative is true, then use standard JSF converters and validators. Supported patterns for the non native widget are 'dd-MM-yyyy', 'MM-dd-yyyy', 'yyyy-MM-dd', 'yyyy-dd-MM', and the same but using a '\' separator instead of a '-'

Specified by:

setPattern in interface IDateSpinner

getPattern

public java.lang.String getPattern()

Return the value of the pattern property.

Contents: The DateFormat pattern for the non-native widget only. If useNative is true, then use standard JSF converters and validators. Supported patterns for the non native widget are 'dd-MM-yyyy', 'MM-dd-yyyy', 'yyyy-MM-dd', 'yyyy-dd-MM', and the same but using a '\' separator instead of a '-' Default = 'yyyy-MM-dd'.

Specified by:

getPattern in interface IDateSpinner

setReadonly

public void setReadonly(boolean readonly)

Set the value of the readonly property.

Contents: Sets this component to read only, so value cannot be changed.

Specified by:

setReadonly in interface IDateSpinner

isReadonly

public boolean isReadonly()

Return the value of the readonly property.

Contents: Sets this component to read only, so value cannot be changed.

Specified by:

isReadonly in interface IDateSpinner

setSize

public void setSize(java.lang.String size)

Set the value of the size property.

Contents: Width, in characters, of the input text field string containing the value of the selected date.

Specified by:

setSize in interface IDateSpinner

getSize

public java.lang.String getSize()

Return the value of the size property.

Contents: Width, in characters, of the input text field string containing the value of the selected date. Default = '10'.

Specified by:

getSize in interface IDateSpinner

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: Sets the CSS style definition to be applied to this component.

Specified by:

setStyle in interface IDateSpinner

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: Sets the CSS style definition to be applied to this component.

Specified by:

getStyle in interface IDateSpinner

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: Sets the CSS class to apply to this component.

Specified by:

setStyleClass in interface IDateSpinner

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: Sets the CSS class to apply to this component.

Specified by:

getStyleClass in interface IDateSpinner

setTimeZone

public void setTimeZone(java.lang.Object timeZone)

Set the value of the timeZone property.

Contents: A String or a java.util.TimeZone instance specify the timezone used for time conversion. Defaults to TimeZone.getDefault().

Specified by:

setTimeZone in interface IDateSpinner

getTimeZone

public java.lang.Object getTimeZone()

Return the value of the timeZone property.

Contents: A String or a java.util.TimeZone instance specify the timezone used for time conversion. Defaults to TimeZone.getDefault().

Specified by:

getTimeZone in interface IDateSpinner

setUseNative

public void setUseNative(boolean useNative)

Set the value of the useNative property.

Contents: Determines if native date picker should be used when available. Currently, native support is available for iOS5, iOS6, and BlackBerry devices.

Specified by:

setUseNative in interface IDateSpinner

isUseNative

public boolean isUseNative()

Return the value of the useNative property.

Contents: Determines if native date picker should be used when available. Currently, native support is available for iOS5, iOS6, and BlackBerry devices. Default = 'false'.

Specified by:

isUseNative in interface IDateSpinner

setYearEnd

public void setYearEnd(int yearEnd)

Set the value of the yearEnd property.

Contents: The last year to appear in the dateScroller. Some validation is provided for input fields, for example when useNative is true and then the property org.icefaces.mobi.component.datespinner.yearRange may be overwritten for a custom validation message.

Specified by:

setYearEnd in interface IDateSpinner

getYearEnd

public int getYearEnd()

Return the value of the yearEnd property.

Contents: The last year to appear in the dateScroller. Some validation is provided for input fields, for example when useNative is true and then the property org.icefaces.mobi.component.datespinner.yearRange may be overwritten for a custom validation message. Default = '2050'.

Specified by:

getYearEnd in interface IDateSpinner

setYearStart

public void setYearStart(int yearStart)

Set the value of the yearStart property.

Contents: The first year to appear in the dateScroller. Some validation is provided for input fields, for example when useNative is true and then the property org.icefaces.mobi.component.datespinner.yearRange may be overwritten for a custom validation message.

Specified by:

setYearStart in interface IDateSpinner

getYearStart

public int getYearStart()

Return the value of the yearStart property.

Contents: The first year to appear in the dateScroller. Some validation is provided for input fields, for example when useNative is true and then the property org.icefaces.mobi.component.datespinner.yearRange may be overwritten for a custom validation message. Default = '1980'.

Specified by:

getYearStart in interface IDateSpinner

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                               javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIComponent

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public java.lang.String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getDefaultRender

public java.lang.String getDefaultRender(java.lang.String event)

Specified by:

getDefaultRender in interface org.icefaces.ace.api.IceClientBehaviorHolder

getDefaultExecute

public java.lang.String getDefaultExecute(java.lang.String event)

Specified by:

getDefaultExecute in interface org.icefaces.ace.api.IceClientBehaviorHolder

getListenerArgument

public java.lang.String getListenerArgument(java.lang.String event)

Specified by:

getListenerArgument in interface org.icefaces.ace.api.IceClientBehaviorHolder

addClientBehavior

public void addClientBehavior(java.lang.String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)

Specified by:

addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

addClientBehavior in class javax.faces.component.UIComponentBase