com.qoppa.pdf

Class LocalFontInfo

java.lang.Object

com.qoppa.pdf.LocalFontInfo

public class LocalFontInfo
extends Object

Object with information about local font found for embedding in PDF file.

Author:

Qoppa Software

Constructor Summary

Constructors

Constructor and Description
LocalFontInfo()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAllowEmbed() Get flag indicating if this font can be embedded in a document.
boolean	getAllowSubset() Get flag indicating if this font can be subsetted when embedding
boolean	getBold() Get flag indicating if this font is bold
boolean	getEmbedBitmapOnly() Get flag indicating if this font can only be embedded as bitmaps
int	getEmbedFlags() Get font embedding flags value - these flags can be checked to see what kinds of embedding are allowed.
String	getFamilyName() Get "family name" for font
String	getFilePath() Get path to file containing font
int	getFontIndex() Get index for font in collection file.
String	getFullName() Get "full name" for font
boolean	getItalic() Get flag indicating if this font is italic
boolean	getJavaSystemFont() Get flag indicating if this font is available as a Java system font
List<String>	getNameList() Get list of names for font.
String	getPSName() Get "PostScript name" for font
Object	getSFNT(boolean allowFail) Get SFNT object for font.
boolean	loadFontProperties(boolean allowFail) Load properties for font - either FilePath + FontIndex or SFNT must be set to supply font data.
void	setAllowEmbed(boolean value) Set flag indicating if this font can be embedded in a document.
void	setAllowSubset(boolean value) Set flag indicating if this font can be subsetted when embedding
void	setBold(boolean value) Set flag indicating if this font is bold
void	setEmbedBitmapOnly(boolean value) Set flag indicating if this font can only be embedded as bitmaps
void	setEmbedFlags(int value) Set font embedding flags value - these flags can be checked to see what kinds of embedding are allowed.
void	setFamilyName(String value) Set "family name" for font
void	setFilePath(String value) Set path to file containing font
void	setFontIndex(int value) Set index for font in collection file.
void	setFullName(String value) Set "full name" for font
void	setItalic(boolean value) Set flag indicating if this font is italic
void	setJavaSystemFont(boolean value) Set flag indicating if this font is available as a Java system font
void	setNameList(List<String> value) Set list of names for font.
void	setPSName(String value) Set "PostScript name" for font
void	setSFNT(Object value) Set font data as SFNT object loaded by qSFNTLY library

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalFontInfo

public LocalFontInfo()

Method Detail

setSFNT

public void setSFNT(Object value)

Set font data as SFNT object loaded by qSFNTLY library

Parameters:

SFNT - object from SFNTLY library

getSFNT

public Object getSFNT(boolean allowFail)
               throws PDFException

Get SFNT object for font. This object can be preset, via setSFNT(), or loaded dynamically from file and index settings.

Parameters:

SFNT - object from SFNTLY library

Throws:

PDFException

setFilePath

public void setFilePath(String value)

Set path to file containing font

Parameters:

Path - to file containing font

getFilePath

public String getFilePath()

Get path to file containing font

Returns:

Path to file containing font

setFontIndex

public void setFontIndex(int value)

Set index for font in collection file.

Parameters:

Zero-based - index of font in collection file. -1 (default) for file with single font.

getFontIndex

public int getFontIndex()

Get index for font in collection file.

Returns:

Zero-based index of font in collection file. -1 (default) for file with single font.

getNameList

public List<String> getNameList()

Get list of names for font. Includes all localized font names, full name, family name and PostScript name

Returns:

List of font name strings

setNameList

public void setNameList(List<String> value)

Set list of names for font.

setEmbedFlags

public void setEmbedFlags(int value)

Set font embedding flags value - these flags can be checked to see what kinds of embedding are allowed. This is the fsType field from the 'OS/2' table in the TrueType or OpenType font file.

Parameters:

Embed - flags value

getEmbedFlags

public int getEmbedFlags()

Get font embedding flags value - these flags can be checked to see what kinds of embedding are allowed. This is the fsType field from the 'OS/2' table in the TrueType or OpenType font file.

Returns:

Embed flags value

setAllowEmbed

public void setAllowEmbed(boolean value)

Set flag indicating if this font can be embedded in a document.

Parameters:

Font - embed flag

getAllowEmbed

public boolean getAllowEmbed()

Get flag indicating if this font can be embedded in a document.

Returns:

Font embed flag

setAllowSubset

public void setAllowSubset(boolean value)

Set flag indicating if this font can be subsetted when embedding

Parameters:

Font - subset flag

getAllowSubset

public boolean getAllowSubset()

Get flag indicating if this font can be subsetted when embedding

setEmbedBitmapOnly

public void setEmbedBitmapOnly(boolean value)

Set flag indicating if this font can only be embedded as bitmaps

Parameters:

Font - bitmap embed flag

getEmbedBitmapOnly

public boolean getEmbedBitmapOnly()

Get flag indicating if this font can only be embedded as bitmaps

Returns:

Font bitmap embed flag

setBold

public void setBold(boolean value)

Set flag indicating if this font is bold

Parameters:

Bold - flag

getBold

public boolean getBold()

Get flag indicating if this font is bold

Returns:

Bold flag

setItalic

public void setItalic(boolean value)

Set flag indicating if this font is italic

Parameters:

Italic - flag

getItalic

public boolean getItalic()

Get flag indicating if this font is italic

Returns:

Italic flag

setJavaSystemFont

public void setJavaSystemFont(boolean value)

Set flag indicating if this font is available as a Java system font

Parameters:

Java - system font flag

getJavaSystemFont

public boolean getJavaSystemFont()

Get flag indicating if this font is available as a Java system font

Returns:

Java system font flag

setFullName

public void setFullName(String value)

Set "full name" for font

Parameters:

Full - name string

getFullName

public String getFullName()

Get "full name" for font

Returns:

Full name string

setFamilyName

public void setFamilyName(String value)

Set "family name" for font

Parameters:

Family - name string

getFamilyName

public String getFamilyName()

Get "family name" for font

Returns:

Family name string

setPSName

public void setPSName(String value)

Set "PostScript name" for font

Parameters:

PostScript - name string

getPSName

public String getPSName()

Get "PostScript name" for font

Returns:

PostScript name string

loadFontProperties

public boolean loadFontProperties(boolean allowFail)
                           throws PDFException,
                                  IOException

Load properties for font - either FilePath + FontIndex or SFNT must be set to supply font data.

Parameters:

allowFail - - flag: true = allow failure flag, passed to underlying SFNTLY code

Returns:

boolean flag: true = successfully loaded, false = didn't load

Throws:

PDFException

IOException