JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.page
Class TrueTypeFontProperties

java.lang.Object
  |
  +--com.klg.jclass.page.TrueTypeFontProperties

public class TrueTypeFontProperties
extends Object


Field Summary
static int ANSI
          All characters in document text lie in the ANSI range, that is character codes between 0 and 255.
static int AUTO_DETECT
          Automatically detects from document text when characters are in the ANSI and UNICODE ranges.
protected  int characterRange
          Rules for outputting document text int he resulding PDF file.
static int DO_NOT_EMBED
          Do not embed the font in the generated document file.
static int EMBED_ENTIRE_FONT
          Embed the entire font in the generated document file.
static int EMBED_NEEDED
          Embed only the necessary glyphs in the generated document file.
protected  int embeddingRules
          Rules for embedding the font in the generated document file.
protected  boolean includeUnicodeMap
          Determines whether output (e.g.
static int UNICODE
          Characters in document text lie in the UNICODE range, that is character codes between 0 and 65535.
 
Constructor Summary
TrueTypeFontProperties()
          Default constructor.
TrueTypeFontProperties(int characterRange, int embeddingRules, boolean includeMap)
          Default constructor.
 
Method Summary
 int getCharacterRange()
          Get the CharacterRange value, which specifies the range that the characters that make up document text will occupy.
 int getEmbeddingRules()
          Get the rules for embedding a related true type font within the generated document (e.g.
 boolean getIncludeUnicodeMap()
          Get the value of the IncludeUnicodeMap property, which determines whether output (e.g.
 void setCharacterRange(int characterRange)
          Set the CharacterRange value, which specifies the range that the characters that make up document text will occupy.
 void setEmbeddingRules(int embeddingRules)
          Set the rules for embedding a related true type font within the generated document (e.g.
 void setIncludeUnicodeMap(boolean includeMap)
          Set the value of the IncludeUnicodeMap property, which determines whether output (e.g.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DO_NOT_EMBED

public static final int DO_NOT_EMBED
Do not embed the font in the generated document file.

See Also:
Constant Field Values

EMBED_NEEDED

public static final int EMBED_NEEDED
Embed only the necessary glyphs in the generated document file.

See Also:
Constant Field Values

EMBED_ENTIRE_FONT

public static final int EMBED_ENTIRE_FONT
Embed the entire font in the generated document file.

See Also:
Constant Field Values

embeddingRules

protected int embeddingRules
Rules for embedding the font in the generated document file. One of DO_NOT_EMBED, EMBED_NEEDED or EMBED_ENTIRE_FONT.


AUTO_DETECT

public static final int AUTO_DETECT
Automatically detects from document text when characters are in the ANSI and UNICODE ranges.

See Also:
Constant Field Values

ANSI

public static final int ANSI
All characters in document text lie in the ANSI range, that is character codes between 0 and 255. Any characters references outside of the ANSI range will likely not draw correctly.

See Also:
Constant Field Values

UNICODE

public static final int UNICODE
Characters in document text lie in the UNICODE range, that is character codes between 0 and 65535. This setting encompasses the greatest number of characters.

See Also:
Constant Field Values

characterRange

protected int characterRange
Rules for outputting document text int he resulding PDF file. One of AUTO_DETECT, ANSI or UNICODE.


includeUnicodeMap

protected boolean includeUnicodeMap
Determines whether output (e.g. a PDF File) should contain a glyph-to-unicode map. The existence of this map allows cut-and-paste of non-Ansi text.

Constructor Detail

TrueTypeFontProperties

public TrueTypeFontProperties()
Default constructor.


TrueTypeFontProperties

public TrueTypeFontProperties(int characterRange,
                              int embeddingRules,
                              boolean includeMap)
Default constructor.

Method Detail

getCharacterRange

public int getCharacterRange()
Get the CharacterRange value, which specifies the range that the characters that make up document text will occupy. Possible values include AUTO_DETECT (which leaves the detection up to ServerReport), ANSI (for character codes in the range 0-255) and UNICODE (for character codes in the range 0-65536).

Returns:
the characterRange value, one of AUTO_DETECT, ANSI or UNICODE.

setCharacterRange

public void setCharacterRange(int characterRange)
Set the CharacterRange value, which specifies the range that the characters that make up document text will occupy. Possible values include AUTO_DETECT (which leaves the detection up to ServerReport), ANSI (for character codes in the range 0-255) and UNICODE (for character codes in the range 0-65536).

Parameters:
characterRange - the characterRange value, one of AUTO_DETECT, ANSI or UNICODE.

getEmbeddingRules

public int getEmbeddingRules()
Get the rules for embedding a related true type font within the generated document (e.g. PDF) file.

Returns:
the embedding rules value, one of DO_NOT_EMBED, EMBED_NEEDED or EMBED_ENTIRE_FONT.

setEmbeddingRules

public void setEmbeddingRules(int embeddingRules)
Set the rules for embedding a related true type font within the generated document (e.g. PDF) file.

Parameters:
embeddingRules - the embedding rules value, one of DO_NOT_EMBED, EMBED_NEEDED or EMBED_ENTIRE_FONT.

getIncludeUnicodeMap

public boolean getIncludeUnicodeMap()
Get the value of the IncludeUnicodeMap property, which determines whether output (e.g. a PDF File) should contain a glyph-to-unicode map. The existence of this map allows cut-and-paste of non-Ansi text.

Returns:
true if output should contain a glyph-to-unicode map; false otherwise.

setIncludeUnicodeMap

public void setIncludeUnicodeMap(boolean includeMap)
Set the value of the IncludeUnicodeMap property, which determines whether output (e.g. a PDF File) should contain a glyph-to-unicode map. The existence of this map allows cut-and-paste of non-Ansi text.

Parameters:
includeMap - true if output should contain a glyph-to-unicode map; false otherwise.

Copyright © 2004 Quest Software Inc..
All rights reserved.