class sap.m.TimePickerSliders

Control sample: sap.m.TimePickerSliders
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/TimePickerSliders
Application Component: CA-UI5-CTR

A picker list container control used inside the sap.m.TimePicker or standalone to hold all the sliders.


Constructor

Constructor for a new TimePickerSliders.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.m.TimePickerSliders(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
displayFormat string

Defines the time displayFormat of the sliders. The displayFormat comes from the browser language settings if not set explicitly.

Visibility: public
height sap.ui.core.CSSSize

Sets the height of the container. If percentage value is used the parent container should have specified height

Visibility: public
labelText string

Defines the text of the picker label.

It is read by screen readers. It is visible only on phone.

Visibility: public
localeId string

Defines the locale used to parse string values representing time.

Determines the locale, used to interpret the string, supplied by the value property.

Example: AM in the string "09:04 AM" is locale (language) dependent. The format comes from the browser language settings if not set explicitly. Used in combination with 12 hour displayFormat containing 'a', which stands for day period string.

Visibility: public
minutesStep int 1

Sets the minutes slider step. If step is less than 1, it will be automatically converted back to 1. The minutes slider is populated only by multiples of the step.

Visibility: public
secondsStep int 1

Sets the seconds slider step. If step is less than 1, it will be automatically converted back to 1. The seconds slider is populated only by multiples of the step.

Visibility: public
support2400 boolean false

Allows to set a value of 24:00, used to indicate the end of the day. Works only with HH or H formats. Don't use it together with am/pm.

Since: 1.54.

Visibility: public
value string

Defines the value of the control.

Visibility: public
valueFormat string

Determines the format of the value property.

Visibility: public
width sap.ui.core.CSSSize

Sets the width of the container. The minimum width is 320px.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
_columns 0..n sap.m.TimePickerSlider

Holds the inner sliders.


Events Overview

Event Description
change

Fired when the value is changed.

change

Fired when the value is changed.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
value string

The new value of the control.


Methods Overview

Method Description
attachChange

Attaches event handler fnFunction to the change event of this sap.m.TimePickerSliders.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.TimePickerSliders itself.

Fired when the value is changed.

collapseAll

Collapses all the slider controls.

detachChange

Detaches event handler fnFunction from the change event of this sap.m.TimePickerSliders.

The passed function and listener object must match the ones used for event registration.

sap.m.TimePickerSliders.extend

Creates a new subclass of class sap.m.TimePickerSliders with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

fireChange

Fires event change to attached listeners.

getDisplayFormat

Gets current value of property displayFormat.

Defines the time displayFormat of the sliders. The displayFormat comes from the browser language settings if not set explicitly.

getHeight

Gets current value of property height.

Sets the height of the container. If percentage value is used the parent container should have specified height

getLabelText

Gets current value of property labelText.

Defines the text of the picker label.

It is read by screen readers. It is visible only on phone.

getLocaleId

Gets current value of property localeId.

Defines the locale used to parse string values representing time.

Determines the locale, used to interpret the string, supplied by the value property.

Example: AM in the string "09:04 AM" is locale (language) dependent. The format comes from the browser language settings if not set explicitly. Used in combination with 12 hour displayFormat containing 'a', which stands for day period string.

sap.m.TimePickerSliders.getMetadata

Returns a metadata object for class sap.m.TimePickerSliders.

getMinutesStep

Gets current value of property minutesStep.

Sets the minutes slider step. If step is less than 1, it will be automatically converted back to 1. The minutes slider is populated only by multiples of the step.

Default value is 1.

getSecondsStep

Gets current value of property secondsStep.

Sets the seconds slider step. If step is less than 1, it will be automatically converted back to 1. The seconds slider is populated only by multiples of the step.

Default value is 1.

getSupport2400

Gets current value of property support2400.

Allows to set a value of 24:00, used to indicate the end of the day. Works only with HH or H formats. Don't use it together with am/pm.

Default value is false.

getTimeValues

Gets the time values from the sliders, as a date object.

getValue

Gets current value of property value.

Defines the value of the control.

getValueFormat

Gets current value of property valueFormat.

Determines the format of the value property.

getWidth

Gets current value of property width.

Sets the width of the container. The minimum width is 320px.

openFirstSlider

Opens first slider.

setDisplayFormat

Sets the time displayFormat.

setHeight

Sets a new value for property height.

Sets the height of the container. If percentage value is used the parent container should have specified height

When called with a value of null or undefined, the default value of the property will be restored.

setLabelText

Sets a new value for property labelText.

Defines the text of the picker label.

It is read by screen readers. It is visible only on phone.

When called with a value of null or undefined, the default value of the property will be restored.

setLocaleId

Sets the localeId property.

setMinutesStep

Sets the minutes slider step.

setSecondsStep

Sets the seconds slider step.

setSupport2400

Sets support2400.

setValue

Sets the value of the TimepickerSliders container.

setValueFormat

Sets a new value for property valueFormat.

Determines the format of the value property.

When called with a value of null or undefined, the default value of the property will be restored.

setWidth

Sets a new value for property width.

Sets the width of the container. The minimum width is 320px.

When called with a value of null or undefined, the default value of the property will be restored.

attachChange

Attaches event handler fnFunction to the change event of this sap.m.TimePickerSliders.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.TimePickerSliders itself.

Fired when the value is changed.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.m.TimePickerSliders itself

collapseAll

Collapses all the slider controls.

detachChange

Detaches event handler fnFunction from the change event of this sap.m.TimePickerSliders.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.m.TimePickerSliders.extend

Creates a new subclass of class sap.m.TimePickerSliders with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireChange

Fires event change to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

value string

The new value of the control.

getDisplayFormat

Gets current value of property displayFormat.

Defines the time displayFormat of the sliders. The displayFormat comes from the browser language settings if not set explicitly.

getHeight

Gets current value of property height.

Sets the height of the container. If percentage value is used the parent container should have specified height

getLabelText

Gets current value of property labelText.

Defines the text of the picker label.

It is read by screen readers. It is visible only on phone.

getLocaleId

Gets current value of property localeId.

Defines the locale used to parse string values representing time.

Determines the locale, used to interpret the string, supplied by the value property.

Example: AM in the string "09:04 AM" is locale (language) dependent. The format comes from the browser language settings if not set explicitly. Used in combination with 12 hour displayFormat containing 'a', which stands for day period string.

sap.m.TimePickerSliders.getMetadata

Returns a metadata object for class sap.m.TimePickerSliders.

getMinutesStep

Gets current value of property minutesStep.

Sets the minutes slider step. If step is less than 1, it will be automatically converted back to 1. The minutes slider is populated only by multiples of the step.

Default value is 1.

getSecondsStep

Gets current value of property secondsStep.

Sets the seconds slider step. If step is less than 1, it will be automatically converted back to 1. The seconds slider is populated only by multiples of the step.

Default value is 1.

getSupport2400

Gets current value of property support2400.

Allows to set a value of 24:00, used to indicate the end of the day. Works only with HH or H formats. Don't use it together with am/pm.

Default value is false.

getTimeValues

Gets the time values from the sliders, as a date object.

getValue

Gets current value of property value.

Defines the value of the control.

getValueFormat

Gets current value of property valueFormat.

Determines the format of the value property.

getWidth

Gets current value of property width.

Sets the width of the container. The minimum width is 320px.

openFirstSlider

Opens first slider.

setDisplayFormat

Sets the time displayFormat.

Param Type DefaultValue Description
sFormat string

New display format

setHeight

Sets a new value for property height.

Sets the height of the container. If percentage value is used the parent container should have specified height

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sHeight sap.ui.core.CSSSize

New value for property height

setLabelText

Sets a new value for property labelText.

Defines the text of the picker label.

It is read by screen readers. It is visible only on phone.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sLabelText string

New value for property labelText

setLocaleId

Sets the localeId property.

Param Type DefaultValue Description
sLocaleId string

The ID of the Locale

setMinutesStep

Sets the minutes slider step.

Param Type DefaultValue Description
value int

The step used to generate values for the minutes slider

setSecondsStep

Sets the seconds slider step.

Param Type DefaultValue Description
value int

The step used to generate values for the seconds slider

setSupport2400

Sets support2400.

Param Type DefaultValue Description
bSupport2400 boolean

setValue

Sets the value of the TimepickerSliders container.

Param Type DefaultValue Description
sValue string

The value of the TimepickerSliders

setValueFormat

Sets a new value for property valueFormat.

Determines the format of the value property.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sValueFormat string

New value for property valueFormat

setWidth

Sets a new value for property width.

Sets the width of the container. The minimum width is 320px.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sWidth sap.ui.core.CSSSize

New value for property width