se.entra.phantom.client

Class FontManager

java.lang.Object

se.entra.phantom.client.FontManager

public class FontManager
extends Object

The font manager keeps a cache of the different fonts used by controls. It also supports font substitution.

The following fonts are used on the client. Font index 0 is the default font.

   Java name      Index   Windows        OS/2
   -------------  ------  -------------  ---------------------------
   Dialog           0     System         System Proportional
   Monospaced       1     Courier New    Courier
   SansSerif        2     MS Sans Serif  Helv
   Serif            3     MS Serif       Tms Rmn
   Monospaced       4     Fixedsys       System Monospaced
   Monospaced       5     Terminal       System VIO
   Dialog           6     System         System Proportional Non-ISO
 

The Java fonts may not exist, so the following table maps the names to other fonts when the client is started:

   Name         Alternate(s)
   -----------  ---------------------------------
   Dialog       DialogInput, SansSerif, Helvetica
   Monospaced   Courier
   SansSerif    Helvetica
   Serif        TimesRoman
 

The font substitution is done on the Server in the "server.ini" file under the section [FontSubstitution].

Each font substitution is done with the point size, a space, and the font index (0-6). After the equal sign, specify point size, a space and then font name. Several such font entries may be specified separated by a comma. The client will try to find the matching font, and if found this one will be used instead of the normal font.

Field Summary

Fields

Modifier and Type	Field and Description
Font	DEFAULT The default font.

Constructor Summary

Constructors

Constructor and Description
FontManager() Constructs a font manager.

Method Summary

Modifier and Type	Method and Description
void	getAllFontMetrics(Transaction t) Adds the entire font metrics
Font	getBGFont(int index) Returns the correct font for the Business Graphics (BG) control.
Font	getFont(int index) Gets a font from the cache or creates one.
int	getFontAscent(FontMetrics fm) Gets the font ascent.
int	getFontDescent(FontMetrics fm) Gets the font descent.
int	getFontHeight(FontMetrics fm) Gets the font height.
int	getFontHeightOffset(int index) Get font substitution font height offset.
double	getImageScale() Gets the image scaling factor.
static FontManager	getInstance() Gets the default instance used for the Client.
int	getLowerCaseAverageCharWidth(FontMetrics fm) Computes the dialog average character width that Phantom uses as dialog coordinates.
double	getRatioX() Gets the ratio X font value.
double	getRatioY() Gets the ratio Y font value.
double	getScaling() Gets the scaling to use, dependent of if factor or scale is used.
void	init(ImageManager imageManager) Initializes the Image Manager with scaling according to fonts.
void	initFont(int scale, boolean showMessage, boolean isDesignUI) Initializes the font depending on the FONT parameter of the client.
void	initFont(String fontString) Initializes the font depending on the FONT parameter of the client.
void	initFont(String fontString, boolean showMessage) Initializes the font depending on the FONT parameter of the client.
void	resetFonts() Reset the font substitution.
void	setFontRatio(int xRatio, int yRatio, boolean useRatioScaling) Sets the ratio processing for fonts.
void	substituteFonts(Phantom phantom, Transaction trans) Sets up the font substitution

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public Font DEFAULT

The default font.

Constructor Detail

FontManager

public FontManager()

Constructs a font manager. For the Client, one singleton is used. This constructor is intended for the Editor.

Method Detail

getInstance

public static FontManager getInstance()

Gets the default instance used for the Client.

getFont

public Font getFont(int index)

Gets a font from the cache or creates one.

getFontHeightOffset

public int getFontHeightOffset(int index)

Get font substitution font height offset.

getBGFont

public Font getBGFont(int index)

Returns the correct font for the Business Graphics (BG) control.

getFontHeight

public int getFontHeight(FontMetrics fm)

Gets the font height. This method makes JDK 1.1 and 1.2 (or better) have the same sizes as the one in JDK 1.1.

getFontAscent

public int getFontAscent(FontMetrics fm)

Gets the font ascent. This method makes JDK 1.1 and 1.2 (or better) have the same sizes as the one in JDK 1.1.

getFontDescent

public int getFontDescent(FontMetrics fm)

Gets the font descent. This method makes JDK 1.1 and 1.2 (or better) have the same sizes as the one in JDK 1.1.

getLowerCaseAverageCharWidth

public int getLowerCaseAverageCharWidth(FontMetrics fm)

Computes the dialog average character width that Phantom uses as dialog coordinates.

This value is taken from the string "abcdefghijklmnopqrstuvwxyz 0123456789 MW" average.

Parameters:

fm - The font metrics of the font.

Returns:

Average character width.

resetFonts

public void resetFonts()

Reset the font substitution.

substituteFonts

public void substituteFonts(Phantom phantom,
                            Transaction trans)

Sets up the font substitution

getAllFontMetrics

public void getAllFontMetrics(Transaction t)

Adds the entire font metrics

setFontRatio

public void setFontRatio(int xRatio,
                         int yRatio,
                         boolean useRatioScaling)

Sets the ratio processing for fonts.

initFont

public void initFont(String fontString)

Initializes the font depending on the FONT parameter of the client. The default is scaling set to the system scaling. A message is logged with the scaling applied.

Valid fontString values are integer values between 50 and 800, meaning a scaling of 50% to 800%.

Parameters:

fontString - The scaling value as an integer string between 50 to 800, zero or null for system scaling.

initFont

public void initFont(String fontString,
                     boolean showMessage)

Initializes the font depending on the FONT parameter of the client. The default is scaling set to the system scaling.

Valid fontString values are integer values between 50 and 800, meaning a scaling of 50% to 800%.

Parameters:

fontString - The scaling value as an integer string between 50 to 800, zero or null for system scaling.

showMessage - Flag to show the potential scaling applied.

initFont

public void initFont(int scale,
                     boolean showMessage,
                     boolean isDesignUI)

Initializes the font depending on the FONT parameter of the client. The default is scaling set to the system scaling.

Valid fontString values are integer values between 50 and 800, meaning a scaling of 50% to 800%.

Parameters:

scale - The scaling value between 50 to 800, zero for system scaling.

showMessage - Flag to show the potential scaling applied.

isDesignUI - Flag for Design UI (Panel Designer), false for Client or Editor itself.

init

public void init(ImageManager imageManager)

Initializes the Image Manager with scaling according to fonts.

getImageScale

public double getImageScale()

Gets the image scaling factor.

Returns:

1.0 for no scaling (never zero), otherwise the scaling factor.

getRatioX

public double getRatioX()

Gets the ratio X font value.

Returns:

1.0 for 100% or no scaling.

getRatioY

public double getRatioY()

Gets the ratio Y font value.

Returns:

1.0 for 100% or no scaling.

getScaling

public double getScaling()

Gets the scaling to use, dependent of if factor or scale is used.

Returns:

The scaling, 1.0 for none.