com.kotcrab.vis.ui.layout

Class DragPane

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

com.badlogic.gdx.scenes.scene2d.Group

com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup

com.badlogic.gdx.scenes.scene2d.ui.Container<com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup>

com.kotcrab.vis.ui.layout.DragPane

All Implemented Interfaces:

com.badlogic.gdx.scenes.scene2d.utils.Cullable, com.badlogic.gdx.scenes.scene2d.utils.Layout

public class DragPane
extends com.badlogic.gdx.scenes.scene2d.ui.Container<com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup>

Stores actors in an internally managed WidgetGroup. Allows actors with specialized Draggable listener attached to be dropped and added into its group's content.

Note that unless Draggable with appropriate listener (preferably DragPane.DefaultDragListener) is attached to dragged actors, this widget will act like a regular group with no extra functionalities. It's usually a good idea to use setDraggable(Draggable) method, as it will attach the listener to all its children, making them all draggable. If you want to filter widgets accepted by this pane, use setListener(DragPaneListener) method.

Since:

0.9.3

Author:

MJ

See Also:

setDraggable(Draggable), setListener(DragPaneListener)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DragPane.DefaultDragListener Default Draggable.DragListener implementation.
static interface	DragPane.DragPaneListener Allows to select children added to the group.

Constructor Summary

Constructors

Constructor and Description
DragPane() Creates a new horizontal drag pane.
DragPane(boolean vertical)
DragPane(com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup group)

Method Summary

Modifier and Type	Method and Description
protected boolean	accept(com.badlogic.gdx.scenes.scene2d.Actor actor)
void	addActor(com.badlogic.gdx.scenes.scene2d.Actor actor)
void	addActorAfter(com.badlogic.gdx.scenes.scene2d.Actor actorAfter, com.badlogic.gdx.scenes.scene2d.Actor actor)
void	addActorAt(int index, com.badlogic.gdx.scenes.scene2d.Actor actor)
void	addActorBefore(com.badlogic.gdx.scenes.scene2d.Actor actorBefore, com.badlogic.gdx.scenes.scene2d.Actor actor)
void	clear()
boolean	contains(com.badlogic.gdx.scenes.scene2d.Actor actor)
protected void	doOnAdd(com.badlogic.gdx.scenes.scene2d.Actor actor)
<T extends com.badlogic.gdx.scenes.scene2d.Actor> T	findActor(String name)
com.badlogic.gdx.utils.SnapshotArray<com.badlogic.gdx.scenes.scene2d.Actor>	getChildren()
Draggable	getDraggable()
GridGroup	getGridGroup()
com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup	getGroup()
com.badlogic.gdx.scenes.scene2d.ui.HorizontalGroup	getHorizontalGroup()
com.badlogic.gdx.scenes.scene2d.ui.VerticalGroup	getVerticalGroup()
void	invalidate()
boolean	isGrid()
boolean	isHorizontal()
boolean	isVertical()
boolean	removeActor(com.badlogic.gdx.scenes.scene2d.Actor actor) Removes an actor from this group.
boolean	removeActor(com.badlogic.gdx.scenes.scene2d.Actor actor, boolean unfocus) Removes an actor from this group.
void	setActor(com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup group)
void	setBounds(float x, float y, float width, float height)
void	setDraggable(Draggable draggable)
void	setGroup(com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup group)
void	setHeight(float height)
void	setListener(DragPane.DragPaneListener listener)
void	setWidth(float width)
void	validate()

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.Container

align, background, bottom, center, draw, drawBackground, drawDebug, fill, fill, fill, fill, fillX, fillY, getActor, getAlign, getBackground, getClip, getFillX, getFillY, getMaxHeight, getMaxHeightValue, getMaxWidth, getMaxWidthValue, getMinHeight, getMinHeightValue, getMinWidth, getPadBottom, getPadBottomValue, getPadLeft, getPadLeftValue, getPadRight, getPadRightValue, getPadTop, getPadTopValue, getPadX, getPadY, getPrefHeight, getPrefHeightValue, getPrefWidth, getPrefWidthValue, height, height, hit, layout, left, maxHeight, maxHeight, maxSize, maxSize, maxSize, maxSize, maxWidth, maxWidth, minHeight, minHeight, minSize, minSize, minSize, minSize, minWidth, minWidth, pad, pad, pad, pad, padBottom, padBottom, padLeft, padLeft, padRight, padRight, padTop, padTop, prefHeight, prefHeight, prefSize, prefSize, prefSize, prefSize, prefWidth, prefWidth, right, setBackground, setBackground, setClip, setRound, size, size, size, size, top, width, width

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup

