
public class Scroller
extends JsObject

The Scroller class contains methods for configuring standalones scroller.

Constructor Summary

Constructors
Constructor	Description
`Scroller(String jsChart)`

Method Summary

Modifier and Type	Method	Description
`static Scroller`	`instantiate()`
`String`	`getJsBase()`
`void`	`allowRangeChange()`	Getter for the mode of the range changing.
`Scroller`	`allowRangeChange(Boolean enabled)`	Setter for the mode of the range changing.
`void`	`autoHide()`	Getter for scroller auto hide mode.
`Scroller`	`autoHide(Boolean enabled)`	Setter for scroller auto hide mode.
`Layer`	`container()`	Getter for the scroller container.
`Scroller`	`container(Layer element)`	Setter for the scroller container.
`Scroller`	`container(Stage element)`	Setter for the scroller container.
`Scroller`	`draw()`	Draws scroller.
`void`	`enabled()`	Getter for the element state (enabled or disabled).
`Scroller`	`enabled(Boolean enabled)`	Setter for the element enabled state.
`void`	`endRatio()`	Getter for the end ratio.
`Scroller`	`endRatio(Number ratio)`	Setter for the end ratio.
`void`	`fill()`	Getter for the scroller fill.
`Scroller`	`fill(Fill color)`	Setter for scroller fill settings using an array, an object or a string.
`Scroller`	`fill(GradientKey color)`	Setter for scroller fill settings using an array, an object or a string.
`Scroller`	`fill(Array<String> color)`	Setter for scroller fill settings using an array, an object or a string.
`Scroller`	`fill(String color, Number opacity)`	Scroller fill color with opacity.
`Scroller`	`fill(GradientKey keys, Number angle, Boolean mode, Number opacity)`	Linear gradient fill.
`Scroller`	`fill(GradientKey keys, Number angle, Rect mode, Number opacity)`	Linear gradient fill.
`Scroller`	`fill(GradientKey keys, Number angle, String mode, Number opacity)`	Linear gradient fill.
`Scroller`	`fill(Array<String> keys, Number angle, Boolean mode, Number opacity)`	Linear gradient fill.
`Scroller`	`fill(Array<String> keys, Number angle, Rect mode, Number opacity)`	Linear gradient fill.
`Scroller`	`fill(Array<String> keys, Number angle, String mode, Number opacity)`	Linear gradient fill.
`Scroller`	`fill(GradientKey keys, Number cx, Number cy, Rect mode, Number opacity, Number fx, Number fy)`	Radial gradient fill.
`Scroller`	`fill(Array<String> keys, Number cx, Number cy, Rect mode, Number opacity, Number fx, Number fy)`	Radial gradient fill.
`Rect`	`getRemainingBounds()`	Returns the remaining (after scroller placement) part of the container.
`void`	`height()`	Getter for the scroller height.
`Scroller`	`height(Number height)`	Setter for the scroller height.
`Scroller`	`height(String height)`	Setter for the scroller height.
`void`	`maxHeight()`	Getter for the scroller maximum height.
`Scroller`	`maxHeight(Number height)`	Setter for the scroller maximum height.
`Scroller`	`maxHeight(String height)`	Setter for the scroller maximum height.
`void`	`minHeight()`	Setter for the scroller minimum height.
`Scroller`	`minHeight(Number height)`	Setter for the scroller minimum height.
`Scroller`	`minHeight(String height)`	Setter for the scroller minimum height.
`void`	`orientation()`	Getter for the scroller orientation.
`Scroller`	`orientation(Orientation orientation)`	Setter for the scroller orientation.
`Scroller`	`orientation(String orientation)`	Setter for the scroller orientation.
`void`	`outlineStroke()`	Getter for outline stroke settings.
`Scroller`	`outlineStroke(Stroke color, Number thickness, String dashpattern, String lineJoin, String lineCap)`	Setter for outline stroke settings.
`Scroller`	`outlineStroke(Stroke color, Number thickness, String dashpattern, String lineJoin, StrokeLineCap lineCap)`	Setter for outline stroke settings.
`Scroller`	`outlineStroke(Stroke color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, String lineCap)`	Setter for outline stroke settings.
`Scroller`	`outlineStroke(Stroke color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, StrokeLineCap lineCap)`	Setter for outline stroke settings.
`Scroller`	`outlineStroke(ColoredFill color, Number thickness, String dashpattern, String lineJoin, String lineCap)`	Setter for outline stroke settings.
`Scroller`	`outlineStroke(ColoredFill color, Number thickness, String dashpattern, String lineJoin, StrokeLineCap lineCap)`	Setter for outline stroke settings.
`Scroller`	`outlineStroke(ColoredFill color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, String lineCap)`	Setter for outline stroke settings.
`Scroller`	`outlineStroke(ColoredFill color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, StrokeLineCap lineCap)`	Setter for outline stroke settings.
`Scroller`	`outlineStroke(String color, Number thickness, String dashpattern, String lineJoin, String lineCap)`	Setter for outline stroke settings.
`Scroller`	`outlineStroke(String color, Number thickness, String dashpattern, String lineJoin, StrokeLineCap lineCap)`	Setter for outline stroke settings.
`Scroller`	`outlineStroke(String color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, String lineCap)`	Setter for outline stroke settings.
`Scroller`	`outlineStroke(String color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, StrokeLineCap lineCap)`	Setter for outline stroke settings.
`Scroller`	`outlineStroke(String settings)`	Setter for outline stroke using an object.
`Rect`	`parentBounds()`	Getter for parent bounds.
`Scroller`	`parentBounds(Rect bounds)`	Setter for bounds using single value.
`Scroller`	`parentBounds(String bounds)`	Setter for bounds using single value.
`Scroller`	`parentBounds(Number left, Number top, Number width, Number height)`	Setter for bounds using several values.
`void`	`print(PaperSize paperSizeOrOptions, Boolean landscape)`	Prints all elements on related stage.
`void`	`print(String paperSizeOrOptions, Boolean landscape)`	Prints all elements on related stage.
`void`	`removeAllListeners(String type)`	Removes all listeners from an object.
`void`	`selectedFill()`	Getter for scroller fill in selected mode.
`Scroller`	`selectedFill(Fill color)`	Setter for scroller fill settings in selected mode using an array or a string.
`Scroller`	`selectedFill(GradientKey color)`	Setter for scroller fill settings in selected mode using an array or a string.
`Scroller`	`selectedFill(Array<String> color)`	Setter for scroller fill settings in selected mode using an array or a string.
`Scroller`	`selectedFill(String color, Number opacity)`	Scroller fill color in selected mode with opacity.
`Scroller`	`selectedFill(GradientKey keys, Number angle, Boolean mode, Number opacity)`	Linear gradient fill in selected mode.
`Scroller`	`selectedFill(GradientKey keys, Number angle, Rect mode, Number opacity)`	Linear gradient fill in selected mode.
`Scroller`	`selectedFill(GradientKey keys, Number angle, String mode, Number opacity)`	Linear gradient fill in selected mode.
`Scroller`	`selectedFill(Array<String> keys, Number angle, Boolean mode, Number opacity)`	Linear gradient fill in selected mode.
`Scroller`	`selectedFill(Array<String> keys, Number angle, Rect mode, Number opacity)`	Linear gradient fill in selected mode.
`Scroller`	`selectedFill(Array<String> keys, Number angle, String mode, Number opacity)`	Linear gradient fill in selected mode.
`Scroller`	`selectedFill(GradientKey keys, Number cx, Number cy, Rect mode, Number opacity, Number fx, Number fy)`	Radial gradient fill in selected mode.
`Scroller`	`selectedFill(Array<String> keys, Number cx, Number cy, Rect mode, Number opacity, Number fx, Number fy)`	Radial gradient fill in selected mode.
`Scroller`	`setRange(Number startRatio, Number endRatio)`	Changes current selected range to the passed one.
`void`	`startRatio()`	Getter for the starting ratio.
`Scroller`	`startRatio(Number value)`	Setter for the starting ratio.
`Thumbs`	`thumbs()`	Getter for the thumbs.
`Scroller`	`thumbs(Boolean settings)`	Setter for the thumbs settings.
`Scroller`	`thumbs(String settings)`	Setter for the thumbs settings.
`void`	`setOnClickListener(ListenersInterface.OnClickListener listener)`
`void`	`setOnClickListener(ListenersInterface.OnClickListener listener, String type, String ePath)`
`void`	`unlistenByKey(String key)`	Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
`void`	`zIndex()`	Getter for the Z-index of the element.
`Scroller`	`zIndex(Number zIndex)`	Setter for the Z-index of the element.
`Scroller`	`fill(String value)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Scroller
```
Scroller(String jsChart)
```
- Method Detail
  - instantiate
```
 static Scroller instantiate()
