java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
org.apache.myfaces.tobago.internal.component.AbstractUIInput
org.apache.myfaces.tobago.internal.component.AbstractUIDate
org.apache.myfaces.tobago.component.UIDate
- 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,SupportFieldId,SupportsAccessKey,SupportsAutoSpacing,SupportsDecorationPosition,SupportsHelp,SupportsLabelLayout,Visual
Renders a date input field.
For a time input field set you'll need to set the <f:convertDateTime type="time"> inside the <tc:date>.
If there is no converter given, a default instance of {
UIComponent class, generated from template component.stg with class
DateTagDeclaration.
-
Field Summary
FieldsFields inherited from class javax.faces.component.UIInput
ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAMEFields 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 -
Method Summary
Modifier and TypeMethodDescriptionThe access key of this control.Automatically add spacing (margins/paddings) to the component for better positioning.Sets a CSS class in its parent, if the parent supports it.getHelp()Text value to display as a help.Defines the position and the appearance of a help message on a component.getLabel()A localized user presentable label for this component.Defines the position of the label relative to the field.getMax()Sets the maximum value of the date.Defines the position and the appearance of additional faces messages (like error message or help message) on a component.getMin()Sets the minimum value of the date.Displays a short text in the input field, that describes the meaning of this field.getStep()Sets the step of a date or time picker.Controls the navigation of the focus through the input controls on a page with the Tab-Key.getTip()Text value to display as tooltip.getType()Type of the date/time input.booleanFlag indicating that this element is disabled.booleanisFocus()Flag indicating this component should receive the focus.booleanFlag indicating that this component will prohibit changes by the user.booleanIf true, a today- or now-button is displayed.voidrestoreState(javax.faces.context.FacesContext context, Object state) voidsetAccessKey(Character accessKey) voidsetAutoSpacing(Boolean autoSpacing) voidsetCustomClass(CustomClass customClass) voidsetDisabled(boolean disabled) voidsetFocus(boolean focus) voidvoidsetHelpPosition(DecorationPosition helpPosition) voidvoidsetLabelLayout(LabelLayout labelLayout) voidvoidvoidsetMessagePosition(DecorationPosition messagePosition) voidvoidsetPlaceholder(String placeholder) voidsetReadonly(boolean readonly) voidvoidsetTabIndex(Integer tabIndex) voidvoidsetTodayButton(boolean todayButton) voidMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIDate
getPattern, setPatternMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIInput
getFieldId, isError, isNextToRenderIsLabel, setNextToRenderIsLabelMethods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, broadcast, 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, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValueMethods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, setConverterMethods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTreeMethods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviorsMethods inherited from interface org.apache.myfaces.tobago.component.SupportsAutoSpacing
getAutoSpacingMethods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, setConverterMethods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIDate
public UIDate()
-
-
Method Details
-
getEventNames
- Specified by:
getEventNamesin interfacejavax.faces.component.behavior.ClientBehaviorHolder- Overrides:
getEventNamesin classjavax.faces.component.UIComponentBase
-
getDefaultEventName
- Specified by:
getDefaultEventNamein interfacejavax.faces.component.behavior.ClientBehaviorHolder- Overrides:
getDefaultEventNamein classjavax.faces.component.UIComponentBase
-
getFamily
- Overrides:
getFamilyin classjavax.faces.component.UIInput
-
getLabelLayout
Defines the position of the label relative to the field. The default is flexLeft, if the label is set, or none, if the label isn't set. Set to 'skip' to avoid surrounding label container. Hint for tc:out: set also compact=true to render only text (without html tags). -
setLabelLayout
-
isFocus
public boolean isFocus()Flag indicating this component should receive the focus.
Default:false- Specified by:
isFocusin classAbstractUIInput
-
setFocus
public void setFocus(boolean focus) -
getTabIndex
Controls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.- Specified by:
getTabIndexin classAbstractUIInput
-
setTabIndex
-
isTodayButton
public boolean isTodayButton()If true, a today- or now-button is displayed.
Default:false- Specified by:
isTodayButtonin classAbstractUIDate
-
setTodayButton
public void setTodayButton(boolean todayButton) -
getType
Type of the date/time input. Warning: month and week currently not supported.
Allowed Values:date,time,datetime-local,month,week- Specified by:
getTypein classAbstractUIDate
-
setType
- Specified by:
setTypein classAbstractUIDate
-
getMin
Sets the minimum value of the date.- Specified by:
getMinin classAbstractUIDate
-
setMin
-
isReadonly
public boolean isReadonly()Flag indicating that this component will prohibit changes by the user.
Default:false- Specified by:
isReadonlyin classAbstractUIInput
-
setReadonly
public void setReadonly(boolean readonly) -
isDisabled
public boolean isDisabled()Flag indicating that this element is disabled.
Default:false- Specified by:
isDisabledin classAbstractUIInput
-
setDisabled
public void setDisabled(boolean disabled) -
getTip
Text value to display as tooltip. -
setTip
-
getPlaceholder
Displays a short text in the input field, that describes the meaning of this field.
-
setPlaceholder
-
getMarkup
-
setMarkup
-
getMax
Sets the maximum value of the date.- Specified by:
getMaxin classAbstractUIDate
-
setMax
-
getMessagePosition
Defines the position and the appearance of additional faces messages (like error message or help message) on a component. The default is popoverRight. -
setMessagePosition
-
getLabel
A localized user presentable label for this component. -
setLabel
-
getHelp
Text value to display as a help. -
setHelp
-
getAutoSpacing
Automatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet -
setAutoSpacing
-
getHelpPosition
Defines the position and the appearance of a help message on a component. The default is popoverRight. -
setHelpPosition
-
getAccessKey
The access key of this control. -
setAccessKey
-
getCustomClass
Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code. -
setCustomClass
-
getStep
Sets the step of a date or time picker. Value is in seconds. Reasonable values are e.g. 0.001, 1, 5, 10, 60, 300, 3600. If not set, browsers drop the seconds, so it's the same as the value of 60. To show seconds use 1. To show milliseconds use 0.001. Browser support is in progress.- Specified by:
getStepin classAbstractUIDate
-
setStep
-
restoreState
- Specified by:
restoreStatein interfacejavax.faces.component.StateHolder- Overrides:
restoreStatein classjavax.faces.component.UIInput
-