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:
fixedRange
= A period of time in millisecondsrelativeRange
= DateRange.FIXEDdate
= A start date, for a positive period of time, or an end date, for a negative period of time.fixedRange
= A period of time in millisecondsrelativeRange
= DateRange.FIXEDdate
= NullfixedRange
= 0relativeRange
= A period of time (an enumerated value) OR DateRange.FIXEDdate
= NullThe Date Range
object supports the following relativeRange
property values:
fixedRange
property.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.
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 |
Palette Location | CAF Html/Control/Input/Date Range Input |
Client-Side Model | CAF.DateRangeInput.Model |
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:
|
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:
|
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:
|
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:
|
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:
|
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 description of the validator message. |
value | false | javax.el.ValueExpression
(must evaluate to com.webmethods.caf.faces.data.object.DateRange )
| com.webmethods.caf.faces.data.object.DateRange model |
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:
|
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 |
Output generated by Vdldoc View Declaration Language Documentation Generator.