```
  - getJsBase
```
 String getJsBase()
```
  - allowRangeChange
```
 void allowRangeChange()
```
    Getter for the mode of the range changing.
  - allowRangeChange
```
 Scroller allowRangeChange(Boolean enabled)
```
    Setter for the mode of the range changing. If the range changing is allowed.
  - autoHide
```
 void autoHide()
```
    Getter for scroller auto hide mode.
  - autoHide
```
 Scroller autoHide(Boolean enabled)
```
    Setter for scroller auto hide mode.
  - container
```
 Layer container()
```
    Getter for the scroller container.
  - container
```
 Scroller container(Layer element)
```
    Setter for the scroller container.
  - container
```
 Scroller container(Stage element)
```
    Setter for the scroller container.
  - draw
```
 Scroller draw()
```
    Draws scroller.
  - enabled
```
 void enabled()
```
    Getter for the element state (enabled or disabled).
  - enabled
```
 Scroller enabled(Boolean enabled)
```
    Setter for the element enabled state.
  - endRatio
```
 void endRatio()
```
    Getter for the end ratio.
  - endRatio
```
 Scroller endRatio(Number ratio)
```
    Setter for the end ratio.Note: It is always greater than the startRatio.
  - fill
```
 void fill()
```
    Getter for the scroller fill.
  - fill
```
 Scroller fill(Fill color)
