com.kotcrab.vis.ui.widget

Class VisWindow

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

com.kotcrab.vis.ui.widget.VisWindow

All Implemented Interfaces:

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

Direct Known Subclasses:

ColorPicker, Dialogs.InputDialog, Dialogs.OptionDialog, FileChooser, VisDialog

public class VisWindow
extends com.badlogic.gdx.scenes.scene2d.ui.Window

Extends functionality of standard scene2d.ui Window.

See Also:

Window

Nested Class Summary

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

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

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

com.badlogic.gdx.scenes.scene2d.ui.Table.Debug, com.badlogic.gdx.scenes.scene2d.ui.Table.DebugRect

Field Summary

Fields

Modifier and Type	Field and Description
static float	FADE_TIME

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

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

Constructor Summary

Constructors

Constructor and Description
VisWindow(java.lang.String title)
VisWindow(java.lang.String title, boolean showWindowBorder)
VisWindow(java.lang.String title, java.lang.String styleName)
VisWindow(java.lang.String title, com.badlogic.gdx.scenes.scene2d.ui.Window.WindowStyle style)

Method Summary

Modifier and Type	Method and Description
void	addCloseButton() Adds close button to window, next to window title.
boolean	centerWindow() Centers this window, if it has parent it will be done instantly, if it does not have parent it will be centered when it will be added to stage
protected void	close() Called by window when close button was pressed (added using addCloseButton()) or escape key was pressed (for close on escape closeOnEscape() have to be called).
void	closeOnEscape() Will make this window close when escape key or back key was pressed.
void	draw(com.badlogic.gdx.graphics.g2d.Batch batch, float parentAlpha)
VisWindow	fadeIn()
VisWindow	fadeIn(float time)
void	fadeOut() Fade outs this window, when fade out animation is completed, window is removed from Stage
void	fadeOut(float time) Fade outs this window, when fade out animation is completed, window is removed from Stage.
boolean	isKeepWithinParent()
void	setCenterOnAdd(boolean centerOnAdd)
void	setKeepWithinParent(boolean keepWithinParent)
void	setPosition(float x, float y)
protected void	setStage(com.badlogic.gdx.scenes.scene2d.Stage stage)

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

drawBackground, drawStageBackground, getPrefWidth, getStyle, getTitleLabel, getTitleTable, hit, isDragging, isModal, isMovable, isResizable, setKeepWithinStage, setModal, setMovable, setResizable, setResizeBorder, setStyle

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, getColumns, getColumnWidth, getMinHeight, getMinWidth, getPadBottom, getPadBottomValue, getPadLeft, getPadLeftValue, getPadRight, getPadRightValue, getPadTop, getPadTopValue, getPadX, getPadY, getPrefHeight, getRow, getRowHeight, 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, setTransform, swapActor, swapActor, toString

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

addAction, addCaptureListener, addListener, clearActions, clearListeners, clipBegin, clipBegin, clipEnd, 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, rotationChanged, scaleBy, scaleBy, screenToLocalCoordinates, setBounds, setColor, setColor, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setParent, 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

FADE_TIME

public static float FADE_TIME

Constructor Detail

VisWindow

public VisWindow(java.lang.String title)

VisWindow

public VisWindow(java.lang.String title,
                 boolean showWindowBorder)

VisWindow

public VisWindow(java.lang.String title,
                 java.lang.String styleName)

VisWindow

public VisWindow(java.lang.String title,
                 com.badlogic.gdx.scenes.scene2d.ui.Window.WindowStyle style)

Method Detail

setPosition

public void setPosition(float x,
                        float y)

Overrides:

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

centerWindow

public boolean centerWindow()

Centers this window, if it has parent it will be done instantly, if it does not have parent it will be centered when it will be added to stage

Returns:

true when window was centered, false when window will be centered when added to stage

setCenterOnAdd

public void setCenterOnAdd(boolean centerOnAdd)

Parameters:

centerOnAdd - if true window position will be centered on screen after adding to stage

See Also:

centerWindow()

setStage

protected void setStage(com.badlogic.gdx.scenes.scene2d.Stage stage)

Overrides:

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

fadeOut

public void fadeOut(float time)

Fade outs this window, when fade out animation is completed, window is removed from Stage. Calling this for the second time won't have any effect if previous animation is still running.

fadeIn

public VisWindow fadeIn(float time)

Returns:

this window for the purpose of chaining methods eg. stage.addActor(new MyWindow(stage).fadeIn(0.3f));

fadeOut

public void fadeOut()

Fade outs this window, when fade out animation is completed, window is removed from Stage

fadeIn

public VisWindow fadeIn()

Returns:

this window for the purpose of chaining methods eg. stage.addActor(new MyWindow(stage).fadeIn());

close

protected void close()

Called by window when close button was pressed (added using addCloseButton()) or escape key was pressed (for close on escape closeOnEscape() have to be called). Default close behaviour is to fade out window, this can be changed by overriding this function.

addCloseButton

public void addCloseButton()

Adds close button to window, next to window title. After pressing that button, close() is called. If nothing else was added to title table, and current title alignment is center then the title will be automatically centered.

closeOnEscape

public void closeOnEscape()

Will make this window close when escape key or back key was pressed. After pressing escape or back, close() is called. Back key is Android and iOS only

isKeepWithinParent

public boolean isKeepWithinParent()

setKeepWithinParent

public void setKeepWithinParent(boolean keepWithinParent)

draw

public void draw(com.badlogic.gdx.graphics.g2d.Batch batch,
                 float parentAlpha)

Overrides:

draw in class com.badlogic.gdx.scenes.scene2d.ui.Window