Class GUIPanel

java.lang.Object

com.blackrook.gui.GUIObject

com.blackrook.gui.object.GUIPanel

Direct Known Subclasses:

GUIGlassPanel

public class GUIPanel
extends GUIObject

A standard rectangular panel. A theme key can be set on these panels.

Author:

Matthew Tropiano

Nested Class Summary

Nested classes/interfaces inherited from class GUIObject

GUIObject.ScaleType

Field Summary

Fields inherited from class GUIObject

absoluteBounds, EVENT_BLUR, EVENT_CHANGE_ENABLE_STATE, EVENT_CHANGE_VISIBLE_STATE, EVENT_FOCUS, EVENT_GAMEPAD_AXIS, EVENT_GAMEPAD_PRESS, EVENT_GAMEPAD_RELEASE, EVENT_GAMEPAD_TAP_PRESS, EVENT_GAMEPAD_TAP_RELEASE, EVENT_GENERIC_INPUT, EVENT_KEY_PRESS, EVENT_KEY_RELEASE, EVENT_KEY_TYPE, EVENT_MOUSE_CLICK, EVENT_MOUSE_DRAG, EVENT_MOUSE_LEAVE, EVENT_MOUSE_MOVE, EVENT_MOUSE_OVER, EVENT_MOUSE_PRESS, EVENT_MOUSE_RELEASE, EVENT_MOUSE_WHEEL, EVENT_NAMED, EVENT_UNKNOWN

Constructor Summary

Constructors

Constructor	Description
GUIPanel()	Creates a new GUI panel.
GUIPanel(float width, float height)	Creates a new GUI object.
GUIPanel(float x, float y, float width, float height)	Creates a new GUI object.

Method Summary

Modifier and Type	Method	Description
String	getThemeKey()	Returns this object's theme key.
GUIPanel	setThemeKey(String themeKey)	Sets this object's theme key.

Methods inherited from class GUIObject

addChild, addChild, addName, addToRenderSet, animate, animate, animate, animateAbort, animateDelay, animateFinish, bindAction, callAction, correctPosition, fireEvent, getAbsoluteBounds, getAsQuery, getBounds, getChildrenAsQuery, getColor, getColorNotInherited, getDescendantsAsQuery, getFinalOpacity, getGeneration, getGUI, getLayout, getLayoutAttrib, getNativeBounds, getOpacity, getParent, getParentAsQuery, getRenderAlpha, getRenderBlue, getRendered, getRenderGreen, getRenderHeight, getRenderPositionX, getRenderPositionY, getRenderRadius, getRenderRed, getRenderRotationZ, getRenderTextureScaleS, getRenderTextureScaleT, getRenderWidth, getScaleType, getSiblingsAsQuery, getTexture, getTheme, getVisible, hasAction, hasName, hasNamePattern, isAnimating, isConstrainedToParent, isEnabled, isFocused, isInert, isVisible, moveDown, moveToBack, moveToFront, moveUp, onGUIChange, releaseFocus, remove, removeChild, removeName, requestFocus, resizeChildren, rotate, setBounds, setBounds, setBoundsByChildren, setColor, setColor, setColorNotInherited, setConstrainToParent, setDimensions, setEnabled, setInert, setLayout, setLayoutAttrib, setOpacity, setPosition, setRendered, setRotationZ, setScaleType, setTexture, setTheme, setVisible, stretch, toString, translate, unbindAction, unbindAllActions, updateDirty, updateScenePosition, useRenderRadius

Methods inherited from class Object

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

Constructor Details

GUIPanel

public GUIPanel()

Creates a new GUI panel.

GUIPanel

public GUIPanel(float width,
 float height)

Creates a new GUI object.

Parameters:

width - its width.

height - its height.

GUIPanel

public GUIPanel(float x,
 float y,
 float width,
 float height)

Creates a new GUI object.

Parameters:

x - its position x.

y - its position y.

width - its width.

height - its height.

Method Details

setThemeKey

public GUIPanel setThemeKey(String themeKey)

Sets this object's theme key. This is the key that is used to look up the texture used to render this object if a theme is applied to this object or the GUI that owns it.

Parameters:

themeKey - the new theme key.

Returns:

this panel.

getThemeKey

public String getThemeKey()

Description copied from class: GUIObject

Returns this object's theme key. This is the key that is used to look up the texture used to render this object. This may return null, indicating that this object does not have a default texture.

Specified by:

getThemeKey in class GUIObject

Returns:

the theme key.