org.deken.game.component
Class GText

java.lang.Object
  extended by org.deken.game.component.GText

public class GText
extends java.lang.Object

Title: GameText

Description: Utility for Texts.

Copyright: Copyright (c) Mar 17, 2011

Version:
1.0
Author:
Gary Deken

Constructor Summary
GText(java.lang.String text, java.awt.Font font, java.awt.Color fontColor)
           
GText(java.lang.String text, java.awt.Font font, java.awt.Color fontColor, java.awt.Color backgroundColor)
           
 
Method Summary
protected  GText copy()
           
 void drawText(java.awt.Graphics2D graphics, int xLocation, int yLocation)
           
 java.awt.Color getBackgroundColor()
           
 java.awt.Font getFont()
           
 java.awt.Color getFontColor()
           
 SpriteSize getSize()
           
 java.lang.String getText()
           
 int getTextOffset()
           
 int getXMargin()
           
 int getYMargin()
           
 boolean isInvalid()
           
 void setBackgroundColor(java.awt.Color backgroundColor)
           
 void setFont(java.awt.Font font)
           
 void setFontColor(java.awt.Color fontColor)
           
 void setInvalid()
           
 void setSize(int width, int height)
          Sets a size for the text.
 void setText(java.lang.String text)
           
 void setXMargin(int xMargin)
           
 void setYMargin(int yMargin)
           
 java.lang.String toString()
           
 void validate(java.awt.Graphics2D graphics)
          Uses the current graphics object to get FontMetrics and the size of the text.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GText

public GText(java.lang.String text,
             java.awt.Font font,
             java.awt.Color fontColor)
Parameters:
text -
font -
fontColor -

GText

public GText(java.lang.String text,
             java.awt.Font font,
             java.awt.Color fontColor,
             java.awt.Color backgroundColor)
Method Detail

drawText

public void drawText(java.awt.Graphics2D graphics,
                     int xLocation,
                     int yLocation)

getBackgroundColor

public java.awt.Color getBackgroundColor()

getFont

public java.awt.Font getFont()

getFontColor

public java.awt.Color getFontColor()

getSize

public SpriteSize getSize()
Returns:
size

getText

public java.lang.String getText()

getTextOffset

public int getTextOffset()

getXMargin

public int getXMargin()

getYMargin

public int getYMargin()

isInvalid

public boolean isInvalid()

setBackgroundColor

public void setBackgroundColor(java.awt.Color backgroundColor)

setFont

public void setFont(java.awt.Font font)

setFontColor

public void setFontColor(java.awt.Color fontColor)

setInvalid

public void setInvalid()

setSize

public void setSize(int width,
                    int height)
Sets a size for the text.

Parameters:
width -
height -

setText

public void setText(java.lang.String text)

setXMargin

public void setXMargin(int xMargin)

setYMargin

public void setYMargin(int yMargin)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

validate

public void validate(java.awt.Graphics2D graphics)
Uses the current graphics object to get FontMetrics and the size of the text. Then adjust the size based on the margins.

Parameters:
graphics -

copy

protected GText copy()