vooga.engine.overlay
Class OverlayString

java.lang.Object
  Sprite
      vooga.engine.overlay.Overlay
          vooga.engine.overlay.OverlayString

Direct Known Subclasses:

OverlayClock, OverlayStat

public class OverlayString
extends Overlay

This OverlayString class displays some text on the screen. For an example see OverlayExample.java.

Field Summary

static java.awt.Color	DEFAULT_COLOR
static java.awt.Font	DEFAULT_FONT

Constructor Summary

OverlayString(java.util.Map<java.lang.String,java.lang.String> attributes, OverlayTracker tracker)

OverlayString(java.lang.String str)
Creats a String to be displayed as an image

OverlayString(java.lang.String str, java.awt.Font font)
Creats a String to be displayed as an image

OverlayString(java.lang.String str, java.awt.Font font, java.awt.Color color)
Creats a String to be displayed as an image

OverlayString(java.lang.String str, GameFont font)

Method Summary

int	getHeight()
java.lang.String	getString()
int	getWidth()
protected void	print(java.lang.String str, java.awt.Graphics2D g) This method is needed for other classes in the Overlay package.
void	render(java.awt.Graphics2D g) print the String
void	setColor(java.awt.Color color) This method will implemented if this Overlay was created with a Font or only a String and not a GameFont.
void	setFont(java.awt.Font font) This method will implemented if this Overlay was created with a Font or only a String and not a GameFont.
void	setFont(GameFont font)
void	setString(java.lang.String str)

Methods inherited from class vooga.engine.overlay.Overlay

setLocation

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COLOR

public static final java.awt.Color DEFAULT_COLOR

DEFAULT_FONT

public static final java.awt.Font DEFAULT_FONT

Constructor Detail

OverlayString

public OverlayString(java.lang.String str)

Creats a String to be displayed as an image

Parameters:

str - String to be printed

OverlayString

public OverlayString(java.lang.String str,
                     java.awt.Font font)

Creats a String to be displayed as an image

Parameters:

str - String to be printed

font -

OverlayString

public OverlayString(java.lang.String str,
                     java.awt.Font font,
                     java.awt.Color color)

Creats a String to be displayed as an image

Parameters:

str - String to be printed

font -

color -

OverlayString

public OverlayString(java.lang.String str,
                     GameFont font)

Parameters:

str - String to display

font -

OverlayString

public OverlayString(java.util.Map<java.lang.String,java.lang.String> attributes,
                     OverlayTracker tracker)

Method Detail

setFont

public void setFont(java.awt.Font font)

This method will implemented if this Overlay was created with a Font or only a String and not a GameFont. It will also not work if the setFont(GameFont) method was ever used.

Parameters:

font -

setString

public void setString(java.lang.String str)

setFont

public void setFont(GameFont font)

setColor

public void setColor(java.awt.Color color)

This method will implemented if this Overlay was created with a Font or only a String and not a GameFont. setFont(GameFont)

Parameters:

color -

print

protected void print(java.lang.String str,
                     java.awt.Graphics2D g)

This method is needed for other classes in the Overlay package. It should never be used by a game creator.

render

public void render(java.awt.Graphics2D g)

print the String

getString

public java.lang.String getString()

Returns:

returns the string this Overlay is displaying.

getWidth

public int getWidth()

Returns:

returns the width of the string.

getHeight

public int getHeight()

Returns:

returns the height of the string.