com.helger.pdflayout.spec

Class PreloadFont

java.lang.Object

com.helger.pdflayout.spec.PreloadFont

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>

@Immutable
public final class PreloadFont
extends Object
implements com.helger.commons.id.IHasID<String>

Represents an abstract font that is potentially not yet loaded and can be used in multiple documents.
Note: cannot be Serializable because PDFont is not Serializable.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static PreloadFont	MONOSPACE PDF built-in font Courier regular
static PreloadFont	MONOSPACE_BOLD PDF built-in font Courier bold
static PreloadFont	MONOSPACE_BOLD_ITALIC PDF built-in font Courier bold and italic
static PreloadFont	MONOSPACE_ITALIC PDF built-in font Courier italic
static PreloadFont	REGULAR PDF built-in font Helvetica regular
static PreloadFont	REGULAR_BOLD PDF built-in font Helvetica bold
static PreloadFont	REGULAR_BOLD_ITALIC PDF built-in font Helvetica bold and italic
static PreloadFont	REGULAR_ITALIC PDF built-in font Helvetica italic
static PreloadFont	SYMBOL PDF built-in font Symbol
static PreloadFont	TIMES PDF built-in font Times Roman regular
static PreloadFont	TIMES_BOLD PDF built-in font Times Roman bold
static PreloadFont	TIMES_BOLD_ITALIC PDF built-in font Times Roman bold italic
static PreloadFont	TIMES_ITALIC PDF built-in font Times Roman italic
static PreloadFont	ZAPF_DINGBATS PDF built-in font Zapf Dingbats

Method Summary

Modifier and Type	Method and Description
static PreloadFont	createEmbedding(com.helger.font.api.IFontResource aFontRes)
static PreloadFont	createNonEmbedding(com.helger.font.api.IFontResource aFontRes)
static PreloadFont	createPredefined(org.apache.pdfbox.pdmodel.font.PDType1Font aFont)
boolean	equals(Object o)
String	getID()
int	hashCode()
org.apache.pdfbox.pdmodel.font.PDFont	loadPDFont(org.apache.pdfbox.pdmodel.PDDocument aDoc) Load the PDFont associated to this preload font.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID

Field Detail

REGULAR

public static final PreloadFont REGULAR

PDF built-in font Helvetica regular

REGULAR_BOLD

public static final PreloadFont REGULAR_BOLD

PDF built-in font Helvetica bold

REGULAR_ITALIC

public static final PreloadFont REGULAR_ITALIC

PDF built-in font Helvetica italic

REGULAR_BOLD_ITALIC

public static final PreloadFont REGULAR_BOLD_ITALIC

PDF built-in font Helvetica bold and italic

MONOSPACE

public static final PreloadFont MONOSPACE

PDF built-in font Courier regular

MONOSPACE_BOLD

public static final PreloadFont MONOSPACE_BOLD

PDF built-in font Courier bold

MONOSPACE_ITALIC

public static final PreloadFont MONOSPACE_ITALIC

PDF built-in font Courier italic

MONOSPACE_BOLD_ITALIC

public static final PreloadFont MONOSPACE_BOLD_ITALIC

PDF built-in font Courier bold and italic

TIMES

public static final PreloadFont TIMES

PDF built-in font Times Roman regular

TIMES_BOLD

public static final PreloadFont TIMES_BOLD

PDF built-in font Times Roman bold

TIMES_ITALIC

public static final PreloadFont TIMES_ITALIC

PDF built-in font Times Roman italic

TIMES_BOLD_ITALIC

public static final PreloadFont TIMES_BOLD_ITALIC

PDF built-in font Times Roman bold italic

SYMBOL

public static final PreloadFont SYMBOL

PDF built-in font Symbol

ZAPF_DINGBATS

public static final PreloadFont ZAPF_DINGBATS

PDF built-in font Zapf Dingbats

Method Detail

getID

@Nonnull
 @Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

loadPDFont

@Nonnull
public org.apache.pdfbox.pdmodel.font.PDFont loadPDFont(@Nonnull
                                                                  org.apache.pdfbox.pdmodel.PDDocument aDoc)
                                                           throws IOException

Load the PDFont associated to this preload font. This class uses no caching!

Parameters:

aDoc - The PDDocument to which the font should be attached to. May not be null.

Returns:

The loaded font.

Throws:

IOException - In case loading the external file fails

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

createPredefined

@Nonnull
public static PreloadFont createPredefined(@Nonnull
                                                     org.apache.pdfbox.pdmodel.font.PDType1Font aFont)

createNonEmbedding

@Nonnull
public static PreloadFont createNonEmbedding(@Nonnull
                                                       com.helger.font.api.IFontResource aFontRes)

createEmbedding

@Nonnull
public static PreloadFont createEmbedding(@Nonnull
                                                    com.helger.font.api.IFontResource aFontRes)