FAFile (FreeCol Code Documentation)

java.lang.Object
- net.sf.freecol.common.resources.FAFile

```
public class FAFile
extends java.lang.Object
```
Represents the data within a Font Animation File.

See Also:

DeclarationPanel

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`private static class`	`FAFile.CREatingInputStream`	This utility class removes all CR:s from an `InputStream`.
`private static class`	`FAFile.FALetter`
`private static class`	`FAFile.FAName`

Field Summary

Fields
Modifier and Type Field Description

private java.util.HashMap<java.lang.Object,java.lang.Object> letters

private int maxHeight

Constructor Summary

Constructors
Constructor Description

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.awt.Dimension`	`getDimension(java.lang.String text)`	Gets the `Dimension` of the given `String` when rendered.
`private FAFile.FAName`	`getFAName(java.lang.String name)`
`private FAFile.FALetter`	`getLetter(char letter)`
`java.awt.Point[]`	`getPoints(java.lang.String text)`	Gets the points to display the given text as an animation.
`private void`	`load(java.io.InputStream is)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - letters
```
private final java.util.HashMap<java.lang.Object,java.lang.Object> letters
```
  - maxHeight
```
private int maxHeight
```
- 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.
  - load
```
private void load(java.io.InputStream is)
           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getLetter
```
private FAFile.FALetter getLetter(char letter)
```
  - getFAName
```
private FAFile.FAName getFAName(java.lang.String name)
```