Tag Documentation

Description:
A control that inputs a calendar date range. Define the value property of the Date Range control as a com.webmethods.caf.faces.data.object.DateRange object. A Date Range object has three properties, fixedRange, relativeRange, and date. Use these attributes to specify one of the following:
- A fixed start and end date such as 2000-01-01 to 2000-02-01:
- A fixed period of time, relative to the current date such as the last thirty days:
- A relative period time, relative to the current date such as this month:
The Date Range object supports the following relativeRange property values:
- DateRange.FIXED: Not a relative-range, specified in milliseconds by fixedRange property.
- DateRange.THIS_DAY: Midnight this morning to the second before midnight tonight.
- DateRange.PREVIOUS_DAY: Midnight yesterday morning to the second before midnight last night.
- DateRange.NEXT_DAY: Midnight tomorrow morning to the second before midnight tomorrow night.
- DateRange.THIS_WEEK: Midnight on the first morning of the week such as Sunday in the US to the second before midnight on the last night of the week such as Saturday in the US.
- DateRange.PREVIOUS_WEEK: Midnight on the first morning of the previous week such as Sunday in the US to the second before midnight on the last night of the previous week such as Saturday in the US.
- DateRange.NEXT_WEEK: Midnight on the first morning of next week such as Sunday in the US to the second before midnight on the last night of next week such as Saturday in the US.
- DateRange.THIS_MONTH: Midnight on the first of the month to the second before midnight on the last night of the month such as 28th, 29th, 30th, or 31st.
- DateRange.PREVIOUS_MONTH: Midnight on the first of the previous month to the second before midnight on the last night of previous month such as 28th, 29th, 30th, or 31st.
- DateRange.NEXT_MONTH: Midnight on the first of next month to the second before midnight on the last night of next month such as 28th, 29th, 30th, or 31st.
- DateRange.THIS_YEAR: Midnight on January 1 of this year to the second before midnight on December 31 of this year.
- DateRange.PREVIOUS_YEAR: Midnight on January 1 of the previous year to the second before midnight on December 31 of the previous year.
- DateRange.NEXT_YEAR: Midnight on January 1 of next year to the second before midnight on December 31 of next year.
A Date Range object can calculate the appropriate start and end dates for its date-range, using its calculateStart() and calculateEnd() methods. For an infinite range, calculateStart() and calculateEnd() return null. The calculateStart() method is less than or equal to the calculateEnd() returned value.

You can only use this control in a Form control.

Component Information
Info	Value
Component Type	`com.webmethods.caf.faces.input.DateRangeInput`
Handler Class	None
Renderer Type	`com.webmethods.caf.faces.input.DateRangeInput`
Description	Date-range picker; uses com.webmethods.caf.faces.data.object.DateRange model
Palette Location	`CAF Html/Control/Input/Date Range Input`
Client-Side Model	`CAF.DateRangeInput.Model`

Attributes
Name	Required	Type	Description
`accesskey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Keyboard shortcut letter
`converter`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.convert.Converter`)	A value binding expression for a method that returns a converter instance.
`converterMessage`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Will be used as the text of the converter message, replacing any message that comes from the converter.
`dir`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the directionality of the flow of the content for the current element Valid values are: LTR RTL
`disabled`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True if control is grayed-out and un-modifiable If not specified, the default value is "false".
`futureRanges`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True to allow user to select date ranges from the future If not specified, the default value is "false".
`id`	`false`	`java.lang.String`	Control identifier
`immediate`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True to process value change listeners in the Apply Request Values phase; false to process in the Process Validations phase If not specified, the default value is "false".
`label`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Custom range label (defaults to localized string; in English, "Range")
`lang`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the language of the enclosed content
`layout`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Picker layout style If not specified, the default value is "full". Valid values are: full compact collapsed
`pastRanges`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True to allow user to select date ranges from the past If not specified, the default value is "true".
`pattern`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	java.text.SimpleDateFormat pattern to use (defaults to user's preferred date input pattern)
`readonly`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True if control is un-modifiable If not specified, the default value is "false".
`rendered`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True to render control; false to ignore it If not specified, the default value is "true".
`required`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True if user must specify a value for control If not specified, the default value is "false".
`requiredMessage`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Will be used as the text of the validation message for the "required" facility, if the "required" facility is used.
`showMonthAndYearMenus`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True to show month and year menus in the popup calender If not specified, the default value is "false".
`showSeconds`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True to show seconds input If not specified, the default value is "false".
`showTime`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True to show time inputs If not specified, the default value is "true".
`showTimezone`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True to use timezone If not specified, the default value is "true".
`style`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML "style" attribute value
`styleClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML "class" attribute value Valid values are: portlet-font portlet-font-dim portlet-msg-status portlet-msg-info portlet-msg-error portlet-msg-alert portlet-msg-success portlet-section-header portlet-section-body portlet-section-alternate portlet-section-selected portlet-section-subheader portlet-section-footer portlet-section-text portlet-form-label portlet-form-input-field portlet-form-button portlet-icon-label portlet-dlg-icon-label portlet-form-field-label portlet-form-field portlet-menu portlet-menu-item portlet-menu-item-selected portlet-menu-item-hover portlet-menu-item-hover-selected portlet-menu-cascade-item portlet-menu-cascade-item-selected portlet-menu-description portlet-menu-caption [any_other_value]
`tabindex`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Order in tab (key) sequence, from 1 to n. Zero adds control to tab sequence, negative integer removes control.
`timezone`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Standard java timezone name, such as "Pacific/Honolulu" for custom timezone; or "user", for current user's preferred timezone; or "default" for default timezone If not specified, the default value is "default". Valid values are: default user [any_other_value]
`title`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML "title" attribute value (often displayed as a tooltip)
`useClientSideValidation`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True if client side validation should be attempted (if available) for the control If not specified, the default value is "true". Valid values are: true false
`validator`	`false`	`javax.el.MethodExpression` (signature must match `void validate(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)`)	A method binding expression for a method that validates the component local value.
`validatorMessage`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Will be used as the text of the validator message, replacing any message that comes from the validator.
`value`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	Control value
`valueChangeListener`	`false`	`javax.el.MethodExpression` (signature must match `void valueChange(javax.faces.event.ValueChangeEvent)`)	Value change listener method binding
`width`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Pre-defined input width Valid values are: input2 input4 input6 input8 input10 input20 input30 input40 input50 input100
`yearMenuRange`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the range of years to show in the year menu. For example: 1995:2035

Date Range Input - caf_h:inputDateRange