libgdx API

com.badlogic.gdx.scenes.scene2d.ui
Class SplitPane

java.lang.Object
  extended by com.badlogic.gdx.scenes.scene2d.Actor
      extended by com.badlogic.gdx.scenes.scene2d.Group
          extended by com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup
              extended by com.badlogic.gdx.scenes.scene2d.ui.SplitPane
All Implemented Interfaces:
Cullable, Layout

public class SplitPane
extends WidgetGroup

A container that divides two widgets either horizontally or vertically and allows the user to resize them. The child widgets are always sized to fill the half of the splitpane.

The preferred size of a splitpane is that of the child widgets and the size of the SplitPane.SplitPaneStyle.handle. The widgets are sized depending on the splitpane's size and the split position.

Author:
mzechner, Nathan Sweet

Nested Class Summary
static class SplitPane.SplitPaneStyle
          The style for a splitpane, see SplitPane.
 
Field Summary
 
Fields inherited from class com.badlogic.gdx.scenes.scene2d.Group
batchTransform, children, cullingArea, debug, debugTexture, groups, immutableChildren, immutableGroups, lastTouchedChild, localTransform, namesToActors, oldBatchTransform, point, transform, worldTransform
 
Fields inherited from class com.badlogic.gdx.scenes.scene2d.Actor
actions, color, height, name, originX, originY, parent, rotation, scaleX, scaleY, stage, touchable, visible, width, x, y
 
Constructor Summary
SplitPane(Actor firstWidget, Actor secondWidget, boolean vertical, Skin skin)
           
SplitPane(Actor firstWidget, Actor secondWidget, boolean vertical, SplitPane.SplitPaneStyle style)
           
SplitPane(Actor firstWidget, Actor secondWidget, boolean vertical, SplitPane.SplitPaneStyle style, java.lang.String name)
           
SplitPane(Skin skin)
          Creates a horizontal splitpane with no children.
 
Method Summary
 void addActor(Actor actor)
          Adds an Actor to this Group.
 void addActorAt(int index, Actor actor)
          Adds an Actor at the given index in the group.
 void addActorBefore(Actor actorBefore, Actor actor)
          Adds an Actor before the given Actor.
 void draw(SpriteBatch batch, float parentAlpha)
          If this method is overridden, the super method or WidgetGroup.validate() should be called to ensure the widget group is laid out.
 float getMinHeight()
           
 float getMinWidth()
           
 float getPrefHeight()
           
 float getPrefWidth()
           
 float getSplit()
           
 SplitPane.SplitPaneStyle getStyle()
          Returns the split pane's style.
 void layout()
          Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child and calls Layout.invalidate() and then Layout.validate() on each one.
 void removeActor(Actor actor)
          Removes an Actor from this Group.
 void removeActorRecursive(Actor actor)
          Removes an Actor from this Group recursively by checking if the Actor is in this group or one of its child-groups.
 void setFirstWidget(Actor widget)
           
 void setMaxSplitAmount(float maxAmount)
           
 void setMinSplitAmount(float minAmount)
           
 void setSecondWidget(Actor widget)
           
 void setSplitAmount(float split)
           
 void setStyle(SplitPane.SplitPaneStyle style)
           
 void setVertical(boolean vertical)
           
 boolean touchDown(float x, float y, int pointer)
           
 void touchDragged(float x, float y, int pointer)
           
 void touchUp(float x, float y, int pointer)
           
 
Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup
childrenChanged, getMaxHeight, getMaxWidth, invalidate, invalidateHierarchy, needsLayout, pack, setFillParent, validate
 
Methods inherited from class com.badlogic.gdx.scenes.scene2d.Group
act, addActorAfter, applyTransform, clear, disableDebugging, drawChild, drawChildren, enableDebugging, findActor, getActors, getGroups, hit, isDescendant, resetTransform, setCullingArea, sortChildren, swapActor, swapActor, toChildCoordinates, toLocalCoordinates, touchMoved, updateTransform
 
Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor
action, clearActions, getStage, isMarkedToRemove, keyDown, keyTyped, keyUp, markToRemove, remove, scrolled, toLocalCoordinates, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SplitPane

public SplitPane(Skin skin)
Creates a horizontal splitpane with no children.


