LEDFont (JScrollPhat Core 1.0 API)

java.lang.Object
- net.freeutils.scrollphat.LEDFont

```
public class LEDFont
extends Object
```
Loads a font in ledfont format and renders text using the font.
The ledfont format and this font implementation are lightweight and quite efficient for tiny fixed-size fonts, such as the ones that would be used in an embedded device or a LED matrix.
Current limitations:
- Height is limited to 8 pixels (1 byte)
- Glyph Width is limited to 255 pixels (width stored in 1 byte)
- Entire font data is stored in memory (although usually only ~2K)

Field Summary

Fields
Modifier and Type Field and Description

protected byte[] data

protected int height

protected Map<Integer,Integer> lookup

static byte[] MAGIC

protected int used

Fields
Modifier and Type	Field and Description
`protected byte[]`	`data`
`protected int`	`height`
`protected Map<Integer,Integer>`	`lookup`
`static byte[]`	`MAGIC`
`protected int`	`used`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`LEDFont(byte[] data)` Constructs a LEDFont from a byte array containing data in ledfont format.
	`LEDFont(InputStream in)` Constructs a LEDFont from a stream containing data in ledfont format.
`protected`	`LEDFont(int height)` Constructs an empty LEDFont.
	`LEDFont(String filename)` Constructs a LEDFont from a file or resource in ledfont format.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addChar(int c, byte[] data, int offset, int length)` Adds a character to this font.
`int`	`getHeight()` Returns the font height in pixels.
`int`	`getMaxWidth(char[] chars)` Returns the maximum glyph width among all of the given characters.
`Set<Integer>`	`getSupportedChars()` Returns the sorted set of Unicode code points supported by this font.
`String`	`getSupportedCharsAsString()` Returns a string of Unicode code points supported by this font.
`int`	`getWidth(char[] chars, int start, int len)` Returns the width in pixels of the given characters.
`int`	`getWidth(int c)` Returns the width in pixels of the given code point.
`int`	`getWidth(String s)` Returns the width in pixels of the given string.
`static void`	`main(String[] args)` The main command-line utility entry point.
`protected void`	`parse(byte[] data)` Parses data in the ledfont format.
`protected void`	`save(File out)` Saves this font into the given file in the ledfont format.
`protected void`	`save(OutputStream out)` Saves this font into the given stream in the ledfont format.
`String`	`toAsciiArt(String s, int lineWidth)` Writes the glyphs for the given sequence of characters into an ASCII-art string.
`int`	`write(char[] chars, int start, int len, byte[] buf, int offset)` Writes the glyphs for the given characters into an array.
`int`	`write(int c, byte[] buf, int offset)` Writes the glyph for the given code point into an array.
`byte[]`	`write(String s)` Writes the glyphs for the given string.
`int`	`write(String s, byte[] buf, int offset)` Writes the glyphs for the given string into an array.

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

- Field Detail
  - MAGIC
```
public static byte[] MAGIC
```
  - height
```
protected int height
```
  - data
```
protected byte[] data
```
  - used
```
protected int used
```
  - lookup
```
protected Map<Integer,Integer> lookup
```
- Constructor Detail
  - LEDFont
```
protected LEDFont(int height)
```
    Constructs an empty LEDFont.
    
    Parameters:
    
    height - the font height
  - LEDFont
```
public LEDFont(String filename)
        throws IOException
```
    Constructs a LEDFont from a file or resource in ledfont format.
    
    Parameters:
    
    filename - the file (or resource) name
    
    Throws:
    
    IOException - if an error occurs
  - LEDFont
```
public LEDFont(InputStream in)
        throws IOException
```
    Constructs a LEDFont from a stream containing data in ledfont format.
    
    Parameters:
    
    in - the stream from which the ledfont data is read
    
    Throws:
    
    IOException - if an error occurs
  - LEDFont
```
public LEDFont(byte[] data)
```
    Constructs a LEDFont from a byte array containing data in ledfont format.
    
    Parameters:
    
    data - the data in ledfont format
- Method Detail
  - getHeight
```
public int getHeight()
```
    Returns the font height in pixels.
    
    Returns:
    
    the font height in pixels
  - getSupportedChars
```
public Set<Integer> getSupportedChars()
```
    Returns the sorted set of Unicode code points supported by this font.
    
    Returns:
    
    the sorted set of Unicode code points supported by this font
  - getSupportedCharsAsString
```
public String getSupportedCharsAsString()
```
    Returns a string of Unicode code points supported by this font.
    
    Returns:
    
    a string of Unicode code points supported by this font
  - parse
```
protected void parse(byte[] data)
```
    Parses data in the ledfont format.
    
    Parameters:
    
    data - the data in ledfont format
  - save
```
protected void save(OutputStream out)
             throws IOException
