turtle

Class GGStatusBar

java.lang.Object

turtle.GGStatusBar

public class GGStatusBar
extends java.lang.Object

Class to provide space for one line of text shown in a game grid window normally used for displaying status information. The status bar is attached at the bottom of the game grid window, but a freely floating bar is also available. A GGStatusBar reference is returned by calling addStatusBar() in the GameGrid constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	getBackgroundColor() Returns the background color attribute (default: Color.rgb(90, 90, 90)).
int	getBorderColor() Returns the border color attribute (default: Color.WHITE).
int	getTextColor() Returns the text color attribute (default: Color.WHITE).
int	getTextHeight() Returns the text height attribute.
int	getTextWidth() Returns the width of last text given by setText().
GGStatusBar	setBackgroundColor(int color) Sets the background color attribute.
GGStatusBar	setBorderColor(int color) Sets the border color attribute.
GGStatusBar	setRefreshEnabled(boolean enable) Enables/disables the the automatic refresh by calling GameGrid.refresh() is called at the end of setText().
GGStatusBar	setText(java.lang.String text) Sets the given text in the status bar.
GGStatusBar	setText(java.lang.String text, int backgroundColor) Same as setText(String text), but sets the background color attribute to given color.
GGStatusBar	setTextColor(int color) Sets the text color attribute.
GGStatusBar	setTypeface(android.graphics.Typeface typeface) Sets the typeface attribute.

Methods inherited from class java.lang.Object

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

Method Detail

getTextWidth

public int getTextWidth()

Returns the width of last text given by setText().

Returns:

the text widht in pixel; 0 of no text was yet set

getTextHeight

public int getTextHeight()

Returns the text height attribute. The text height is 0.7 * height of the status bar passed in createStatusBar().

Returns:

the value of the text height attribute

getBackgroundColor

public int getBackgroundColor()

Returns the background color attribute (default: Color.rgb(90, 90, 90)).

Returns:

the background color

setBackgroundColor

public GGStatusBar setBackgroundColor(int color)

Sets the background color attribute. The new value is used the next time a text is displayed.

Parameters:

color - the new background color

Returns:

the GGStatusBar reference to allow chaining

getBorderColor

public int getBorderColor()

Returns the border color attribute (default: Color.WHITE).

Returns:

the border color

setBorderColor

public GGStatusBar setBorderColor(int color)

Sets the border color attribute. The new value is used the next time a text is displayed.

Parameters:

color - the new border color

Returns:

the GGStatusBar reference to allow chaining

getTextColor

public int getTextColor()

Returns the text color attribute (default: Color.WHITE).

Returns:

the text color

setTextColor

public GGStatusBar setTextColor(int color)

Sets the text color attribute. The new value is used the next time a text is displayed.

Parameters:

color - the new text color

Returns:

the GGStatusBar reference to allow chaining

setTypeface

public GGStatusBar setTypeface(android.graphics.Typeface typeface)

Sets the typeface attribute. The new value is used the next time a text is displayed.

Parameters:

typeface - the new typeface

Returns:

the GGStatusBar reference to allow chaining

setRefreshEnabled

public GGStatusBar setRefreshEnabled(boolean enable)

Enables/disables the the automatic refresh by calling GameGrid.refresh() is called at the end of setText(). Be aware that this may cause flickering because different threads are refreshing the game grid.

Parameters:

enable - if true, the automatic refresh attribute is set to true; otherwise it is set to false

Returns:

the GGStatusBar reference to allow chaining

setText

public GGStatusBar setText(java.lang.String text,
                  int backgroundColor)

Same as setText(String text), but sets the background color attribute to given color.

Parameters:

text - the text to show in the status bar

backgroundColor - the new background color

Returns:

the GGStatusBar reference to allow chaining

setText

public GGStatusBar setText(java.lang.String text)

Sets the given text in the status bar. To make the text visible, the GameGrid must be refreshed either by calling refresh() or by the running game thread. If the automatic refresh attribute is set by calling setRefreshEnable(true), the game grid is automatically refreshed at the end of setText(). Be aware that this may cause flickering because different threads are refreshing the game grid.

Parameters:

text - the text to show in the status bar

Returns:

the GGStatusBar reference to allow chaining