SplitPane

public SplitPane(Actor firstWidget,
                 Actor secondWidget,
                 boolean vertical,
                 Skin skin)
Parameters:
firstWidget - May be null.
secondWidget - May be null.

SplitPane

public SplitPane(Actor firstWidget,
                 Actor secondWidget,
                 boolean vertical,
                 SplitPane.SplitPaneStyle style)
Parameters:
firstWidget - May be null.
secondWidget - May be null.

SplitPane

public SplitPane(Actor firstWidget,
                 Actor secondWidget,
                 boolean vertical,
                 SplitPane.SplitPaneStyle style,
                 java.lang.String name)
Parameters:
firstWidget - May be null.
secondWidget - May be null.
Method Detail

setStyle

public void setStyle(SplitPane.SplitPaneStyle style)

getStyle

public SplitPane.SplitPaneStyle getStyle()
Returns the split pane's style. Modifying the returned style may not have an effect until setStyle(SplitPaneStyle) is called.


layout

public void layout()
Description copied from interface: Layout
Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child and calls Layout.invalidate() and then Layout.validate() on each one. Usually this should not be called directly, instead Layout.validate() should be used.

Specified by:
layout in interface Layout
Overrides:
layout in class WidgetGroup

getPrefWidth

public float getPrefWidth()

getPrefHeight

public float getPrefHeight()

getMinWidth

public float getMinWidth()
Specified by:
getMinWidth in interface Layout
Overrides:
getMinWidth in class WidgetGroup

getMinHeight

public float getMinHeight()
Specified by:
getMinHeight in interface Layout
Overrides:
getMinHeight in class WidgetGroup

setVertical

public void setVertical(boolean vertical)

draw

public void draw(SpriteBatch batch,
                 float parentAlpha)
Description copied from class: WidgetGroup
If this method is overridden, the super method or WidgetGroup.validate() should be called to ensure the widget group is laid out.

Overrides:
draw in class WidgetGroup
Parameters:
batch - the spritebatch to render with
parentAlpha - the parent's alpha value.

touchDown

public boolean touchDown(float x,
                         float y,
                         int pointer)
Overrides:
touchDown in class Group

touchUp

public void touchUp(float x,
                    float y,
                    int pointer)
Overrides:
touchUp in class Actor

touchDragged

public void touchDragged(float x,
                         float y,
                         int pointer)
Overrides:
touchDragged in class Actor

setSplitAmount

public void setSplitAmount(float split)
Parameters:
split - The split amount between the min and max amount.

getSplit

public float getSplit()

setMinSplitAmount

public void setMinSplitAmount(float minAmount)

setMaxSplitAmount

public void setMaxSplitAmount(float maxAmount)

setFirstWidget

public void setFirstWidget(Actor widget)
Parameters:
widget - May be null.

setSecondWidget

public void setSecondWidget(Actor widget)
Parameters:
widget - May be null.

addActor

public void addActor(Actor actor)
Description copied from class: Group
Adds an Actor to this Group. The order Actors are added is reversed for hit testing.

Overrides:
addActor in class Group
Parameters:
actor - the Actor

addActorAt

public void addActorAt(int index,
                       Actor actor)
Description copied from class: Group
Adds an Actor at the given index in the group. The first Actor added will be at index 0 and so on. Throws an IndexOutOfBoundsException in case the index is invalid.

Overrides:
addActorAt in class Group
Parameters:
index - the index to add the actor at.

addActorBefore

public void addActorBefore(Actor actorBefore,
                           Actor actor)
Description copied from class: Group
Adds an Actor before the given Actor.

Overrides:
addActorBefore in class Group
Parameters:
actorBefore - the Actor to add the other actor in front of
actor - the Actor to add

removeActor

public void removeActor(Actor actor)
Description copied from class: Group
Removes an Actor from this Group.

Overrides:
removeActor in class Group

removeActorRecursive

public void removeActorRecursive(Actor actor)
Description copied from class: Group
Removes an Actor from this Group recursively by checking if the Actor is in this group or one of its child-groups.

Overrides:
removeActorRecursive in class Group
Parameters:
actor - the Actor

libgdx API

Copyright 2010 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)