me.lihq.game.screen.elements

Class SpeechBox

java.lang.Object

me.lihq.game.screen.elements.SpeechBox

public class SpeechBox
extends java.lang.Object

SpeechBox class Used for rendering box containing text and buttons on screen

Usage: SpeechBox sb = new SpeechBox(..) sb.render();

Note: add to InputMultiplexer if using with other UI elements.

Field Summary

Fields

Modifier and Type	Field and Description
private static com.badlogic.gdx.graphics.Color	BACKGROUND_COLOR The constant color variables for all SpeechBox's
private static com.badlogic.gdx.graphics.Color	BORDER_COLOUR
private static int	BORDER_WIDTH
private static int	BUTTON_ROW_HEIGHT
private java.util.ArrayList<SpeechBoxButton>	buttons List of buttons to be displayed on the SpeechBox
private com.badlogic.gdx.scenes.scene2d.ui.Skin	buttonSkin
private static int	HEIGHT
private com.badlogic.gdx.scenes.scene2d.ui.Skin	labelSkin
private static int	PADDING
private java.lang.String	person The name of the person talking, if any
private com.badlogic.gdx.scenes.scene2d.ui.Skin	personLabelSkin
com.badlogic.gdx.scenes.scene2d.Stage	stage The stage to render the elemts to
private static int	TABLE_HEIGHT
private static int	TABLE_WIDTH
private static com.badlogic.gdx.graphics.Color	TEXT_COLOUR
private static int	TEXT_ROW_HEIGHT
private java.lang.String	textContent This is the text component to display.
int	timeoutDuration The timeout duration for a SpeechBox
private static int	WIDTH Layout constants
private static int	Y_OFFSET

Constructor Summary

Constructors

Constructor and Description
SpeechBox(java.lang.String content, java.util.ArrayList<SpeechBoxButton> buttonList, int timeout) The constructor for the SpeechBox
SpeechBox(java.lang.String content, int timeout) The constructor for the SpeechBox without buttons
SpeechBox(java.lang.String personName, java.lang.String speechText, java.util.ArrayList<SpeechBoxButton> buttonList, int timeout) The constructor for the SpeechBox with personName
SpeechBox(java.lang.String personName, java.lang.String speechText, int timeout) The constructor for the SpeechBox without buttons with personName

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes of SpeechBox resources
private void	fillTableContent(com.badlogic.gdx.scenes.scene2d.ui.Table table) Add relevant SpeechBox UI controls to table element
private void	initButtonSkin() Sets up the skin for buttons on the speech box
private void	initLabelSkin() Sets up the skin for buttons on the speech box
private void	initPersonLabelSkin() Sets up the skin for buttons on the speech box
private void	initSkins() Sets up skin variables used for defining UI control styles
void	render() Renders the speech box Should be called within the render() method of a screen
void	resize(int width, int height) This method is called on a window resize
private void	setupStage() Sets up the SpeechBox stage ready for rendering The stage is a Scene2D class that deals with putting UI controls on the screen
void	update() This method is called once a tick by the logic Thread

Methods inherited from class java.lang.Object

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

Field Detail

BACKGROUND_COLOR

private static final com.badlogic.gdx.graphics.Color BACKGROUND_COLOR

The constant color variables for all SpeechBox's

BORDER_COLOUR

private static final com.badlogic.gdx.graphics.Color BORDER_COLOUR

TEXT_COLOUR

private static final com.badlogic.gdx.graphics.Color TEXT_COLOUR

WIDTH

private static final int WIDTH

Layout constants

PADDING

private static final int PADDING

See Also:

Constant Field Values

BORDER_WIDTH

private static final int BORDER_WIDTH

See Also:

Constant Field Values

Y_OFFSET

private static final int Y_OFFSET

See Also:

Constant Field Values

TABLE_WIDTH

private static final int TABLE_WIDTH

TEXT_ROW_HEIGHT

private static final int TEXT_ROW_HEIGHT

See Also:

Constant Field Values

BUTTON_ROW_HEIGHT

private static final int BUTTON_ROW_HEIGHT

See Also:

Constant Field Values

TABLE_HEIGHT

private static final int TABLE_HEIGHT

See Also:

Constant Field Values

HEIGHT

private static final int HEIGHT

See Also:

Constant Field Values

stage

public com.badlogic.gdx.scenes.scene2d.Stage stage

The stage to render the elemts to

timeoutDuration

public int timeoutDuration

The timeout duration for a SpeechBox

person

private java.lang.String person

The name of the person talking, if any

textContent

private java.lang.String textContent

This is the text component to display.

buttons

private java.util.ArrayList<SpeechBoxButton> buttons

List of buttons to be displayed on the SpeechBox

buttonSkin

private com.badlogic.gdx.scenes.scene2d.ui.Skin buttonSkin

labelSkin

private com.badlogic.gdx.scenes.scene2d.ui.Skin labelSkin

personLabelSkin

private com.badlogic.gdx.scenes.scene2d.ui.Skin personLabelSkin

Constructor Detail

SpeechBox

public SpeechBox(java.lang.String content,
                 java.util.ArrayList<SpeechBoxButton> buttonList,
                 int timeout)

The constructor for the SpeechBox

SpeechBox

public SpeechBox(java.lang.String personName,
                 java.lang.String speechText,
                 java.util.ArrayList<SpeechBoxButton> buttonList,
                 int timeout)

The constructor for the SpeechBox with personName

SpeechBox

public SpeechBox(java.lang.String content,
                 int timeout)

The constructor for the SpeechBox without buttons

SpeechBox

public SpeechBox(java.lang.String personName,
                 java.lang.String speechText,
                 int timeout)

The constructor for the SpeechBox without buttons with personName

Method Detail

setupStage

private void setupStage()

Sets up the SpeechBox stage ready for rendering The stage is a Scene2D class that deals with putting UI controls on the screen

fillTableContent

private void fillTableContent(com.badlogic.gdx.scenes.scene2d.ui.Table table)

Add relevant SpeechBox UI controls to table element

Parameters:

table - Table to add controls to

render

public void render()

Renders the speech box Should be called within the render() method of a screen

update

public void update()

This method is called once a tick by the logic Thread

initSkins

private void initSkins()

Sets up skin variables used for defining UI control styles

initButtonSkin

private void initButtonSkin()

Sets up the skin for buttons on the speech box

initLabelSkin

private void initLabelSkin()

Sets up the skin for buttons on the speech box

initPersonLabelSkin

private void initPersonLabelSkin()

Sets up the skin for buttons on the speech box

dispose

public void dispose()

Disposes of SpeechBox resources

resize

public void resize(int width,
                   int height)

This method is called on a window resize

Parameters:

width - - the new width

height - - the new height