Class ecm.widget.TimePicker
Extends
idx.form.TimeTextBox.
Provides a widget that is used to select a time.
This class extends the idx.form.TimeTextBox
class to provide additional formatting
patterns.
Defined in: <ecm\widget\TimePicker.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
Overrides idx's default if
showPickerIcon is false. |
- Fields borrowed from class idx.form._CompositeMixin:
- fieldWidth, help, hint, hintPosition, label, labelAlignment, labelWidth, required, unit
Method Summary
Method Attributes | Method Name and Description |
---|---|
getErrorMessage(isFocused)
Returns the error message.
|
|
Returns the time pattern from the constraints.
|
|
getValue()
Returns the value.
|
|
isValid()
Determines if the value is valid.
|
|
setCustomValidationError(errorMessage)
Set the custom validation error.
|
- Methods borrowed from class idx.form._CompositeMixin:
- _setFieldWidthAttr, _setHintAttr, _setLabelAlignmentAttr, _setLabelAttr, _setLabelWidthAttr, _setRequiredAttr, _setUnitAttr, postMixInProperties, reset, resize, validateAndFocus
Field Detail
showPickerIcon
Overrides idx's default if
showPickerIcon
is false.
Method Detail
getErrorMessage(isFocused)
Returns the error message.
- Parameters:
- isFocused
- A {Boolean} indicating if it has focus.
- Returns:
- The error message string.
getFormatPattern()
Returns the time pattern from the constraints.
- Returns:
- The time pattern.
getValue()
Returns the value.
- Returns:
- The value as an ISO string.
{Boolean} isValid()
Determines if the value is valid.
- Returns:
- {Boolean} A value of
true
if the value is valid.
postCreate()
setCustomValidationError(errorMessage)
Set the custom validation error.
- Parameters:
- errorMessage
- A {String} indicating the custom error message.