com.github.lalyos.jfiglet

Class FigletFont

java.lang.Object

com.github.lalyos.jfiglet.FigletFont

public class FigletFont
extends java.lang.Object

FigletFont implementation. A single static method call will create the ascii art in a mulitilne String. FigletFont format is specified at: https://github.com/lalyos/jfiglet/blob/master/figfont.txt

 String asciiArt = FigletFont.convertOneLine("hello");
 

Originally found at: http://www.rigaut.com/benoit/CERN/FigletJava/. Moved to github.com.

Author:

Benoit Rigaut CERN July 96 www.rigaut.com benoit@rigaut.com released with GPL the 13th of november 2000 (my birthday!)

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Integer	codetagCount
char[][][]	font
java.lang.String	fontName
java.lang.Integer	fullLayout
char	hardblank
int	height
int	heightWithoutDescenders
static int	MAX_CHARS
int	maxLine
java.lang.Integer	printDirection
static int	REGULAR_CHARS
int	smushMode

Constructor Summary

Constructors

Constructor and Description
FigletFont(java.io.InputStream stream) Creates a FigletFont as specified at: https://github.com/lalyos/jfiglet/blob/master/figfont.txt

Method Summary

Modifier and Type	Method and Description
java.lang.String	convert(java.lang.String message)
static java.lang.String	convertOneLine(java.io.File fontFile, java.lang.String message)
static java.lang.String	convertOneLine(java.io.InputStream fontFileStream, java.lang.String message)
static java.lang.String	convertOneLine(java.lang.String message)
static java.lang.String	convertOneLine(java.lang.String fontPath, java.lang.String message)
char[][]	getChar(int c) Return a single character represented as char[][].
java.lang.String	getCharLineString(int c, int l) Selects a single line from a character.
char[][][]	getFont() Returns all character from this Font.

Methods inherited from class java.lang.Object

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

Field Detail

hardblank

public char hardblank

height

public int height

heightWithoutDescenders

public int heightWithoutDescenders

maxLine

public int maxLine

smushMode

public int smushMode

printDirection

public java.lang.Integer printDirection

fullLayout

public java.lang.Integer fullLayout

codetagCount

public java.lang.Integer codetagCount

font

public char[][][] font

fontName

public java.lang.String fontName

MAX_CHARS

public static final int MAX_CHARS

See Also:

Constant Field Values

REGULAR_CHARS

public static final int REGULAR_CHARS

See Also:

Constant Field Values

Constructor Detail

FigletFont

public FigletFont(java.io.InputStream stream)
           throws java.io.IOException

Creates a FigletFont as specified at: https://github.com/lalyos/jfiglet/blob/master/figfont.txt

Parameters:

stream -

Throws:

java.io.IOException

Method Detail

getFont

public char[][][] getFont()

Returns all character from this Font. Each character is defined as char[][]. So the whole font is a char[][][].

Returns:

The representation of all characters.

getChar

public char[][] getChar(int c)

Return a single character represented as char[][].

Parameters:

c - The numerical id of the character.

Returns:

The definition of a single character.

getCharLineString

public java.lang.String getCharLineString(int c,
                                          int l)

Selects a single line from a character.

Parameters:

c - Character id

l - Line number

Returns:

The selected line from the character

convert

public java.lang.String convert(java.lang.String message)

convertOneLine

public static java.lang.String convertOneLine(java.io.InputStream fontFileStream,
                                              java.lang.String message)
                                       throws java.io.IOException

Throws:

java.io.IOException

convertOneLine

public static java.lang.String convertOneLine(java.lang.String message)
                                       throws java.io.IOException

Throws:

java.io.IOException

convertOneLine

public static java.lang.String convertOneLine(java.io.File fontFile,
                                              java.lang.String message)
                                       throws java.io.IOException

Throws:

java.io.IOException

convertOneLine

public static java.lang.String convertOneLine(java.lang.String fontPath,
                                              java.lang.String message)
                                       throws java.io.IOException

Throws:

java.io.IOException