com.sap.ui.commons.client
Class Slider

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.commons.client.Slider

public class Slider
extends com.sap.ui.core.client.Control

The class Slider is the GWT wrapper for the Phoenix control: sap.ui.commons.Slider.

The interactive control is displayed as a horizontal line with a pointer and units of measurement. Users can move the pointer along the line to change values with graphical support.

• Properties
  • width : String
    Width of the slider.
  • min : float
    Minimal value of the slider.
  • max : float
    Maximal value of the slider
  • value : float
    Current value of the slider. (Position of the grip.)
  • smallStepWidth : float
    The grip can only be moved in steps of this width.
  • totalUnits : int
    Number of units that are displayed by ticks. The PageUp and PageDown keys navigate according to these units.
  • stepLabels : boolean
    Display step numbers for the ticks on the slider.
  • visible : boolean
    Invisible sliders are not rendered.
  • editable : boolean
    Using the slider interactively requires value "true".
  • enabled : boolean
    Switches enabled state of the control. Disabled fields have different colors, and can not be focused.
• Aggregations
• Associations
• Events
  • change Value was changed. This event is fired if the value has changed by an user action. Additionally it is fired on setValue if the value is changed because to fit step-wide.
  • liveChange Value was changed. This event is fired during the mouse move. The normal change event ist only fired by mouseup.

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.Slider)

Constructor Summary

protected

Slider() constructs the class Slider hidden due to JavaScriptObject restriction

Method Summary

Slider	attachChangeEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Value was changed.
Slider	attachLiveChangeEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Value was changed.
static Slider	create() creates a new instance of the class Slider
static Slider	create(String idOrConfig) creates a new instance of the class Slider
static Slider	create(String id, String config) creates a new instance of the class Slider
Slider	detachChangeEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Value was changed.
Slider	detachLiveChangeEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Value was changed.
float	getMax() Getter for property max Maximal value of the slider
float	getMin() Getter for property min Minimal value of the slider.
float	getSmallStepWidth() Getter for property smallStepWidth The grip can only be moved in steps of this width.
int	getTotalUnits() Getter for property totalUnits Number of units that are displayed by ticks.
float	getValue() Getter for property value Current value of the slider.
String	getWidth() Getter for property width Width of the slider.
boolean	isEditable() Getter for property editable Using the slider interactively requires value "true".
boolean	isEnabled() Getter for property enabled Switches enabled state of the control.
boolean	isStepLabels() Getter for property stepLabels Display step numbers for the ticks on the slider.
boolean	isVisible() Getter for property visible Invisible sliders are not rendered.
Slider	setEditable(boolean value) Setter for property editable Default value is: true
Slider	setEnabled(boolean value) Setter for property enabled Default value is: true
Slider	setMax(float value) Setter for property max Default value is: 100
Slider	setMin(float value) Setter for property min Default value is: 0
Slider	setSmallStepWidth(float value) Setter for property smallStepWidth
Slider	setStepLabels(boolean value) Setter for property stepLabels Default value is: false
Slider	setTotalUnits(int value) Setter for property totalUnits
Slider	setValue(float value) Setter for property value Default value is: 50
Slider	setVisible(boolean value) Setter for property visible Default value is: true
Slider	setWidth(String value) Setter for property width Default value is: 100%

Methods inherited from class com.sap.ui.core.client.Control

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Slider

protected Slider()

constructs the class Slider
hidden due to JavaScriptObject restriction

Method Detail

create

public static Slider create()

creates a new instance of the class Slider

create

public static Slider create(String idOrConfig)

creates a new instance of the class Slider

Parameters:

id - id of the Slider or configuration JSON string

create

public static Slider create(String id,
                            String config)

creates a new instance of the class Slider

Parameters:

id - id of the Slider

config - configuration JSON string

getWidth

public final String getWidth()

Getter for property width Width of the slider.

Returns:

the value of property width

setWidth

public final Slider setWidth(String value)

Setter for property width
Default value is: 100%

Parameters:

value - String

Returns:

this to allow method chaining

getMin

public final float getMin()

Getter for property min Minimal value of the slider.

Returns:

the value of property min

setMin

public final Slider setMin(float value)

Setter for property min
Default value is: 0

Parameters:

value - float

Returns:

this to allow method chaining

getMax

public final float getMax()

Getter for property max Maximal value of the slider

Returns:

the value of property max

setMax

public final Slider setMax(float value)

Setter for property max
Default value is: 100

Parameters:

value - float

Returns:

this to allow method chaining

getValue

public final float getValue()

Getter for property value Current value of the slider. (Position of the grip.)

Returns:

the value of property value

setValue

public final Slider setValue(float value)

Setter for property value
Default value is: 50

Parameters:

value - float

Returns:

this to allow method chaining

getSmallStepWidth

public final float getSmallStepWidth()

Getter for property smallStepWidth The grip can only be moved in steps of this width.

Returns:

the value of property smallStepWidth

setSmallStepWidth

public final Slider setSmallStepWidth(float value)

Setter for property smallStepWidth

Parameters:

value - float

Returns:

this to allow method chaining

getTotalUnits

public final int getTotalUnits()

Getter for property totalUnits Number of units that are displayed by ticks. The PageUp and PageDown keys navigate according to these units.

Returns:

the value of property totalUnits

setTotalUnits

public final Slider setTotalUnits(int value)

Setter for property totalUnits

Parameters:

value - int

Returns:

this to allow method chaining

isStepLabels

public final boolean isStepLabels()

Getter for property stepLabels Display step numbers for the ticks on the slider.

Returns:

the value of property stepLabels

setStepLabels

public final Slider setStepLabels(boolean value)

Setter for property stepLabels
Default value is: false

Parameters:

value - boolean

Returns:

this to allow method chaining

isVisible

public final boolean isVisible()

Getter for property visible Invisible sliders are not rendered.

Returns:

the value of property visible

setVisible

public final Slider setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

isEditable

public final boolean isEditable()

Getter for property editable Using the slider interactively requires value "true".

Returns:

the value of property editable

setEditable

public final Slider setEditable(boolean value)

Setter for property editable
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

isEnabled

public final boolean isEnabled()

Getter for property enabled Switches enabled state of the control. Disabled fields have different colors, and can not be focused.

Returns:

the value of property enabled

setEnabled

public final Slider setEnabled(boolean value)

Setter for property enabled
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

attachChangeEvent

public final Slider attachChangeEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Value was changed. This event is fired if the value has changed by an user action. Additionally it is fired on setValue if the value is changed because to fit step-wide.

Event Parameters:

{sap.ui.core/float} value Current value of the slider after a change.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachChangeEvent

public final Slider detachChangeEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Value was changed. This event is fired if the value has changed by an user action. Additionally it is fired on setValue if the value is changed because to fit step-wide.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

attachLiveChangeEvent

public final Slider attachLiveChangeEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Value was changed. This event is fired during the mouse move. The normal change event ist only fired by mouseup.

Event Parameters:

{sap.ui.core/float} value Current value of the slider after a change.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachLiveChangeEvent

public final Slider detachLiveChangeEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Value was changed. This event is fired during the mouse move. The normal change event ist only fired by mouseup.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining