Package org.primefaces.component.api

Class UICalendar

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

javax.faces.component.html.HtmlInputText

org.primefaces.component.api.AbstractPrimeHtmlInputText

org.primefaces.component.api.UICalendar

All Implemented Interfaces:

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, InputHolder, TouchAware

Direct Known Subclasses:

CalendarBase, DatePickerBase

public abstract class UICalendar
extends AbstractPrimeHtmlInputText
implements InputHolder, TouchAware

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UICalendar.PropertyKeys
static class	UICalendar.ValidationResult

Field Summary

Fields

Modifier and Type	Field	Description
protected static Collection<String>	CALENDAR_EVENT_NAMES
static String	CONTAINER_CLASS
static String	DATE_INVALID_MESSAGE_ID
static String	DATE_INVALID_RANGE_MESSAGE_ID
static String	DATE_MAX_DATE_ID
static String	DATE_MIN_DATE_ID
static String	DATE_OUT_OF_RANGE_MESSAGE_ID
static String	INPUT_STYLE_CLASS
protected String	timeOnlyPattern
protected static List<String>	UNOBSTRUSIVE_EVENT_NAMES

Fields inherited from class org.primefaces.component.api.AbstractPrimeHtmlInputText

EVENT_NAMES

Fields inherited from class javax.faces.component.html.HtmlInputText

COMPONENT_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	Description
UICalendar()

Method Summary

Modifier and Type	Method	Description
Locale	calculateLocale(javax.faces.context.FacesContext facesContext)
String	calculateLocalizedPattern()
String	calculatePattern()
String	calculateTimeOnlyPattern()
abstract String	calculateWidgetPattern()
String	convertPattern(String patternTemplate)
protected void	createFacesMessageFromValidationResult(javax.faces.context.FacesContext context, UICalendar.ValidationResult validationResult)
String	getInputClientId()
String	getInputStyle()
String	getInputStyleClass()
String	getLabelledBy()
Object	getLocale()
String	getMask()
String	getMaskSlotChar()
Object	getMaxdate()
Object	getMindate()
String	getPattern()
String	getRangeSeparator()
String	getResolverStyle()
String	getSelectionMode()
Object	getTimeZone()
String	getType()
String	getValidatableInputClientId()
Class<?>	getValueType()
boolean	hasTime()
boolean	isConversionFailed()
boolean	isMaskAutoClear()
boolean	isReadonlyInput()
boolean	isTimeOnly()
Boolean	isTimeOnlyWithoutDefault()
boolean	isTouchable()	Is this component touch enabled?
void	setConversionFailed(boolean value)
void	setInputStyle(String inputStyle)
void	setInputStyleClass(String inputStyleClass)
void	setLabelledBy(String labelledBy)	Sets the id of the label for aria.
void	setLocale(Object locale)
void	setMask(String mask)
void	setMaskAutoClear(boolean maskAutoClear)
void	setMaskSlotChar(String maskSlotChar)
void	setMaxdate(Object maxdate)
void	setMindate(Object mindate)
void	setPattern(String pattern)
void	setRangeSeparator(String _rangeSeparator)
void	setReadonlyInput(boolean readonlyInput)
void	setResolverStyle(String resolverStyle)
void	setTimeOnly(boolean timeOnly)
void	setTimeZone(Object timeZone)
void	setTouchable(boolean touchable)	Enable/disable touch support for this component.
void	setType(String type)
void	validateMinMax(javax.faces.context.FacesContext context)

Methods inherited from class org.primefaces.component.api.AbstractPrimeHtmlInputText

getEventNames, getInputmode, getOncontextmenu, getOncopy, getOncut, getOndrag, getOndragend, getOndragenter, getOndragleave, getOndragover, getOndragstart, getOndrop, getOninput, getOninvalid, getOnpaste, getOnreset, getOnscroll, getOnsearch, getOnwheel, setInputmode, setOncontextmenu, setOncopy, setOncut, setOndrag, setOndragend, setOndragenter, setOndragleave, setOndragover, setOndragstart, setOndrop, setOninput, setOninvalid, setOnpaste, setOnreset, setOnscroll, setOnsearch, setOnwheel

Methods inherited from class javax.faces.component.html.HtmlInputText

getAccesskey, getAlt, getAutocomplete, getDefaultEventName, getDir, getLabel, getLang, getMaxlength, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getRole, getSize, getStyle, getStyleClass, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setAlt, setAutocomplete, setDir, setDisabled, setLabel, setLang, setMaxlength, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setRole, setSize, setStyle, setStyleClass, setTabindex, setTitle

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getFamily, 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

addClientBehavior, 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, setValueExpression, 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

addClientBehavior, getClientBehaviors

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

CONTAINER_CLASS

public static final String CONTAINER_CLASS

See Also:

Constant Field Values

INPUT_STYLE_CLASS

public static final String INPUT_STYLE_CLASS

See Also:

