Class: TimePicker

componyx .UI.TimePicker(id, properties) → {Object}

new TimePicker(id, properties) → {Object}

TimePicker class.

Parameters:

Name	Type	Description
`id`	String	The id of the component.
`properties`	Object \| HTMLElement	The properties used to initialize the component or the container element.

Mixes In:

componyx.UI.base.methods

Returns:

An instance of the component.

Type: Object

Extends

componyx.UI.base.Component

Classes

TimePickerEvents

Members

allowedTimes :Array.<String>

Gets or sets a list of allowed clock times (format 'HH:MM'). Separate two date strings with a space to specify allowed range. When allowed times are set, date input fields are rendered in readonly mode.

Type:

Array.<String>

amButtonId :String|null

Gets or sets the id of the ante meridiem (AM) button from which the settings are cloned.

Type:

String | null

autoFocus :Boolean

Gets or sets a value indicating whether focus on an input field is automatically moved to the next field while typing.

Type:

Boolean

clockDialogId :String|null

Gets or sets the id of the clock dialog from which the settings are cloned.

Type:

String | null

cssClassHour :String

Gets or sets the css class of the hour input.

Type:

String

cssClassMinute :String

Gets or sets the css class of the minute input.

Type:

String

cssClassNumericBox :String

Gets or sets the css class of the numericbox.

Type:

String

disabled :Boolean

Gets or sets a value indicating whether the timepicker is disabled.

Type:

Boolean

disallowTimes :Boolean

Gets or sets a value indicating if the times specified in the times property are disallowed instead of the default allowed.

Type:

Boolean

events :componyx.UI.TimePicker.TimePickerEvents

TimePicker events

Type:

componyx.UI.TimePicker.TimePickerEvents

hiddenInputId :String|null

Gets or sets the id of the hidden input from which the settings are cloned.

Type:

String | null

hourLeadingZero :Boolean

Gets or sets a value indicating whether a leading zero is added to the hour input box if it is not provided. Default: true.

Type:

Boolean

hourNumericBoxId :String|null

Gets or sets the id of the hour numeric box from which the settings are cloned.

Type:

String | null

hourPlaceholder :String

Gets or sets the placeholder which is visible when the hour input box has no value. Default: HH.

Type:

String

incrementalValue :Number|null

Gets or sets the incremental value in minutes. Minutes must be divisible by 5.

Type:

Number | null

is24HourClock :Boolean

Gets or sets a value indicating whether a 12 or 24 hour clock is used.

Type:

Boolean

maxValue :String|null

Gets or sets the maximum allowed time in format 'HH:MM'. Minutes must be divisible by 5.

Type:

String | null

meridiemValue :String

Gets or sets the meridiem value if it’s not set to a 24 hour clock.

Type:

String

minValue :String|null

Gets or sets the minimum allowed time in format 'HH:MM'. Minutes must be divisible by 5.

Type:

String | null

minuteNumericBoxId :String|null

Gets or sets the id of the minute numeric box from which the settings are cloned.

Type:

String | null

minutePlaceholder :String

Gets or sets the placeholder which is visible when the minute input box has no value. Default: MM.

Type:

String

name :String

Gets or sets the hidden input field name which contains the selected time value.

Type:

String

pickerButtonId :String|null

Gets or sets the id of the picker button from which the settings are cloned.

Type:

String | null

pmButtonId :String|null

Gets or sets the id of the post meridiem (PM) button from which the settings are cloned.

Type:

String | null

readOnly :Boolean

Gets or sets a value indicating whether the timepicker is readonly.

Type:

Boolean

value :String|null

Gets or sets the selected time value in format 'HH:MM'.

Type:

String | null

viewMode :componyx.UI.TimePicker.ViewModeOption

Gets or sets the view mode in which the time picker is rendered.

Type:

componyx.UI.TimePicker.ViewModeOption

(static, readonly) ViewModeOption :number

ViewModeOption

Type:

number

Properties:

Name	Type	Description
`INPUT_CLOCK_POPUP`	number
`INPUT_CLOCK_STATIC`	number
`INPUT`	number
`CLOCK`	number

Methods

clear(fireEventopt)

Clears the input values.

Parameters:

Name	Type	Attributes	Default	Description
`fireEvent`	Boolean	<optional>	false	A value indicating if the onChanged event is fired.

destroy()

Destroys the component.

See:

componyx.UI.base.methods#destroy

getHour() → {Number}

Gets the hour value from the timepicker.

Returns:

Hour value.

Type: Number

getMeridiemValue() → {String}

Gets a value indicating if the time is before or after noon.

Returns:

PM or AM.

Type: String

getMinute() → {Number}

Returns:

Minute value.

Type: Number

getValue() → {String}

Gets the time value in string format.

Returns:

Time value in the format 'hour:minute'.

Type: String

hideClock()

Hides the clock.

postRender()

Handles the post render procedure.

render()

Renders the component

reset(fireEventopt)

Resets the inputs to the initial value.

Parameters:

Name	Type	Attributes	Default	Description
`fireEvent`	Boolean	<optional>	false	A value indicating if the onChanged event is fired.

select()

Selects the text of the first input field of the timepicker.

selectHourClock()

Selects the hour clock.

selectMinuteClock()

Selects the minute clock.

setMeridiemValue(PM)

Sets a value indicating if the time is before or after noon.

Parameters:

Name	Type	Description
`PM`	String	or AM.

setValue(value, fireEventopt)

Sets the time value.

Parameters:

Name	Type	Attributes	Default	Description
`value`	String			The time value in the format hour:minute.
`fireEvent`	Boolean	<optional>	false	A value indicating if the onChanged event is fired.

showClock()

Shows the clock.

suppressNextChangeEvent(action)

Suppresses any change events fired by the underlying input element during the execution of the provided action. Use this when programmatically setting a component value to prevent the change event from propagating as a user interaction. The suppression is automatically lifted after the action completes, even if it throws.