net.sf.freecol.client.gui
Class FAFile

java.lang.Object
  extended by net.sf.freecol.client.gui.FAFile

public class FAFile
extends java.lang.Object

Represents the data within a Font Animation File.

See Also:
DeclarationDialog

Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String LICENSE
           
static java.lang.String REVISION
           
 
Constructor Summary
FAFile(java.io.InputStream is)
          Reads data from the given InputStream and creates an object to represent this data.
 
Method Summary
 java.awt.Dimension getDimension(java.lang.String text)
          Gets the Dimension of the given String when rendered.
 java.awt.Point[] getPoints(java.lang.String text)
          Gets the points to display the given text as an animation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

LICENSE

public static final java.lang.String LICENSE
See Also:
Constant Field Values

REVISION

public static final java.lang.String REVISION
See Also:
Constant Field Values
Constructor Detail

FAFile

public FAFile(java.io.InputStream is)
       throws java.io.IOException
Reads data from the given InputStream and creates an object to represent this data.

Parameters:
is - The InputStream
Throws:
java.io.IOException - gets thrown if the data is invalid.
Method Detail

getDimension

public java.awt.Dimension getDimension(java.lang.String text)
Gets the Dimension of the given String when rendered.

Parameters:
text - The String.
Returns:
The Dimension.

getPoints

public java.awt.Point[] getPoints(java.lang.String text)
Gets the points to display the given text as an animation.

Parameters:
text - The text to get the points for.
Returns:
The points in the order in which they should be drawn.