Class sap.suite.ui.commons.DateRangeSliderInternalModule: sap/suite/ui/commons/DateRangeSliderInternal

extends RangeSlider

The Date Range Slider provides the user with a Range Slider control that is optimized for use with Dates.

Deprecated API:Since version 1.34. Deprecated. Not Fiori.

Constructor Summary
new sap.suite.ui.commons.DateRangeSliderInternal(sId?, mSettings?)Constructor for a new DateRangeSliderInternal.
Event Summary
change(oControlEvent)This event is fired when user changes the positions of the grips of the control.
liveChange(oControlEvent)This live event is fired when user changes the positions of the grips of the control.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.suite.ui.commons.DateRangeSliderInternal.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.DateRangeSliderInternal with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.DateRangeSliderInternal.getMetadata()Returns a metadata object for class sap.suite.ui.commons.DateRangeSliderInternal.
attachChange(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'change' event of this sap.suite.ui.commons.DateRangeSliderInternal.
attachLiveChange(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'liveChange' event of this sap.suite.ui.commons.DateRangeSliderInternal.
detachChange(fnFunction, oListener)Detach event handler fnFunction from the 'change' event of this sap.suite.ui.commons.DateRangeSliderInternal.
detachLiveChange(fnFunction, oListener)Detach event handler fnFunction from the 'liveChange' event of this sap.suite.ui.commons.DateRangeSliderInternal.
fireChange(mArguments?)Fire event change to attached listeners.
fireLiveChange(mArguments?)Fire event liveChange to attached listeners.
getPinGrip()Getter for property pinGrip.
getPinGrip2()Getter for property pinGrip2.
getShowBubbles()Getter for property showBubbles.
setPinGrip(bPinGrip)Setter for property pinGrip.
setPinGrip2(bPinGrip2)Setter for property pinGrip2.
setShowBubbles(bShowBubbles)Setter for property showBubbles.
Methods borrowed from class sap.ui.commons.RangeSlider
Constructor Detail
new sap.suite.ui.commons.DateRangeSliderInternal(sId?, mSettings?)
Constructor for a new DateRangeSliderInternal.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).

The supported settings are:

  • Properties
  • Aggregations
    • Associations
      • Events
        • change : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
        • liveChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

      In addition, all settings applicable to the base type sap.ui.commons.RangeSlider can be used as well.

      Parameters:
      {string}sId? id for the new control, generated automatically if no id is given
      {object}mSettings? initial settings for the new control
      Deprecated:
      Since version 1.34. Deprecated. Not Fiori.
      Event Detail
      change(oControlEvent)
      This event is fired when user changes the positions of the grips of the control. It contains value as Date object and value2 as Date object which are based on the positions of two grips.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      liveChange(oControlEvent)
      This live event is fired when user changes the positions of the grips of the control. It contains value as Date object and value2 as Date object which are based on the positions of two grips.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      Method Detail
      sap.suite.ui.commons.DateRangeSliderInternal.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.suite.ui.commons.DateRangeSliderInternal with name sClassName and enriches it with the information contained in oClassInfo.

      oClassInfo might contain the same kind of informations as described in Element.extend.

      Parameters:
      {string}sClassName name of the class to be created
      {object}oClassInfo? object literal with informations about the class
      {function}FNMetaImpl? constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
      Returns:
      {function} the created class / constructor function
      sap.suite.ui.commons.DateRangeSliderInternal.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.suite.ui.commons.DateRangeSliderInternal.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      attachChange(oData?, fnFunction, oListener?): sap.suite.ui.commons.DateRangeSliderInternal
      Attach event handler fnFunction to the 'change' event of this sap.suite.ui.commons.DateRangeSliderInternal.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.DateRangeSliderInternal.
      itself.

      This event is fired when user changes the positions of the grips of the control. It contains value as Date object and value2 as Date object which are based on the positions of two grips.

      Parameters:
      {object}oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
      {function}fnFunction The function to call, when the event occurs.
      {object}oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.commons.DateRangeSliderInternal.
      itself.
      Returns:
      {sap.suite.ui.commons.DateRangeSliderInternal}this to allow method chaining
      attachLiveChange(oData?, fnFunction, oListener?): sap.suite.ui.commons.DateRangeSliderInternal
      Attach event handler fnFunction to the 'liveChange' event of this sap.suite.ui.commons.DateRangeSliderInternal.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.DateRangeSliderInternal.
      itself.

      This live event is fired when user changes the positions of the grips of the control. It contains value as Date object and value2 as Date object which are based on the positions of two grips.

      Parameters:
      {object}oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
      {function}fnFunction The function to call, when the event occurs.
      {object}oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.commons.DateRangeSliderInternal.
      itself.
      Returns:
      {sap.suite.ui.commons.DateRangeSliderInternal}this to allow method chaining
      detachChange(fnFunction, oListener): sap.suite.ui.commons.DateRangeSliderInternal
      Detach event handler fnFunction from the 'change' event of this sap.suite.ui.commons.DateRangeSliderInternal.

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

      Parameters:
      {function}fnFunction The function to call, when the event occurs.
      {object}oListener Context object on which the given function had to be called.
      Returns:
      {sap.suite.ui.commons.DateRangeSliderInternal}this to allow method chaining
      detachLiveChange(fnFunction, oListener): sap.suite.ui.commons.DateRangeSliderInternal
      Detach event handler fnFunction from the 'liveChange' event of this sap.suite.ui.commons.DateRangeSliderInternal.

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

      Parameters:
      {function}fnFunction The function to call, when the event occurs.
      {object}oListener Context object on which the given function had to be called.
      Returns:
      {sap.suite.ui.commons.DateRangeSliderInternal}this to allow method chaining
      Fire event change to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.suite.ui.commons.DateRangeSliderInternal}this to allow method chaining
      fireLiveChange(mArguments?): sap.suite.ui.commons.DateRangeSliderInternal
      Fire event liveChange to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.suite.ui.commons.DateRangeSliderInternal}this to allow method chaining
      getPinGrip(): boolean
      Getter for property pinGrip. Property to pin Grip (left grip) of the slider so that user cannot move it with key or mouse clicks.

      Default value is false

      Returns:
      {boolean} the value of property pinGrip
      getPinGrip2(): boolean
      Getter for property pinGrip2. Property to pin Grip2 (right grip) of the slider so that user cannot move it with key or mouse clicks.

      Default value is false

      Returns:
      {boolean} the value of property pinGrip2
      getShowBubbles(): boolean
      Getter for property showBubbles. Property to show or hide bubbles. Default is true.

      Default value is true

      Returns:
      {boolean} the value of property showBubbles
      Setter for property pinGrip.

      Default value is false

      Parameters:
      {boolean}bPinGrip new value for property pinGrip
      Returns:
      {sap.suite.ui.commons.DateRangeSliderInternal}this to allow method chaining
      Setter for property pinGrip2.

      Default value is false

      Parameters:
      {boolean}bPinGrip2 new value for property pinGrip2
      Returns:
      {sap.suite.ui.commons.DateRangeSliderInternal}this to allow method chaining
      setShowBubbles(bShowBubbles): sap.suite.ui.commons.DateRangeSliderInternal
      Setter for property showBubbles.

      Default value is true

      Parameters:
      {boolean}bShowBubbles new value for property showBubbles
      Returns:
      {sap.suite.ui.commons.DateRangeSliderInternal}this to allow method chaining