Constructor Detail

• ScrollHandler

  ScrollHandler(Function1<Float, Unit> setScrollAmount, Float maxScrollDistance)

  Handles scroll events.

  Parameters:

  setScrollAmount - called when the scroll amount changes.

  maxScrollDistance - the initial maximum scroll amount.

• ScrollHandler

  ScrollHandler(Float initialMaxValue)

  Parameters:

  initialMaxValue - the initial maximum scroll amount.

Method Detail

• getValue

   final Float getValue()

  The current scroll amount (in pixels).

• setValue

   final Unit setValue(Float value)

  The current scroll amount (in pixels).

• getMaxValue

   final Float getMaxValue()

  The maximum scroll amount (in pixels).

• setMaxValue

   final Unit setMaxValue(Float maxValue)

  The maximum scroll amount (in pixels).

• getCurrentScroll

   final Float getCurrentScroll()

• setCurrentScroll

   final Unit setCurrentScroll(@Deprecated(message = Use the `value` field instead., level = DeprecationLevel.ERROR) Float currentScroll)

• getMaxScrollDistance

   final Float getMaxScrollDistance()

• setMaxScrollDistance

   final Unit setMaxScrollDistance(@Deprecated(message = Use the `maxValue` field instead., level = DeprecationLevel.ERROR) Float maxScrollDistance)

• handleScrollDelta

   final Float handleScrollDelta(Float delta)

  Increments value by delta if the result of the operation belongs to the interval [0, maxValue].

• canScrollBy

   final Boolean canScrollBy(Float delta)

  Checks whether a scroll by the given delta value is possible.

• handleScroll

   final Float handleScroll(Float targetScroll)

  Updates value to targetScroll, which is restricted to the interval [0, maxValue].

• handleInitialScroll

   final Unit handleInitialScroll(InitialScroll initialScroll)

  Updates value to match the provided InitialScroll.

• registerScrollListener

   Unit registerScrollListener(ScrollListener scrollListener)

  Registers a ScrollListener.

• removeScrollListener

   Unit removeScrollListener(ScrollListener scrollListener)

  Removes a ScrollListener.