org.apache.fop.fonts
Class MultiByteFont

java.lang.Object
  org.apache.fop.fonts.Typeface
      org.apache.fop.fonts.CustomFont
          org.apache.fop.fonts.CIDFont
              org.apache.fop.fonts.MultiByteFont

All Implemented Interfaces:

FontDescriptor, FontMetrics, MutableFont

public class MultiByteFont

extends CIDFont

Generic MultiByte (CID) font

Field Summary

static char

INVALID_UNICODE_CHAR The invalid Unicode character, suitable as a return value in methods that need to return an invalid character.

Fields inherited from class org.apache.fop.fonts.CIDFont

usedCharsIndex, usedGlyphs, usedGlyphsCount, usedGlyphsIndex, width

Fields inherited from class org.apache.fop.fonts.CustomFont

embedResourceName

Constructor Summary

MultiByteFont()
Default constructor

Method Summary

char[]	getCharsUsed() Returns char[] array .
java.lang.String	getCidBaseFont() Returns the name of the base font.
CIDFontType	getCIDType() Returns the type of the CID font.
int	getDefaultWidth() Returns the default width for this font.
java.lang.String	getEncoding() Get the encoding of the font.
java.lang.String	getFontName() Returns the font name.
java.lang.String	getOrdering() Returns a font name for use within a registry.
java.lang.String	getRegistry() Returns the name of the issuer of the font.
int	getSupplement() Returns the supplement number of the character collection.
java.lang.String	getTTCName() Returns the TrueType Collection Name.
java.util.Map	getUsedGlyphs() Returns a Map of used Glyphs.
int	getWidth(int i, int size) Return the width (in 1/1000ths of point size) of the character at code point i.
int[]	getWidths() Return the array of widths.
boolean	hasChar(char c) Determines whether this font contains a particular character/glyph.
boolean	isEmbeddable() Indicates if this font may be embedded.
char	mapChar(char c) Map a Unicode character to a code point in the font.
void	setBFEntries(BFEntry[] bfentries) Sets the bfentries.
void	setCIDType(CIDFontType cidType) Sets the CIDType.
void	setDefaultWidth(int defaultWidth) Sets the defaultWidth.
void	setTTCName(java.lang.String ttcName) Sets the the TrueType Collection Name.
void	setWidthArray(int[] wds) Sets the width array.

Methods inherited from class org.apache.fop.fonts.CIDFont

isMultiByte

Methods inherited from class org.apache.fop.fonts.CustomFont

getAscender, getAscender, getCapHeight, getCapHeight, getDescender, getDescender, getEmbedFileName, getEmbedFileSource, getEmbedResourceName, getFirstChar, getFlags, getFontBBox, getFontType, getItalicAngle, getKerningInfo, getLastChar, getMissingWidth, getStemV, getXHeight, hasKerningInfo, isKerningEnabled, putKerningEntry, setAscender, setCapHeight, setDescender, setEmbedFileName, setEmbedResourceName, setFirstChar, setFlags, setFontBBox, setFontName, setFontType, setItalicAngle, setKerningEnabled, setLastChar, setMissingWidth, setResolver, setStemV, setXHeight

Methods inherited from class org.apache.fop.fonts.Typeface

getMaxAscent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.fop.fonts.FontMetrics

getMaxAscent

Field Detail

INVALID_UNICODE_CHAR

public static final char INVALID_UNICODE_CHAR

The invalid Unicode character, suitable as a return value in methods that need to return an invalid character.

See Also:

Constant Field Values

Constructor Detail

MultiByteFont

public MultiByteFont()

Default constructor

Method Detail

getDefaultWidth

public int getDefaultWidth()

Description copied from class: CIDFont

Returns the default width for this font.

Overrides:

getDefaultWidth in class CIDFont

Returns:

the default width

See Also:

CIDFont.getDefaultWidth()

getRegistry

public java.lang.String getRegistry()

Description copied from class: CIDFont

Returns the name of the issuer of the font.

Specified by:

getRegistry in class CIDFont

Returns:

a String identifying an issuer of character collections - for example, Adobe