```
    Setter for scroller fill settings using an array, an object or a string. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 Scroller fill(GradientKey color)
```
    Setter for scroller fill settings using an array, an object or a string. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 Scroller fill(Array<String> color)
```
    Setter for scroller fill settings using an array, an object or a string. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 Scroller fill(String color, Number opacity)
```
    Scroller fill color with opacity.
  - fill
```
 Scroller fill(GradientKey keys, Number angle, Boolean mode, Number opacity)
```
    Linear gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 Scroller fill(GradientKey keys, Number angle, Rect mode, Number opacity)
```
    Linear gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 Scroller fill(GradientKey keys, Number angle, String mode, Number opacity)
```
    Linear gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 Scroller fill(Array<String> keys, Number angle, Boolean mode, Number opacity)
```
    Linear gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 Scroller fill(Array<String> keys, Number angle, Rect mode, Number opacity)
```
    Linear gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 Scroller fill(Array<String> keys, Number angle, String mode, Number opacity)
```
    Linear gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 Scroller fill(GradientKey keys, Number cx, Number cy, Rect mode, Number opacity, Number fx, Number fy)
```
    Radial gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 Scroller fill(Array<String> keys, Number cx, Number cy, Rect mode, Number opacity, Number fx, Number fy)
```
    Radial gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - getRemainingBounds
```
 Rect getRemainingBounds()
```
    Returns the remaining (after scroller placement) part of the container.
  - height
```
 void height()
```
    Getter for the scroller height.
  - height
```
 Scroller height(Number height)
```
    Setter for the scroller height.
  - height
```
 Scroller height(String height)
