Examples of com.badlogic.gdx.scenes.scene2d.ui.ScrollPane

A special container that allows scrolling over its children.

Functionality

A ScrollPane can embed any {@link Actor} (and {@link Widget} or {@link Table} for that matter) andprovide scrolling functionality in case the embedded Actor is bigger than the scroll pane itself. The scroll pane will automatically decide whether it needs a vertical and/or horizontal scroll handle based on the contained Actor's size with respect to the scroll pane's own size.

Note: do not use any of the {@link #addActor(Actor)} or {@link #removeActor(Actor)} methods with this class! The embeddedwidget is specified at construction time or via {@link #setWidget(Actor)}. *

Layout

The (preferred) width and height of a scroll pane is determined by the size passed to its constructor. The contained Actor will be positioned in such a way that it's top left corner will coincide with the scroll pane's corner when the vertical and horizontal scroll handles are at their minimum position.

Style

A ScrollPane is a {@link Group} (note the comment in the functionality section!) that conditionally displayshorizontal and vertical scroll bars and handles as well as the embedded Actor, clipped to the available area inside of the scroll pane. The scroll bars are {@link NinePatch} instances, the scroll handles are {@link NinePatch} instances as well. Inaddition a background {@link NinePatch} is displayed behind the embedded Actor. The style is defined via a{@link ScrollPaneStyle} instance, which can be either done programmatically or via a {@link Skin}.

The height of the horizontal scroll bar and handle is constant and takes on the maximum {@link NinePatch#getTotalHeight()}value of the involed NinePatch instances. The width is determined automatically based on the size of the scroll pane.

The width of the vertical scroll bar and handle is constant and takes on the maximum {@link NinePatch#getTotalWidth()} value ofthe involed NinePatch instances. The height is determined automatically based on the size of the scroll pane.

A ScrollPane's style definition in a skin XML file should look like this:

 {@code }

The name attribute defines the name of the style which you can later use with {@link Skin#newScrollPane(String,Stage,Actor,int,int,String)}.
The background attribute references a {@link NinePatch} by name, to be used as the scroll pane's background
The hScroll attribute references a {@link NinePatch} by name, to be used as the scroll pane's horizontalscroll bar.
The hScrollKnow attribute references a {@link NinePatch} by name, to be used as the scroll pane's horizontalscroll handle.
The vScroll attribute references a {@link NinePatch} by name, to be used as the scroll pane's vertical scrollbar.
The vScrollKnow attribute references a {@link NinePatch} by name, to be used as the scroll pane's verticalscroll handle..

@author mzechner