See Also:

CIDFont.getRegistry()

getOrdering

public java.lang.String getOrdering()

Description copied from class: CIDFont

Returns a font name for use within a registry.

Specified by:

getOrdering in class CIDFont

Returns:

a String that uniquely names a character collection issued by a specific registry - for example, Japan1.

See Also:

CIDFont.getOrdering()

getSupplement

public int getSupplement()

Description copied from class: CIDFont

Returns the supplement number of the character collection.

Specified by:

getSupplement in class CIDFont

Returns:

the supplement number

See Also:

CIDFont.getSupplement()

getCIDType

public CIDFontType getCIDType()

Description copied from class: CIDFont

Returns the type of the CID font.

Specified by:

getCIDType in class CIDFont

Returns:

the type of the CID font

See Also:

CIDFont.getCIDType()

setCIDType

public void setCIDType(CIDFontType cidType)

Sets the CIDType.

Parameters:

cidType - The cidType to set

getCidBaseFont

public java.lang.String getCidBaseFont()

Description copied from class: CIDFont

Returns the name of the base font.

Specified by:

getCidBaseFont in class CIDFont

Returns:

the name of the base font

See Also:

CIDFont.getCidBaseFont()

isEmbeddable

public boolean isEmbeddable()

Description copied from interface: FontDescriptor

Indicates if this font may be embedded.

Returns:

True, if embedding is possible/permitted

See Also:

FontDescriptor.isEmbeddable()

getEncoding

public java.lang.String getEncoding()

Description copied from class: Typeface

Get the encoding of the font.

Specified by:

getEncoding in class Typeface

Returns:

the encoding

See Also:

Typeface.getEncoding()

getFontName

public java.lang.String getFontName()

Description copied from interface: FontMetrics

Returns the font name.

Specified by:

getFontName in interface FontMetrics

Overrides:

getFontName in class CustomFont

See Also:

FontMetrics.getFontName()

getWidth

public int getWidth(int i,
                    int size)

Description copied from interface: FontMetrics

Return the width (in 1/1000ths of point size) of the character at code point i.

Parameters:

i - code point index

size - font size

Returns:

the width of the character

See Also:

FontMetrics.getWidth(int, int)

getWidths

public int[] getWidths()

Description copied from interface: FontMetrics

Return the array of widths.

This is used to get an array for inserting in an output format. It should not be used for lookup.

Returns:

an array of widths

See Also:

FontMetrics.getWidths()

mapChar

public char mapChar(char c)

Description copied from class: Typeface

Map a Unicode character to a code point in the font.

Specified by:

mapChar in class Typeface

Parameters:

c - character to map

Returns:

the mapped character

See Also:

Typeface.mapChar(char)

hasChar

public boolean hasChar(char c)

Description copied from class: Typeface

Determines whether this font contains a particular character/glyph.

Specified by:

hasChar in class Typeface

Parameters:

c - character to check

Returns:

True if the character is supported, Falso otherwise

See Also:

Typeface.hasChar(char)

setBFEntries

public void setBFEntries(BFEntry[] bfentries)

Sets the bfentries.

Parameters:

bfentries - The bfentries to set

setDefaultWidth

public void setDefaultWidth(int defaultWidth)

Sets the defaultWidth.

Parameters:

defaultWidth - The defaultWidth to set

getTTCName

public java.lang.String getTTCName()

Returns the TrueType Collection Name.

Returns:

the TrueType Collection Name

setTTCName

public void setTTCName(java.lang.String ttcName)

Sets the the TrueType Collection Name.

Parameters:

ttcName - the TrueType Collection Name

setWidthArray

public void setWidthArray(int[] wds)

Sets the width array.

Parameters:

wds - array of widths.

getUsedGlyphs

public java.util.Map getUsedGlyphs()

Returns a Map of used Glyphs.

Returns:

Map Map of used Glyphs

getCharsUsed

public char[] getCharsUsed()

Description copied from class: CIDFont

Returns char[] array .

Specified by:

getCharsUsed in class CIDFont

See Also:

CIDFont.getCharsUsed()