```
    Setter for the scroller height.
  - maxHeight
```
 void maxHeight()
```
    Getter for the scroller maximum height.
  - maxHeight
```
 Scroller maxHeight(Number height)
```
    Setter for the scroller maximum height.
  - maxHeight
```
 Scroller maxHeight(String height)
```
    Setter for the scroller maximum height.
  - minHeight
```
 void minHeight()
```
    Setter for the scroller minimum height.
  - minHeight
```
 Scroller minHeight(Number height)
```
    Setter for the scroller minimum height.
  - minHeight
```
 Scroller minHeight(String height)
```
    Setter for the scroller minimum height.
  - orientation
```
 void orientation()
```
    Getter for the scroller orientation.
  - orientation
```
 Scroller orientation(Orientation orientation)
```
    Setter for the scroller orientation.
  - orientation
```
 Scroller orientation(String orientation)
```
    Setter for the scroller orientation.
  - outlineStroke
```
 void outlineStroke()
```
    Getter for outline stroke settings.
  - outlineStroke
```
 Scroller outlineStroke(Stroke color, Number thickness, String dashpattern, String lineJoin, String lineCap)
```
    Setter for outline stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - outlineStroke
```
 Scroller outlineStroke(Stroke color, Number thickness, String dashpattern, String lineJoin, StrokeLineCap lineCap)
```
    Setter for outline stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - outlineStroke
```
 Scroller outlineStroke(Stroke color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, String lineCap)
```
    Setter for outline stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - outlineStroke
```
 Scroller outlineStroke(Stroke color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, StrokeLineCap lineCap)
```
    Setter for outline stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - outlineStroke
```
 Scroller outlineStroke(ColoredFill color, Number thickness, String dashpattern, String lineJoin, String lineCap)
```
    Setter for outline stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - outlineStroke
```
 Scroller outlineStroke(ColoredFill color, Number thickness, String dashpattern, String lineJoin, StrokeLineCap lineCap)
```
    Setter for outline stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - outlineStroke
```
 Scroller outlineStroke(ColoredFill color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, String lineCap)
```
    Setter for outline stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - outlineStroke
```
 Scroller outlineStroke(ColoredFill color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, StrokeLineCap lineCap)
```
    Setter for outline stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - outlineStroke
```
 Scroller outlineStroke(String color, Number thickness, String dashpattern, String lineJoin, String lineCap)
```
    Setter for outline stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - outlineStroke
```
 Scroller outlineStroke(String color, Number thickness, String dashpattern, String lineJoin, StrokeLineCap lineCap)
```
    Setter for outline stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - outlineStroke
```
 Scroller outlineStroke(String color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, String lineCap)
```
    Setter for outline stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - outlineStroke
```
 Scroller outlineStroke(String color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, StrokeLineCap lineCap)
```
    Setter for outline stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - outlineStroke
```
 Scroller outlineStroke(String settings)
```
    Setter for outline stroke using an object.
  - parentBounds
```
 Rect parentBounds()
```
    Getter for parent bounds. As a getter falls back to stage bounds.
  - parentBounds
```
 Scroller parentBounds(Rect bounds)
```
    Setter for bounds using single value.
  - parentBounds
```
 Scroller parentBounds(String bounds)
```
    Setter for bounds using single value.
  - parentBounds
```
 Scroller parentBounds(Number left, Number top, Number width, Number height)
```
    Setter for bounds using several values.
  - print
```
 void print(PaperSize paperSizeOrOptions, Boolean landscape)
```
    Prints all elements on related stage.
  - print
```
 void print(String paperSizeOrOptions, Boolean landscape)
```
    Prints all elements on related stage.
  - removeAllListeners
```
 void removeAllListeners(String type)
```
    Removes all listeners from an object. You can also optionally remove listeners of some particular type.
  - selectedFill
```
 void selectedFill()
```
    Getter for scroller fill in selected mode.
  - selectedFill
```
 Scroller selectedFill(Fill color)
