libGDX 1.14.2 · com.badlogic.gdx.scenes.scene2d.ui.ScrollPane

Modifier and Type	Class and Description
public static class	ScrollPane.ScrollPaneStyle The style for a scroll pane, see `ScrollPane`.

Field Summary

Modifier and Type	Field and Description
private Actor	actor
pack-priv final Rectangle	actorArea
private final Rectangle	actorCullingArea
pack-priv float	amountX
pack-priv float	amountY
pack-priv boolean	cancelTouchFocus
private boolean	clamp
pack-priv boolean	disableX
pack-priv boolean	disableY
pack-priv int	draggingPointer
pack-priv float	fadeAlpha
pack-priv float	fadeAlphaSeconds
pack-priv float	fadeDelay
pack-priv float	fadeDelaySeconds
pack-priv boolean	fadeScrollBars
pack-priv boolean	flickScroll
private ActorGestureListener	flickScrollListener
pack-priv float	flingTime
pack-priv float	flingTimer
private boolean	forceScrollX
private boolean	forceScrollY
pack-priv final Rectangle	hKnobBounds
pack-priv final Rectangle	hScrollBounds
pack-priv boolean	hScrollOnBottom
pack-priv final Vector2	lastPoint
pack-priv float	maxX
pack-priv float	maxY
private float	overscrollDistance
private float	overscrollSpeedMax
private float	overscrollSpeedMin
private boolean	overscrollX
private boolean	overscrollY
private boolean	scrollbarsOnTop
pack-priv boolean	scrollBarTouch
pack-priv boolean	scrollX
pack-priv boolean	scrollY
pack-priv boolean	smoothScrolling
private ScrollPane.ScrollPaneStyle	style
pack-priv boolean	touchScrollH
pack-priv boolean	touchScrollV
private boolean	variableSizeKnobs
pack-priv float	velocityX
pack-priv float	velocityY
pack-priv float	visualAmountX
pack-priv float	visualAmountY
pack-priv final Rectangle	vKnobBounds
pack-priv final Rectangle	vScrollBounds
pack-priv boolean	vScrollOnRight

Access	Constructor and Description
public	ScrollPane(Actor May be null. actor)
public	ScrollPane(Actor May be null. actor, Skin skin)
public	ScrollPane(Actor May be null. actor, Skin skin, String styleName)
public	ScrollPane(Actor May be null. actor, ScrollPane.ScrollPaneStyle style)

Method Summary