childrenChanged, invalidateHierarchy, needsLayout, pack, setFillParent, setLayoutEnabled, sizeChanged

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Group

act, applyTransform, applyTransform, clearChildren, computeTransform, debugAll, drawChildren, drawDebugChildren, getCullingArea, hasChildren, isTransform, localToDescendantCoordinates, resetTransform, resetTransform, setCullingArea, setDebug, setStage, setTransform, swapActor, swapActor, toString

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor

addAction, addCaptureListener, addListener, clearActions, clearListeners, clipBegin, clipBegin, clipEnd, debug, drawDebugBounds, fire, getActions, getCaptureListeners, getColor, getDebug, getHeight, getListeners, getName, getOriginX, getOriginY, getParent, getRight, getRotation, getScaleX, getScaleY, getStage, getTop, getTouchable, getUserObject, getWidth, getX, getX, getY, getY, getZIndex, hasActions, hasParent, isAscendantOf, isDescendantOf, isTouchable, isVisible, localToAscendantCoordinates, localToParentCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, positionChanged, remove, removeAction, removeCaptureListener, removeListener, rotateBy, scaleBy, scaleBy, screenToLocalCoordinates, setColor, setColor, setDebug, setName, setOrigin, setOrigin, setOriginX, setOriginY, setParent, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setSize, setTouchable, setUserObject, setVisible, setX, setY, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, toBack, toFront

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DragPane

public DragPane()

Creates a new horizontal drag pane.

DragPane

public DragPane(boolean vertical)

Parameters:

vertical - if true, actors will be stored vertically, if false - horizontally.

DragPane

public DragPane(com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup group)

Parameters:

group - must append its actors through standard Group.addActor(Actor) method. Must support Group.addActorAfter(Actor, Actor) and Group.addActorBefore(Actor, Actor) methods. Note that Table does not meet these requirements.

See Also:

VerticalGroup, HorizontalGroup, GridGroup

Method Detail

isVertical

public boolean isVertical()

Returns:

true if children are displayed vertically in a VerticalGroup.

See Also:

getVerticalGroup()

isHorizontal

public boolean isHorizontal()

Returns:

true if children are displayed horizontally in a HorizontalGroup.

See Also:

getHorizontalGroup()

isGrid

public boolean isGrid()

Returns:

true if children are displayed as a grid in a GridGroup.

See Also:

getGridGroup()

getChildren

public com.badlogic.gdx.utils.SnapshotArray<com.badlogic.gdx.scenes.scene2d.Actor> getChildren()

Overrides:

getChildren in class com.badlogic.gdx.scenes.scene2d.Group

getGroup

public com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup getGroup()

Returns:

internally managed group of actors.

setGroup

public void setGroup(com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup group)

Parameters:

group - will replace the internally managed group. All current children will be moved to this group.

setActor

public void setActor(com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup group)

Overrides:

setActor in class com.badlogic.gdx.scenes.scene2d.ui.Container<com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup>

Parameters:

group - will replace the internally managed group. All current children will be moved to this group.

getHorizontalGroup

public com.badlogic.gdx.scenes.scene2d.ui.HorizontalGroup getHorizontalGroup()

Returns:

internally managed group of actors.

Throws:

ClassCastException - if drag pane is not horizontal.

See Also:

isHorizontal()

getVerticalGroup

public com.badlogic.gdx.scenes.scene2d.ui.VerticalGroup getVerticalGroup()

Returns:

internally managed group of actors.

Throws:

ClassCastException - if drag pane is not vertical.

See Also:

isVertical()

getGridGroup

public GridGroup getGridGroup()

Returns:

internally managed group of actors.

Throws:

ClassCastException - if drag pane is not a grid.

See Also:

isGrid()

getDraggable

public Draggable getDraggable()

Returns:

dragging listener automatically added to all panes' children.

setDraggable

public void setDraggable(Draggable draggable)