```
    Setter for scroller fill settings in selected mode using an array or a string. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - selectedFill
```
 Scroller selectedFill(GradientKey color)
```
    Setter for scroller fill settings in selected mode using an array or a string. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - selectedFill
```
 Scroller selectedFill(Array<String> color)
```
    Setter for scroller fill settings in selected mode using an array or a string. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - selectedFill
```
 Scroller selectedFill(String color, Number opacity)
```
    Scroller fill color in selected mode with opacity.
  - selectedFill
```
 Scroller selectedFill(GradientKey keys, Number angle, Boolean mode, Number opacity)
```
    Linear gradient fill in selected mode. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - selectedFill
```
 Scroller selectedFill(GradientKey keys, Number angle, Rect mode, Number opacity)
```
    Linear gradient fill in selected mode. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - selectedFill
```
 Scroller selectedFill(GradientKey keys, Number angle, String mode, Number opacity)
```
    Linear gradient fill in selected mode. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - selectedFill
```
 Scroller selectedFill(Array<String> keys, Number angle, Boolean mode, Number opacity)
```
    Linear gradient fill in selected mode. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - selectedFill
```
 Scroller selectedFill(Array<String> keys, Number angle, Rect mode, Number opacity)
```
    Linear gradient fill in selected mode. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - selectedFill
```
 Scroller selectedFill(Array<String> keys, Number angle, String mode, Number opacity)
```
    Linear gradient fill in selected mode. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - selectedFill
```
 Scroller selectedFill(GradientKey keys, Number cx, Number cy, Rect mode, Number opacity, Number fx, Number fy)
```
    Radial gradient fill in selected mode. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - selectedFill
```
 Scroller selectedFill(Array<String> keys, Number cx, Number cy, Rect mode, Number opacity, Number fx, Number fy)
```
    Radial gradient fill in selected mode. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - setRange
```
 Scroller setRange(Number startRatio, Number endRatio)
```
    Changes current selected range to the passed one.
  - startRatio
```
 void startRatio()
```
    Getter for the starting ratio.
  - startRatio
```
 Scroller startRatio(Number value)
```
    Setter for the starting ratio.Note: It is always less than the endRatio.
  - thumbs
```
 Thumbs thumbs()
```
    Getter for the thumbs.
  - thumbs
```
 Scroller thumbs(Boolean settings)
```
    Setter for the thumbs settings.
  - thumbs
```
 Scroller thumbs(String settings)
```
    Setter for the thumbs settings.
  - setOnClickListener
```
 void setOnClickListener(ListenersInterface.OnClickListener listener)
```
  - setOnClickListener
```
 void setOnClickListener(ListenersInterface.OnClickListener listener, String type, String ePath)
```
  - unlistenByKey
```
 void unlistenByKey(String key)
```
    Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
  - zIndex
```
 void zIndex()
```
    Getter for the Z-index of the element.
  - zIndex
```
 Scroller zIndex(Number zIndex)
```
    Setter for the Z-index of the element.
  - fill
```
 Scroller fill(String value)
```

Class Scroller

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Scroller

Method Detail

instantiate

getJsBase

allowRangeChange

allowRangeChange

autoHide

autoHide

container

container

container

draw

enabled

enabled

endRatio

endRatio

fill

fill

fill

fill

fill

fill

fill

fill

fill

fill

fill

fill

fill

getRemainingBounds

height

height

height

maxHeight

maxHeight

maxHeight

minHeight

minHeight

minHeight

orientation

orientation

orientation

outlineStroke

outlineStroke

outlineStroke

outlineStroke

outlineStroke

outlineStroke

outlineStroke

outlineStroke

outlineStroke

outlineStroke

outlineStroke

outlineStroke

outlineStroke

outlineStroke

parentBounds

parentBounds

parentBounds

parentBounds

print

print

removeAllListeners

selectedFill

selectedFill

selectedFill

selectedFill

selectedFill

selectedFill

selectedFill

selectedFill

selectedFill

selectedFill

selectedFill

selectedFill