Constant Field Values

DATE_OUT_OF_RANGE_MESSAGE_ID

public static final String DATE_OUT_OF_RANGE_MESSAGE_ID

See Also:

Constant Field Values

DATE_MIN_DATE_ID

public static final String DATE_MIN_DATE_ID

See Also:

Constant Field Values

DATE_MAX_DATE_ID

public static final String DATE_MAX_DATE_ID

See Also:

Constant Field Values

DATE_INVALID_MESSAGE_ID

public static final String DATE_INVALID_MESSAGE_ID

See Also:

Constant Field Values

DATE_INVALID_RANGE_MESSAGE_ID

public static final String DATE_INVALID_RANGE_MESSAGE_ID

See Also:

Constant Field Values

UNOBSTRUSIVE_EVENT_NAMES

protected static final List<String> UNOBSTRUSIVE_EVENT_NAMES

CALENDAR_EVENT_NAMES

protected static final Collection<String> CALENDAR_EVENT_NAMES

timeOnlyPattern

protected String timeOnlyPattern

Constructor Detail

UICalendar

public UICalendar()

Method Detail

getLocale

public Object getLocale()

setLocale

public void setLocale(Object locale)

getTimeZone

public Object getTimeZone()

setTimeZone

public void setTimeZone(Object timeZone)

getPattern

public String getPattern()

setPattern

public void setPattern(String pattern)

getMindate

public Object getMindate()

setMindate

public void setMindate(Object mindate)

getMaxdate

public Object getMaxdate()

setMaxdate

public void setMaxdate(Object maxdate)

isTimeOnly

public boolean isTimeOnly()

isTimeOnlyWithoutDefault

public Boolean isTimeOnlyWithoutDefault()

setTimeOnly

public void setTimeOnly(boolean timeOnly)

isReadonlyInput

public boolean isReadonlyInput()

setReadonlyInput

public void setReadonlyInput(boolean readonlyInput)

getInputStyle

public String getInputStyle()

setInputStyle

public void setInputStyle(String inputStyle)

getInputStyleClass

public String getInputStyleClass()

setInputStyleClass

public void setInputStyleClass(String inputStyleClass)

getType

public String getType()

setType

public void setType(String type)

getSelectionMode

public String getSelectionMode()

calculateLocale

public Locale calculateLocale(javax.faces.context.FacesContext facesContext)

hasTime

public boolean hasTime()

calculatePattern

public String calculatePattern()

calculateTimeOnlyPattern

public String calculateTimeOnlyPattern()

calculateLocalizedPattern

public String calculateLocalizedPattern()

calculateWidgetPattern

public abstract String calculateWidgetPattern()

convertPattern

public String convertPattern(String patternTemplate)

Parameters:

patternTemplate - the date pattern

Returns:

the value converted for InputMask plugin

See Also:

Inputmask README_date

isConversionFailed

public boolean isConversionFailed()

setConversionFailed

public void setConversionFailed(boolean value)

getInputClientId

public String getInputClientId()

Specified by:

getInputClientId in interface InputHolder

Returns:

Client id of the input element

getValidatableInputClientId

public String getValidatableInputClientId()

Specified by:

getValidatableInputClientId in interface InputHolder

Returns:

Client id of the validatable input element

getLabelledBy

public String getLabelledBy()

Specified by:

getLabelledBy in interface InputHolder

Returns:

Client id of the label for aria

setLabelledBy

public void setLabelledBy(String labelledBy)

Description copied from interface: InputHolder

Sets the id of the label for aria.

Specified by:

setLabelledBy in interface InputHolder

Parameters:

labelledBy - the id

getRangeSeparator

public String getRangeSeparator()

setRangeSeparator

public void setRangeSeparator(String _rangeSeparator)

getResolverStyle

public String getResolverStyle()

setResolverStyle

public void setResolverStyle(String resolverStyle)

isTouchable

public boolean isTouchable()

Description copied from interface: TouchAware

Is this component touch enabled?

Specified by:

isTouchable in interface TouchAware

Returns:

false to disable

setTouchable

public void setTouchable(boolean touchable)

Description copied from interface: TouchAware

Enable/disable touch support for this component.

Specified by:

setTouchable in interface TouchAware

Parameters:

touchable - true for touch support

getMask

public String getMask()

setMask

public void setMask(String mask)

getMaskSlotChar

public String getMaskSlotChar()

setMaskSlotChar

public void setMaskSlotChar(String maskSlotChar)

isMaskAutoClear

public boolean isMaskAutoClear()

setMaskAutoClear

public void setMaskAutoClear(boolean maskAutoClear)

createFacesMessageFromValidationResult

protected void createFacesMessageFromValidationResult(javax.faces.context.FacesContext context,
                                                      UICalendar.ValidationResult validationResult)

getValueType

public Class<?> getValueType()

validateMinMax

public void validateMinMax(javax.faces.context.FacesContext context)