Class UIDate
- 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
@Generated("component.stg") public class UIDate extends AbstractUIDate
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 classDateTagDeclaration
.
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_FAMILY
static String
COMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UIDate()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Character
getAccessKey()
The access key of this control.Boolean
getAutoSpacing()
Automatically add spacing (margins/paddings) to the component for better positioning.CustomClass
getCustomClass()
Sets a CSS class in its parent, if the parent supports it.String
getDefaultEventName()
Collection<String>
getEventNames()
String
getFamily()
String
getHelp()
Text value to display as a help.DecorationPosition
getHelpPosition()
Defines the position and the appearance of a help message on a component.String
getLabel()
A localized user presentable label for this component.LabelLayout
getLabelLayout()
Defines the position of the label relative to the field.Markup
getMarkup()
Object
getMax()
Sets the maximum value of the date.DecorationPosition
getMessagePosition()
Defines the position and the appearance of additional faces messages (like error message or help message) on a component.Object
getMin()
Sets the minimum value of the date.String
getPlaceholder()
Displays a short text in the input field, that describes the meaning of this field.Double
getStep()
Sets the step of a date or time picker.Integer
getTabIndex()
Controls the navigation of the focus through the input controls on a page with the Tab-Key.String
getTip()
Text value to display as tooltip.DateType
getType()
Type of the date/time input.boolean
isDisabled()
Flag indicating that this element is disabled.boolean
isFocus()
Flag indicating this component should receive the focus.boolean
isReadonly()
Flag indicating that this component will prohibit changes by the user.boolean
isTodayButton()
If true, a today- or now-button is displayed.void
restoreState(javax.faces.context.FacesContext context, Object state)
void
setAccessKey(Character accessKey)
void
setAutoSpacing(Boolean autoSpacing)
void
setCustomClass(CustomClass customClass)
void
setDisabled(boolean disabled)
void
setFocus(boolean focus)
void
setHelp(String help)
void
setHelpPosition(DecorationPosition helpPosition)
void
setLabel(String label)
void
setLabelLayout(LabelLayout labelLayout)
void
setMarkup(Markup markup)
void
setMax(Object max)
void
setMessagePosition(DecorationPosition messagePosition)
void
setMin(Object min)
void
setPlaceholder(String placeholder)
void
setReadonly(boolean readonly)
void
setStep(Double step)
void
setTabIndex(Integer tabIndex)
void
setTip(String tip)
void
setTodayButton(boolean todayButton)
void
setType(DateType type)
-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIDate
getPattern, setPattern
-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIInput
getFieldId, isError, isNextToRenderIsLabel, setNextToRenderIsLabel
-
Methods 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, validateValue
-
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, setConverter
-
Methods 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, visitTree
-
Methods 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, unsubscribeFromEvent
-
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 org.apache.myfaces.tobago.component.SupportsAutoSpacing
getAutoSpacing
-
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, setConverter
-
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getEventNames
public Collection<String> getEventNames()
- Specified by:
getEventNames
in interfacejavax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getEventNames
in classjavax.faces.component.UIComponentBase
-
getDefaultEventName
public String getDefaultEventName()
- Specified by:
getDefaultEventName
in interfacejavax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getDefaultEventName
in classjavax.faces.component.UIComponentBase
-
getFamily
public String getFamily()
- Overrides:
getFamily
in classjavax.faces.component.UIInput
-
getLabelLayout
public LabelLayout 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
public void setLabelLayout(LabelLayout labelLayout)
-
isFocus
public boolean isFocus()
Flag indicating this component should receive the focus.
Default:false
- Specified by:
isFocus
in classAbstractUIInput
-
setFocus
public void setFocus(boolean focus)
-
getTabIndex
public Integer 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:
getTabIndex
in classAbstractUIInput
-
setTabIndex
public void setTabIndex(Integer tabIndex)
-
isTodayButton
public boolean isTodayButton()
If true, a today- or now-button is displayed.
Default:false
- Specified by:
isTodayButton
in classAbstractUIDate
-
setTodayButton
public void setTodayButton(boolean todayButton)
-
getType
public DateType getType()
Type of the date/time input. Warning: month and week currently not supported.
Allowed Values:date,time,datetime-local,month,week
- Specified by:
getType
in classAbstractUIDate
-
setType
public void setType(DateType type)
- Specified by:
setType
in classAbstractUIDate
-
getMin
public Object getMin()
Sets the minimum value of the date.- Specified by:
getMin
in classAbstractUIDate
-
setMin
public void setMin(Object min)
-
isReadonly
public boolean isReadonly()
Flag indicating that this component will prohibit changes by the user.
Default:false
- Specified by:
isReadonly
in classAbstractUIInput
-
setReadonly
public void setReadonly(boolean readonly)
-
isDisabled
public boolean isDisabled()
Flag indicating that this element is disabled.
Default:false
- Specified by:
isDisabled
in classAbstractUIInput
-
setDisabled
public void setDisabled(boolean disabled)
-
getTip
public String getTip()
Text value to display as tooltip.
-
setTip
public void setTip(String tip)
-
getPlaceholder
public String getPlaceholder()
Displays a short text in the input field, that describes the meaning of this field.
-
setPlaceholder
public void setPlaceholder(String placeholder)
-
getMarkup
public Markup getMarkup()
-
setMarkup
public void setMarkup(Markup markup)
-
getMax
public Object getMax()
Sets the maximum value of the date.- Specified by:
getMax
in classAbstractUIDate
-
setMax
public void setMax(Object max)
-
getMessagePosition
public DecorationPosition 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
public void setMessagePosition(DecorationPosition messagePosition)
-
getLabel
public String getLabel()
A localized user presentable label for this component.
-
setLabel
public void setLabel(String label)
-
getHelp
public String getHelp()
Text value to display as a help.
-
setHelp
public void setHelp(String help)
-
getAutoSpacing
public Boolean 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
public void setAutoSpacing(Boolean autoSpacing)
-
getHelpPosition
public DecorationPosition getHelpPosition()
Defines the position and the appearance of a help message on a component. The default is popoverRight.
-
setHelpPosition
public void setHelpPosition(DecorationPosition helpPosition)
-
getAccessKey
public Character getAccessKey()
The access key of this control.
-
setAccessKey
public void setAccessKey(Character accessKey)
-
getCustomClass
public CustomClass 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
public void setCustomClass(CustomClass customClass)
-
getStep
public Double 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:
getStep
in classAbstractUIDate
-
setStep
public void setStep(Double step)
-
restoreState
public void restoreState(javax.faces.context.FacesContext context, Object state)
- Specified by:
restoreState
in interfacejavax.faces.component.StateHolder
- Overrides:
restoreState
in classjavax.faces.component.UIInput
-
-