A simple schedule input control that enables the user to input a date/time interval. Use the com.webmethods.caf.faces.data.object.Schedule object as the value property of this control. The Schedule model allows for an interval of time, expressed by a com.webmethods.rtl.date.DateFields object, plus a relative starting date, defined in the at attribute as a DateFields object.
The DateFields object has the same fields as a java.util.Calendar object, such as Calendar.DAY_OF_YEAR, Calendar.HOUR_OF_DAY, and Calendar.MINUTE. However, unlike the Calendar object, the DateFields object allows setting the fields independently from each other. The parse() and format() methods of DateFields allow the fields to be converted to and from a string representation. For example, the string representation for 5 days is represented as 5D and the string representation for 12:30 AM is 00:30.
You can represent a schedule that executes every 5th day at 12:30 AM using a Schedule object with an interval of 5D and an at attribute of 00:30. You can represent a schedule that executes every 5th day, without a specific start time, by using a Schedule object with an interval of 5D and no at attribute value.
The simple schedule input control enables a user to configure only the day (Calendar.DAY_OF_YEAR or nD), hour (Calendar.HOUR_OF_DAY or hh:00), and minute (Calendar.MINUTE or 00:mm) fields of the schedule interval, and only the hour (Calendar.HOUR_OF_DAY or hh:00) and minute (Calendar.MINUTE or 00:mm) fields of the schedule at attribute.
You can only use this control in a Form control.
| Info | Value |
|---|---|
| Component Type | com.webmethods.caf.faces.input.SimpleSchedule |
| Handler Class | None |
| Renderer Type | com.webmethods.caf.faces.input.SimpleSchedule |
| Description | Allows user to input a date/time interval |
| Palette Location | CAF Html/Control/Input/Simple Schedule Input |
| Client-Side Model | CAF.SimpleSchedule.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". |
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)
| A localized user presentable name for this component. |
lang | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies the language of the enclosed content |
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. |
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. |
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 java.lang.Object)
| Control value |
valueChangeListener | false | javax.el.MethodExpression
(signature must match void valueChange(javax.faces.event.ValueChangeEvent))
| Value change listener method binding |
Output generated by Vdldoc View Declaration Language Documentation Generator.