Parameters:

draggable - will be automatically added to all children.

setBounds

public void setBounds(float x,
                      float y,
                      float width,
                      float height)

Overrides:

setBounds in class com.badlogic.gdx.scenes.scene2d.Actor

setWidth

public void setWidth(float width)

Overrides:

setWidth in class com.badlogic.gdx.scenes.scene2d.Actor

setHeight

public void setHeight(float height)

Overrides:

setHeight in class com.badlogic.gdx.scenes.scene2d.Actor

contains

public boolean contains(com.badlogic.gdx.scenes.scene2d.Actor actor)

Parameters:

actor - might be in the drag pane.

Returns:

true if actor is added to the pane's internal group.

removeActor

public boolean removeActor(com.badlogic.gdx.scenes.scene2d.Actor actor)

Removes an actor from this group. If the actor will not be used again and has actions, they should be cleared so the actions will be returned to their pool, if any. This is not done automatically.

Note that the direct parent of DragPane's children is the internal pane's group accessible through getGroup() - and since this removal method is overridden and extended, pane's children should be deleted with dragPane.removeActor(child) rather than Actor.remove() method.

Overrides:

removeActor in class com.badlogic.gdx.scenes.scene2d.ui.Container<com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup>

Parameters:

actor - will be removed, if present in the internal WidgetGroup.

Returns:

true if the actor was removed from this group.

removeActor

public boolean removeActor(com.badlogic.gdx.scenes.scene2d.Actor actor,
                           boolean unfocus)

Removes an actor from this group. If the actor will not be used again and has actions, they should be cleared so the actions will be returned to their pool, if any. This is not done automatically.

Note that the direct parent of DragPane's children is the internal pane's group accessible through getGroup() - and since this removal method is overridden and extended, pane's children should be deleted with dragPane.removeActor(child, true) rather than Actor.remove() method.

Overrides:

removeActor in class com.badlogic.gdx.scenes.scene2d.Group

Parameters:

unfocus - if true, Stage.unfocus(Actor) is called.

actor - will be removed, if present in the internal WidgetGroup.

Returns:

true if the actor was removed from this group.

clear

public void clear()

Overrides:

clear in class com.badlogic.gdx.scenes.scene2d.Group

addActor

public void addActor(com.badlogic.gdx.scenes.scene2d.Actor actor)

Overrides:

addActor in class com.badlogic.gdx.scenes.scene2d.ui.Container<com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup>

addActorAfter

public void addActorAfter(com.badlogic.gdx.scenes.scene2d.Actor actorAfter,
                          com.badlogic.gdx.scenes.scene2d.Actor actor)

Overrides:

addActorAfter in class com.badlogic.gdx.scenes.scene2d.ui.Container<com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup>

addActorAt

public void addActorAt(int index,
                       com.badlogic.gdx.scenes.scene2d.Actor actor)

Overrides:

addActorAt in class com.badlogic.gdx.scenes.scene2d.ui.Container<com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup>

addActorBefore

public void addActorBefore(com.badlogic.gdx.scenes.scene2d.Actor actorBefore,
                           com.badlogic.gdx.scenes.scene2d.Actor actor)

Overrides:

addActorBefore in class com.badlogic.gdx.scenes.scene2d.ui.Container<com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup>

doOnAdd

protected void doOnAdd(com.badlogic.gdx.scenes.scene2d.Actor actor)

Parameters:

actor - was just added to the group.

findActor

public <T extends com.badlogic.gdx.scenes.scene2d.Actor> T findActor(String name)

Overrides:

findActor in class com.badlogic.gdx.scenes.scene2d.Group

invalidate

public void invalidate()

Specified by:

invalidate in interface com.badlogic.gdx.scenes.scene2d.utils.Layout

Overrides:

invalidate in class com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup

validate

public void validate()

Specified by:

validate in interface com.badlogic.gdx.scenes.scene2d.utils.Layout

Overrides:

validate in class com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup

setListener

public void setListener(DragPane.DragPaneListener listener)

Parameters:

listener - manages children appended to the drag pane.

accept

protected boolean accept(com.badlogic.gdx.scenes.scene2d.Actor actor)

Parameters:

actor - is dragged over the pane.

Returns:

true if actor can be added to the pane.