Modifier and Type	Method and Description
public void	act(float delta) Overrides com.badlogic.gdx.scenes.scene2d.Group.act. Updates the actor based on time.
public void	addActor(Actor actor) Overrides com.badlogic.gdx.scenes.scene2d.Group.addActor. Deprecated ScrollPane may have only a single child. Adds an actor as a child of this group, removing it from its previous parent.
public void	addActorAfter(Actor actorAfter, Actor actor) Overrides com.badlogic.gdx.scenes.scene2d.Group.addActorAfter. Deprecated ScrollPane may have only a single child. Adds an actor as a child of this group immediately after another child actor, removing it from its previous parent.
public void	addActorAt(int index, Actor actor) Overrides com.badlogic.gdx.scenes.scene2d.Group.addActorAt. Deprecated ScrollPane may have only a single child. Adds an actor as a child of this group at a specific index, removing it from its previous parent.
public void	addActorBefore(Actor actorBefore, Actor actor) Overrides com.badlogic.gdx.scenes.scene2d.Group.addActorBefore. Deprecated ScrollPane may have only a single child. Adds an actor as a child of this group immediately before another child actor, removing it from its previous parent.
protected void	addCaptureListener()
protected void	addScrollListener()
public void	cancel() If currently scrolling by tracking a touch down, stop scrolling.
public void	cancelTouchFocus() Cancels the stage's touch focus for all listeners except this scroll pane's flick scroll listener.
pack-priv void	clamp()
public void	draw(Batch batch, float parentAlpha) Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.draw. If this method is overridden, the super method or `validate()` should be called to ensure the widget group is laid out.
public void	drawDebug(ShapeRenderer shapes) Overrides com.badlogic.gdx.scenes.scene2d.Group.drawDebug. Draws this actor's debug lines if `getDebug()` is true and, regardless of `getDebug()`, calls `Actor#drawDebug(ShapeRenderer)` on each child.
protected void	drawScrollBars(Batch batch, float r, float g, float b, float a) Renders the scrollbars after the children have been drawn.
public void	fling(float Time in seconds for which you want to fling last. flingTime, float Velocity for horizontal direction. velocityX, float Velocity for vertical direction. velocityY) Generate fling gesture.
public Actor	getActor() Returns the actor embedded in this scroll pane, or null.
public boolean	getFadeScrollBars()
protected ActorGestureListener	getFlickScrollListener() Called by constructor.
public float	getMaxX() Returns the maximum scroll value in the x direction.
public float	getMaxY() Returns the maximum scroll value in the y direction.
public float	getMinHeight() Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.getMinHeight. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getMinHeight.
public float	getMinWidth() Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.getMinWidth. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getMinWidth.
protected float	getMouseWheelX() Returns the amount to scroll horizontally when the mouse wheel is scrolled.
protected float	getMouseWheelY() Returns the amount to scroll vertically when the mouse wheel is scrolled.
public float	getOverscrollDistance()
public float	getPrefHeight() Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.getPrefHeight. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.
public float	getPrefWidth() Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.getPrefWidth. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefWidth.
public float	getScrollBarHeight()
public float	getScrollBarWidth()
public float	getScrollHeight() Returns the height of the scrolled viewport.
public float	getScrollPercentX()
public float	getScrollPercentY()
public float	getScrollWidth() Returns the width of the scrolled viewport.
public float	getScrollX() Returns the x scroll position in pixels, where 0 is the left of the scroll pane.
public float	getScrollY() Returns the y scroll position in pixels, where 0 is the top of the scroll pane.
public ScrollPane.ScrollPaneStyle	getStyle() Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle. Returns the scroll pane's style.
public boolean	getVariableSizeKnobs()
public float	getVelocityX() Gets the flick scroll x velocity.
public float	getVelocityY() Gets the flick scroll y velocity.
public float	getVisualScrollPercentX()
public float	getVisualScrollPercentY()
public float	getVisualScrollX()
public float	getVisualScrollY()
public Actor	getWidget() Deprecated Use `getActor()`.
public Actor	hit(float x, float y, boolean touchable) Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.hit. If this method is overridden, the super method or `validate()` should be called to ensure the widget group is laid out.
public boolean	isBottomEdge()
public boolean	isDragging()
public boolean	isFlinging()
public boolean	isForceScrollX()
public boolean	isForceScrollY()
public boolean	isLeftEdge()
public boolean	isPanning()
public boolean	isRightEdge()
public boolean	isScrollingDisabledX()
public boolean	isScrollingDisabledY()
public boolean	isScrollX() Returns true if the actor is larger than the scroll pane horizontally.
public boolean	isScrollY() Returns true if the actor is larger than the scroll pane vertically.
public boolean	isTopEdge()
public void	layout() Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.layout. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.layout. Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls `invalidate()` on any each child whose width or height has changed, and calls `validate()` on each child.
public boolean	removeActor(Actor actor) Overrides com.badlogic.gdx.scenes.scene2d.Group.removeActor. Removes an actor from this group and unfocuses it.
public boolean	removeActor(Actor actor, boolean unfocus) Overrides com.badlogic.gdx.scenes.scene2d.Group.removeActor. Removes an actor from this group.
public Actor	removeActorAt(int index, boolean unfocus) Overrides com.badlogic.gdx.scenes.scene2d.Group.removeActorAt. Removes an actor from this group.
public void	scrollTo(float x, float y, float width, float height) Sets the scroll offset so the specified rectangle is fully in view, if possible.
public void	scrollTo(float x, float y, float width, float height, boolean centerHorizontal, boolean centerVertical) Sets the scroll offset so the specified rectangle is fully in view, and optionally centered vertically and/or horizontally, if possible.
protected void	scrollX(float pixelsX) Called whenever the x scroll amount is changed.
protected void	scrollY(float pixelsY) Called whenever the y scroll amount is changed.
public void	setActor(Actor May be null to remove any current actor. actor) Sets the `Actor` embedded in this scroll pane.
public void	setCancelTouchFocus(boolean cancelTouchFocus) When true (default) and flick scrolling begins, `cancelTouchFocus()` is called.
public void	setClamp(boolean clamp) For flick scroll, prevents scrolling out of the actor's bounds.
public void	setFadeScrollBars(boolean fadeScrollBars) When true the scrollbars don't reduce the scrollable size and fade out after some time of not being used.
public void	setFlickScroll(boolean flickScroll)
public void	setFlickScrollTapSquareSize(float halfTapSquareSize)
public void	setFlingTime(float flingTime) For flick scroll, sets the amount of time in seconds that a fling will continue to scroll.
public void	setForceScroll(boolean x, boolean y) Forces enabling scrollbars (for non-flick scroll) and overscrolling (for flick scroll) in a direction, even if the contents do not exceed the bounds in that direction.
public void	setOverscroll(boolean overscrollX, boolean overscrollY) For flick scroll, if true the actor can be scrolled slightly past its bounds and will animate back to its bounds when scrolling is stopped.
public void	setScrollBarPositions(boolean bottom, boolean right) Set the position of the vertical and horizontal scroll bars.
public void	setScrollbarsOnTop(boolean scrollbarsOnTop) When false (the default), the actor is clipped so it is not drawn under the scrollbars.
public void	setScrollbarsVisible(boolean visible) Shows or hides the scrollbars for when using `setFadeScrollBars(boolean)`.
public void	setScrollBarTouch(boolean scrollBarTouch) When false, the scroll bars don't respond to touch or mouse events.
public void	setScrollingDisabled(boolean x, boolean y) Disables scrolling in a direction.
public void	setScrollPercentX(float percentX)
public void	setScrollPercentY(float percentY)
public void	setScrollX(float pixels)
public void	setScrollY(float pixels)
public void	setSmoothScrolling(boolean smoothScrolling) When true, the visual scroll position is transitioned to the actual position over time using `smoothScroll(float, float)`.
public void	setStyle(ScrollPane.ScrollPaneStyle style) Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle. Set the current style of the actor
public void	setupFadeScrollBars(float fadeAlphaSeconds, float fadeDelaySeconds)
public void	setupOverscroll(float distance, float speedMin, float speedMax) For flick scroll, sets the overscroll distance in pixels and the speed it returns to the actor's bounds in seconds.
public void	setVariableSizeKnobs(boolean variableSizeKnobs) If true, the scroll knobs are sized based on `getMaxX()` or `getMaxY()`.
public void	setVelocityX(float velocityX)
public void	setVelocityY(float velocityY)
public void	setWidget(Actor actor) Deprecated Use `setActor(Actor)`.
protected float	smoothScroll(float The absolute difference between the visual scroll position and the actual position. difference, float Time in seconds since last frame. delta) Returns the amount to adjust the visual scroll position each frame.
private void	updateActorPosition()
public void	updateVisualScroll() Sets the visual scroll amount equal to the scroll amount.
protected void	visualScrollX(float pixelsX) Called whenever the visual x scroll amount is changed.
protected void	visualScrollY(float pixelsY) Called whenever the visual y scroll amount is changed.

Inherited from com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup:: childrenChanged getMaxHeight getMaxWidth invalidate invalidateHierarchy needsLayout pack setFillParent setLayoutEnabled sizeChanged validate

public Class ScrollPane

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary