com.badlogic.gdx.scenes.scene2d.ui

Class Window

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.Table

com.badlogic.gdx.scenes.scene2d.ui.Window

All Implemented Interfaces:

Cullable, Layout

Direct Known Subclasses:

Dialog

public class Window
extends Table

A table that can be dragged and act as a modal window. The top padding is used as the window's title height.

The preferred size of a window is the preferred size of the title text and the children as laid out by the table. After adding children to the window, it can be convenient to call WidgetGroup.pack() to size the window to the size of the children.

Author:

Nathan Sweet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Window.WindowStyle The style for a window, see Window.

Nested classes/interfaces inherited from class com.badlogic.gdx.scenes.scene2d.ui.Table

Table.Debug, Table.DebugRect

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	dragging
protected int	edge

Fields inherited from class com.badlogic.gdx.scenes.scene2d.ui.Table

backgroundBottom, backgroundLeft, backgroundRight, backgroundTop, debugActorColor, debugCellColor, debugTableColor

Constructor Summary

Constructors

Constructor and Description
Window(java.lang.String title, Skin skin)
Window(java.lang.String title, Skin skin, java.lang.String styleName)
Window(java.lang.String title, Window.WindowStyle style)

Method Summary

Modifier and Type	Method and Description
void	draw(Batch 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.
protected void	drawBackground(Batch batch, float parentAlpha, float x, float y) Called to draw the background, before clipping is applied (if enabled).
protected void	drawStageBackground(Batch batch, float parentAlpha, float x, float y, float width, float height)
float	getPrefWidth()
Window.WindowStyle	getStyle() Returns the window's style.
Label	getTitleLabel()
Table	getTitleTable()
Actor	hit(float x, float y, boolean touchable) Returns the deepest actor that contains the specified point and is touchable and visible, or null if no actor was hit.
boolean	isDragging()
boolean	isModal()
boolean	isMovable()
boolean	isResizable()
void	setKeepWithinStage(boolean keepWithinStage)
void	setModal(boolean isModal)
void	setMovable(boolean isMovable)
void	setResizable(boolean isResizable)
void	setResizeBorder(int resizeBorder)
void	setStyle(Window.WindowStyle style)

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

add, add, add, add, add, add, add, align, background, background, bottom, center, clearChildren, columnDefaults, debug, debug, debugActor, debugAll, debugCell, debugTable, defaults, drawDebug, drawDebugBounds, getAlign, getBackground, getCell, getCells, getClip, getColumnMinWidth, getColumnPrefWidth, getColumns, getColumnWidth, getMinHeight, getMinWidth, getPadBottom, getPadBottomValue, getPadLeft, getPadLeftValue, getPadRight, getPadRightValue, getPadTop, getPadTopValue, getPadX, getPadY, getPrefHeight, getRow, getRowHeight, getRowMinHeight, getRowPrefHeight, getRows, getSkin, getTableDebug, invalidate, layout, left, pad, pad, pad, pad, padBottom, padBottom, padLeft, padLeft, padRight, padRight, padTop, padTop, removeActor, removeActor, reset, right, row, setBackground, setBackground, setClip, setDebug, setRound, setSkin, stack, top

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

childrenChanged, getMaxHeight, getMaxWidth, invalidateHierarchy, needsLayout, pack, setFillParent, setLayoutEnabled, sizeChanged, validate

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

act, addActor, addActorAfter, addActorAt, addActorBefore, applyTransform, applyTransform, clear, computeTransform, drawChildren, drawDebugChildren, findActor, getChildren, 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, fire, firstAscendant, 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, rotationChanged, scaleBy, scaleBy, screenToLocalCoordinates, setBounds, setColor, setColor, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setParent, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setSize, setTouchable, setUserObject, setVisible, setWidth, 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

Field Detail

edge

protected int edge

dragging

protected boolean dragging

Constructor Detail

Window

public Window(java.lang.String title,
              Skin skin)

Window

public Window(java.lang.String title,
              Skin skin,
              java.lang.String styleName)

Window

public Window(java.lang.String title,
              Window.WindowStyle style)

Method Detail

setStyle

public void setStyle(Window.WindowStyle style)

getStyle

public Window.WindowStyle getStyle()

Returns the window's style. Modifying the returned style may not have an effect until setStyle(WindowStyle) is called.

draw

public void draw(Batch 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 Table

parentAlpha - Should be multiplied with the actor's alpha, allowing a parent's alpha to affect all children.

drawStageBackground

protected void drawStageBackground(Batch batch,
                                   float parentAlpha,
                                   float x,
                                   float y,
                                   float width,
                                   float height)

drawBackground

protected void drawBackground(Batch batch,
                              float parentAlpha,
                              float x,
                              float y)

Description copied from class: Table

Called to draw the background, before clipping is applied (if enabled). Default implementation draws the background drawable.

Overrides:

drawBackground in class Table

hit

public Actor hit(float x,
                 float y,
                 boolean touchable)

Description copied from class: Actor

Returns the deepest actor that contains the specified point and is touchable and visible, or null if no actor was hit. The point is specified in the actor's local coordinate system (0,0 is the bottom left of the actor and width,height is the upper right).

This method is used to delegate touchDown, mouse, and enter/exit events. If this method returns null, those events will not occur on this Actor.

The default implementation returns this actor if the point is within this actor's bounds.

Overrides:

hit in class Table

touchable - If true, the hit detection will respect the touchability.

See Also:

Touchable

isMovable

public boolean isMovable()

setMovable

public void setMovable(boolean isMovable)

isModal

public boolean isModal()

setModal

public void setModal(boolean isModal)

setKeepWithinStage

public void setKeepWithinStage(boolean keepWithinStage)

isResizable

public boolean isResizable()

setResizable

public void setResizable(boolean isResizable)

setResizeBorder

public void setResizeBorder(int resizeBorder)

isDragging

public boolean isDragging()

getPrefWidth

public float getPrefWidth()

Specified by:

getPrefWidth in interface Layout

Overrides:

getPrefWidth in class Table

getTitleTable

public Table getTitleTable()

getTitleLabel

public Label getTitleLabel()