```
    Saves this font into the given stream in the ledfont format.
    
    Parameters:
    
    out - the stream to save to
    
    Throws:
    
    IOException - if an error occurs
  - save
```
protected void save(File out)
             throws IOException
```
    Saves this font into the given file in the ledfont format.
    
    Parameters:
    
    out - the file to save to
    
    Throws:
    
    IOException - if an error occurs
  - getMaxWidth
```
public int getMaxWidth(char[] chars)
```
    Returns the maximum glyph width among all of the given characters.
    
    Parameters:
    
    chars - the code points
    
    Returns:
    
    the maximum width
  - addChar
```
protected void addChar(int c,
                       byte[] data,
                       int offset,
                       int length)
```
    Adds a character to this font.
    
    Parameters:
    
    c - the Unicode code point
    
    data - an array containing the glyph data
    
    offset - the offset within the array where the glyph data starts
    
    length - the length of the glyph data (the glyph width)
  - getWidth
```
public int getWidth(int c)
```
    Returns the width in pixels of the given code point.
    
    Parameters:
    
    c - a code point
    
    Returns:
    
    the width in pixels of the given code point, or 0 if the code point is not supported
  - getWidth
```
public int getWidth(char[] chars,
                    int start,
                    int len)
```
    Returns the width in pixels of the given characters.
    
    Parameters:
    
    chars - a sequence of characters
    
    start - the start index of the character sequence
    
    len - the length of the character sequence
    
    Returns:
    
    the width in pixels of the given characters
  - getWidth
```
public int getWidth(String s)
```
    Returns the width in pixels of the given string.
    
    Parameters:
    
    s - a sequence of characters
    
    Returns:
    
    the width in pixels of the given string
  - write
```
public int write(int c,
                 byte[] buf,
                 int offset)
```
    Writes the glyph for the given code point into an array.
    
    Parameters:
    
    c - a code point
    
    buf - an array into which the glyph is written
    
    offset - the offset within the array at which to write
    
    Returns:
    
    the width of the written glyphs in pixels
  - write
```
public int write(char[] chars,
                 int start,
                 int len,
                 byte[] buf,
                 int offset)
```
    Writes the glyphs for the given characters into an array.
    
    Parameters:
    
    chars - a sequence of characters
    
    start - the index of the first character to write
    
    len - the length of the character sequence to write
    
    buf - an array into which the glyphs are written
    
    offset - the offset within the array at which to write
    
    Returns:
    
    the width of the written glyphs in pixels
  - write
```
public int write(String s,
                 byte[] buf,
                 int offset)
```
    Writes the glyphs for the given string into an array.
    
    Parameters:
    
    s - a sequence of characters
    
    buf - an array into which the glyphs are written
    
    offset - the offset within the array at which to write
    
    Returns:
    
    the width of the written glyphs in pixels
  - write
```
public byte[] write(String s)
```
    Writes the glyphs for the given string.
    
    Parameters:
    
    s - a sequence of characters
    
    Returns:
    
    an array containing the written glyphs
  - toAsciiArt
```
public String toAsciiArt(String s,
                         int lineWidth)
```
    Writes the glyphs for the given sequence of characters into an ASCII-art string. This is very useful for testing.
    
    Parameters:
    
    s - a sequence of characters
    
    lineWidth - the maximum width of the ASCII-art line in pixels (after which a new line will be started)
    
    Returns:
    
    the ASCII-art string of glyphs
  - main
```
public static void main(String[] args)
                 throws IOException
```
    The main command-line utility entry point.
    
    Parameters:
    
    args - the arguments
    
    Throws:
    
    IOException - if an error occurs

Class LEDFont

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAGIC

height

data

used

lookup

Constructor Detail

LEDFont

LEDFont

LEDFont

LEDFont

Method Detail

getHeight

getSupportedChars

getSupportedCharsAsString

parse

save

save

getMaxWidth

addChar

getWidth

getWidth

getWidth

write

write

write

write

toAsciiArt

main