de.ellpeck.rockbottom.api.gui

Class Gui

java.lang.Object

de.ellpeck.rockbottom.api.gui.Gui

Direct Known Subclasses:

GuiContainer

public abstract class Gui
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<GuiComponent>	components
static int	GRADIENT_COLOR
protected boolean	hasUnspecifiedBounds
protected int	height
static int	HOVER_INFO_BACKGROUND
protected Gui	parent
protected int	width
protected int	x
protected int	y

Constructor Summary

Constructors

Constructor and Description
Gui()
Gui(Gui parent)
Gui(int width, int height)
Gui(int width, int height, Gui parent)

Method Summary

Modifier and Type	Method and Description
boolean	canCloseWithInvKey()
boolean	doesPauseGame()
java.util.List<GuiComponent>	getComponents()
int	getHeight()
abstract IResourceName	getName()
int	getWidth()
int	getX()
int	getY()
boolean	hasGradient()
void	init(IGameInstance game)
boolean	isMouseOver(IGameInstance game)
boolean	isMouseOverComponent(IGameInstance game)
boolean	isMouseOverPrioritized(IGameInstance game, GuiComponent component)
void	onClosed(IGameInstance game)
boolean	onKeyboardAction(IGameInstance game, int button, char character)
boolean	onMouseAction(IGameInstance game, int button, float x, float y)
void	onOpened(IGameInstance game)
void	render(IGameInstance game, IAssetManager manager, IGraphics g)
void	renderOverlay(IGameInstance game, IAssetManager manager, IGraphics g)
void	sortComponents()
java.lang.String	toString()
protected boolean	tryEscape(IGameInstance game)
void	update(IGameInstance game)
protected void	updateDimensions(IGameInstance game)

Methods inherited from class java.lang.Object

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

Field Detail

GRADIENT_COLOR

public static final int GRADIENT_COLOR

HOVER_INFO_BACKGROUND

public static final int HOVER_INFO_BACKGROUND

parent

protected final Gui parent

hasUnspecifiedBounds

protected final boolean hasUnspecifiedBounds

width

protected int width

height

protected int height

x

protected int x

y

protected int y

components

protected java.util.List<GuiComponent> components

Constructor Detail

Gui

public Gui()

Gui

public Gui(Gui parent)

Gui

public Gui(int width,
           int height,
           Gui parent)

Gui

public Gui(int width,
           int height)

Method Detail

onOpened

public void onOpened(IGameInstance game)

onClosed

public void onClosed(IGameInstance game)

init

public void init(IGameInstance game)

updateDimensions

protected void updateDimensions(IGameInstance game)

update

public void update(IGameInstance game)

onMouseAction

public boolean onMouseAction(IGameInstance game,
                             int button,
                             float x,
                             float y)

onKeyboardAction

public boolean onKeyboardAction(IGameInstance game,
                                int button,
                                char character)

canCloseWithInvKey

public boolean canCloseWithInvKey()

tryEscape

protected boolean tryEscape(IGameInstance game)

render

public void render(IGameInstance game,
                   IAssetManager manager,
                   IGraphics g)

renderOverlay

public void renderOverlay(IGameInstance game,
                          IAssetManager manager,
                          IGraphics g)

doesPauseGame

public boolean doesPauseGame()

isMouseOver

public boolean isMouseOver(IGameInstance game)

isMouseOverComponent

public boolean isMouseOverComponent(IGameInstance game)

hasGradient

public boolean hasGradient()

sortComponents

public void sortComponents()

isMouseOverPrioritized

public boolean isMouseOverPrioritized(IGameInstance game,
                                      GuiComponent component)

getComponents

public java.util.List<GuiComponent> getComponents()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

public abstract IResourceName getName()

getX

public int getX()

getY

public int getY()

getWidth

public int getWidth()

getHeight

public int getHeight()