Class UIDate
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIOutput
jakarta.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:
- jakarta.faces.component.behavior.ClientBehaviorHolder,- jakarta.faces.component.EditableValueHolder,- jakarta.faces.component.PartialStateHolder,- jakarta.faces.component.StateHolder,- jakarta.faces.component.TransientStateHolder,- jakarta.faces.component.ValueHolder,- jakarta.faces.event.ComponentSystemEventListener,- jakarta.faces.event.FacesListener,- jakarta.faces.event.SystemEventListenerHolder,- EventListener,- 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 SummaryFieldsFields inherited from class jakarta.faces.component.UIInputALWAYS_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 jakarta.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
- 
Constructor SummaryConstructors
- 
Method SummaryModifier 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(jakarta.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.AbstractUIDategetPattern, setPatternMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIInputgetFieldId, isError, isNextToRenderIsLabel, setNextToRenderIsLabelMethods inherited from class jakarta.faces.component.UIInputaddValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidatorMessage, getValidators, getValue, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidatorMessage, setValue, updateModel, validate, validateValueMethods inherited from class jakarta.faces.component.UIOutputgetConverter, getLocalValue, setConverterMethods inherited from class jakarta.faces.component.UIComponentBaseaddClientBehavior, addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTreeMethods inherited from class jakarta.faces.component.UIComponentgetClientId, 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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolderaddClientBehavior, getClientBehaviorsMethods inherited from interface org.apache.myfaces.tobago.component.SupportsAutoSpacinggetAutoSpacingMethods inherited from interface jakarta.faces.component.ValueHoldergetConverter, getLocalValue, setConverterMethods inherited from interface org.apache.myfaces.tobago.component.VisualgetRendererType, isPlain
- 
Field Details- 
COMPONENT_TYPE
- 
COMPONENT_FAMILY- See Also:
 
 
- 
- 
Constructor Details- 
UIDatepublic UIDate()
 
- 
- 
Method Details- 
getEventNames- Specified by:
- getEventNamesin interface- jakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getEventNamesin class- jakarta.faces.component.UIComponentBase
 
- 
getDefaultEventName- Specified by:
- getDefaultEventNamein interface- jakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getDefaultEventNamein class- jakarta.faces.component.UIComponentBase
 
- 
getFamily- Overrides:
- getFamilyin class- jakarta.faces.component.UIInput
 
- 
getLabelLayoutDefines 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
- 
isFocuspublic boolean isFocus()Flag indicating this component should receive the focus.
 Default:false- Specified by:
- isFocusin class- AbstractUIInput
 
- 
setFocuspublic void setFocus(boolean focus) 
- 
getTabIndexControls 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 class- AbstractUIInput
 
- 
setTabIndex
- 
isTodayButtonpublic boolean isTodayButton()If true, a today- or now-button is displayed.
 Default:false- Specified by:
- isTodayButtonin class- AbstractUIDate
 
- 
setTodayButtonpublic void setTodayButton(boolean todayButton) 
- 
getTypeType of the date/time input. Warning: month and week currently not supported.
 Allowed Values:date,time,datetime-local,month,week- Specified by:
- getTypein class- AbstractUIDate
 
- 
setType- Specified by:
- setTypein class- AbstractUIDate
 
- 
getMinSets the minimum value of the date.- Specified by:
- getMinin class- AbstractUIDate
 
- 
setMin
- 
isReadonlypublic boolean isReadonly()Flag indicating that this component will prohibit changes by the user.
 Default:false- Specified by:
- isReadonlyin class- AbstractUIInput
 
- 
setReadonlypublic void setReadonly(boolean readonly) 
- 
isDisabledpublic boolean isDisabled()Flag indicating that this element is disabled.
 Default:false- Specified by:
- isDisabledin class- AbstractUIInput
 
- 
setDisabledpublic void setDisabled(boolean disabled) 
- 
getTipText value to display as tooltip.
- 
setTip
- 
getPlaceholderDisplays a short text in the input field, that describes the meaning of this field. 
- 
setPlaceholder
- 
getMarkup
- 
setMarkup
- 
getMaxSets the maximum value of the date.- Specified by:
- getMaxin class- AbstractUIDate
 
- 
setMax
- 
getMessagePositionDefines the position and the appearance of additional faces messages (like error message or help message) on a component. The default is popoverRight.
- 
setMessagePosition
- 
getLabelA localized user presentable label for this component.
- 
setLabel
- 
getHelpText value to display as a help.
- 
setHelp
- 
getAutoSpacingAutomatically 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
- 
getHelpPositionDefines the position and the appearance of a help message on a component. The default is popoverRight.
- 
setHelpPosition
- 
getAccessKeyThe access key of this control.
- 
setAccessKey
- 
getCustomClassSets 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
- 
getStepSets 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 class- AbstractUIDate
 
- 
setStep
- 
restoreState- Specified by:
- restoreStatein interface- jakarta.faces.component.StateHolder
- Overrides:
- restoreStatein class- jakarta.faces.component.UIInput
 
 
-