public Class DragScrollListener

Class Inheritance

java.lang.Object
com.badlogic.gdx.scenes.scene2d.InputListener
com.badlogic.gdx.scenes.scene2d.utils.DragListener
com.badlogic.gdx.scenes.scene2d.utils.DragScrollListener

Imports

com.badlogic.gdx.math.Interpolation, .Vector2, com.badlogic.gdx.scenes.scene2d.InputEvent, com.badlogic.gdx.scenes.scene2d.ui.ScrollPane, com.badlogic.gdx.utils.Timer, .Timer.Task

Causes a scroll pane to scroll when a drag goes outside the bounds of the scroll pane. Attach the listener to the actor which will cause scrolling when dragged, usually the scroll pane or the scroll pane's actor.

If ScrollPane#setFlickScroll(boolean) is true, the scroll pane must have ScrollPane#setCancelTouchFocus(boolean) false. When a drag starts that should drag rather than flick scroll, cancel the scroll pane's touch focus using stage.cancelTouchFocus(scrollPane);. In this case the drag scroll listener must not be attached to the scroll pane, else it would also lose touch focus. Instead it can be attached to the scroll pane's actor.

If using drag and drop, DragAndDrop#setCancelTouchFocus(boolean) must be false.

Author: Nathan Sweet

Field Summary

Modifier and Type	Field and Description
pack-priv Interpolation	interpolation
pack-priv float	maxSpeed
pack-priv float	minSpeed
pack-priv float	padBottom
pack-priv float	padTop
pack-priv long	rampTime
private ScrollPane	scroll
private Timer.Task	scrollDown
private Timer.Task	scrollUp
pack-priv long	startTime
pack-priv float	tickSecs
pack-priv static final Vector2	tmpCoords Hides com.badlogic.gdx.scenes.scene2d.InputListener.tmpCoords.

Constructor Summary

Access	Constructor and Description
public	DragScrollListener(final ScrollPane scroll)

Method Summary

Modifier and Type	Method and Description
public void	drag(InputEvent event, float x, float y, int pointer) Overrides com.badlogic.gdx.scenes.scene2d.utils.DragListener.drag.
public void	dragStop(InputEvent event, float x, float y, int pointer) Overrides com.badlogic.gdx.scenes.scene2d.utils.DragListener.dragStop.
pack-priv float	getScrollPixels()
protected boolean	isAbove(float y)
protected boolean	isBelow(float y)
protected void	scroll(float y)
public void	setPadding(float padTop, float padBottom)
public void	setup(float minSpeedPixels, float maxSpeedPixels, float tickSecs, float rampSecs)

Field Detail

interpolation	back to summary
pack-priv Interpolation interpolation

maxSpeed	back to summary
pack-priv float maxSpeed

minSpeed	back to summary
pack-priv float minSpeed

padBottom	back to summary
pack-priv float padBottom

padTop	back to summary
pack-priv float padTop

rampTime	back to summary
pack-priv long rampTime

scroll	back to summary
private ScrollPane scroll

scrollDown	back to summary
private Timer.Task scrollDown

scrollUp	back to summary
private Timer.Task scrollUp

startTime	back to summary
pack-priv long startTime

tickSecs	back to summary
pack-priv float tickSecs

tmpCoords	back to summary
pack-priv static final Vector2 tmpCoords Hides com.badlogic.gdx.scenes.scene2d.InputListener.tmpCoords.

Constructor Detail

DragScrollListener	back to summary
public DragScrollListener(final ScrollPane scroll)

Method Detail

drag	back to summary
public void drag(InputEvent event, float x, float y, int pointer) Overrides com.badlogic.gdx.scenes.scene2d.utils.DragListener.drag.

dragStop	back to summary
public void dragStop(InputEvent event, float x, float y, int pointer) Overrides com.badlogic.gdx.scenes.scene2d.utils.DragListener.dragStop.

getScrollPixels	back to summary
pack-priv float getScrollPixels()

isAbove	back to summary
protected boolean isAbove(float y)

isBelow	back to summary
protected boolean isBelow(float y)

scroll	back to summary
protected void scroll(float y)

setPadding	back to summary
public void setPadding(float padTop, float padBottom)

setup	back to summary
public void setup(float minSpeedPixels, float maxSpeedPixels, float tickSecs, float rampSecs)