FontSubstitution (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.FontSubstitution

public class FontSubstitution
extends Object

FontSubstitution class.

Constructor Summary

Constructors
Constructor and Description

FontSubstitution()
Constructor that creates the Transaction to the client that is used for font substitution.

Constructors
Constructor and Description
`FontSubstitution()` Constructor that creates the Transaction to the client that is used for font substitution.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addItem(String item, String value)` Adds a new font substitution item (e.g.
`static boolean`	`createClient(IniFile ini)` Create (eventually) list of client specific FontSubstitutions.
`static boolean`	`createDefault(IniFile ini)` Create the default FontSubstitution.
`static boolean`	`createFontSubstitution(IniFile serverIni)` Create method that initiates all static FontSubstitutions.
`static FontSubstitution`	`getDefaultSubstitution()` The default font substitution.
`byte[]`	`getFontMetrics()` The binary array of special font metrics (null for none).
`static String`	`getFsNameList()` The static string that contain a list of font substitutions.
`int`	`getIsApplet()` Applet flag, -1=doesn't matter, 0=not browser, 1=is browser.
`String`	`getJavaVendor()` Java vendor name for compare with client.
`int`	`getJavaVendorWild()` javaVendor wild card position, or -1 if none.
`String`	`getJavaVersion()` Java version name for compare with client.
`int`	`getJavaVersionWild()` javaVersion wild card position, or -1 if none.
`String`	`getOsName()` OS name for compare with client.
`int`	`getOsNameWild()` OS name wild card position, or -1 if none.
`String`	`getOsVersion()` OS version name for compare with client.
`int`	`getOsVersionWild()` osVersion wild card position, or -1 if none.
`static ArrayList<FontSubstitution>`	`getSubstitutions()` The static array of created client type font substitutions.
`Transaction`	`getTransaction()` Instance method to actually get this FontSubstitution's transaction.
`static void`	`setDefaultSubstitution(FontSubstitution defaultSubstitution)` The default font substitution.
`void`	`setFontMetrics(byte[] fontMetrics)` The binary array of special font metrics (null for none).
`static void`	`setFsNameList(String fsNameList)` The static string that contain a list of font substitutions.
`void`	`setIsApplet(int isApplet)` Applet flag, -1=doesn't matter, 0=not browser, 1=is browser.
`void`	`setJavaVendor(String javaVendor)` Java vendor name for compare with client.
`void`	`setJavaVendorWild(int javaVendorWild)` javaVendor wild card position, or -1 if none.
`void`	`setJavaVersion(String javaVersion)` Java version name for compare with client.
`void`	`setJavaVersionWild(int javaVersionWild)` javaVersion wild card position, or -1 if none.
`void`	`setOsName(String osName)` OS name for compare with client.
`void`	`setOsNameWild(int osNameWild)` OS name wild card position, or -1 if none.
`void`	`setOsVersion(String osVersion)` OS version name for compare with client.
`void`	`setOsVersionWild(int osVersionWild)` osVersion wild card position, or -1 if none.
`void`	`terminate()` Terminate the transaction when all items are added.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FontSubstitution
```
public FontSubstitution()
```
    Constructor that creates the Transaction to the client that is used for font substitution. This is used by the server.ini when the [FontSubstitution] section is loaded, but can also be used to create custom settings for a particular client connection. Once the font substitution object is initialized with the method addItem, the terminate method should be called. Subsequent calls to addItem will throw an IOException! If terminate is not called, this will be done automatically.
- Method Detail
  - getSubstitutions
```
public static ArrayList<FontSubstitution> getSubstitutions()
```
    The static array of created client type font substitutions.
    
    Returns:
    
    the substitutions vector,
  - getDefaultSubstitution
```
public static FontSubstitution getDefaultSubstitution()
```
    The default font substitution.
    
    Returns:
    
    the defaultSubstitution
  - setDefaultSubstitution
```
public static void setDefaultSubstitution(FontSubstitution defaultSubstitution)
```
    The default font substitution.
    
    Parameters:
    
    defaultSubstitution - the defaultSubstitution to set
  - getFsNameList
```
public static String getFsNameList()
```
    The static string that contain a list of font substitutions. This string is used at startup. It is comma separated or null if not yet set.
    
    Returns:
    
    the fsNameList
  - setFsNameList
```
public static void setFsNameList(String fsNameList)
```
    The static string that contain a list of font substitutions. This string is used at startup. It is comma separated or null if not yet set.
    
    Parameters:
    
    fsNameList - the fsNameList to set
  - createFontSubstitution
```
public static boolean createFontSubstitution(IniFile serverIni)
                                      throws IOException
```
    Create method that initiates all static FontSubstitutions. This method uses the server.ini file to initiate a default font substitution and eventually a list of client specific font substitutions.
    This method is thread safe in combination with appendTransaction.
    
    Throws:
    
    IOException
  - createDefault
```
public static boolean createDefault(IniFile ini)
                             throws IOException
```
    Create the default FontSubstitution.
    
    Throws:
    
    IOException
  - createClient
```
public static boolean createClient(IniFile ini)
                            throws IOException
```
    Create (eventually) list of client specific FontSubstitutions.
    
    Throws:
    
    IOException
  - getJavaVersion
```
public String getJavaVersion()
```
    Java version name for compare with client. No compare when this string is null.
    
    Returns:
    
    the javaVersion
  - setJavaVersion
```
public void setJavaVersion(String javaVersion)
```
    Java version name for compare with client. No compare when this string is null.
    
    Parameters:
    
    javaVersion - the javaVersion to set
  - getJavaVersionWild
```
public int getJavaVersionWild()
```
    javaVersion wild card position, or -1 if none.
    
    Returns:
    
    the javaVersionWild
  - setJavaVersionWild
```
public void setJavaVersionWild(int javaVersionWild)
```
    javaVersion wild card position, or -1 if none.
    
    Parameters:
    
    javaVersionWild - the javaVersionWild to set
  - getJavaVendor
```
public String getJavaVendor()
```
    Java vendor name for compare with client. No compare when this string is null.
    
    Returns:
    
    the javaVendor
  - setJavaVendor
```
public void setJavaVendor(String javaVendor)
```
    Java vendor name for compare with client. No compare when this string is null.
    
    Parameters:
    
    javaVendor - the javaVendor to set
  - getJavaVendorWild
```
public int getJavaVendorWild()
```
    javaVendor wild card position, or -1 if none.
    
    Returns:
    
    the javaVendorWild
  - setJavaVendorWild
```
public void setJavaVendorWild(int javaVendorWild)
```
    javaVendor wild card position, or -1 if none.
    
    Parameters:
    
    javaVendorWild - the javaVendorWild to set
  - getOsName
```
public String getOsName()
```
    OS name for compare with client. No compare when this string is null.
    
    Returns:
    
    the osName
  - setOsName
```
public void setOsName(String osName)
```
    OS name for compare with client. No compare when this string is null.
    
    Parameters:
    
    osName - the osName to set
  - getOsNameWild
```
public int getOsNameWild()
```
    OS name wild card position, or -1 if none.
    
    Returns:
    
    the osNameWild
  - setOsNameWild
```
public void setOsNameWild(int osNameWild)
```
    OS name wild card position, or -1 if none.
    
    Parameters:
    
    osNameWild - the osNameWild to set
  - getOsVersion
```
public String getOsVersion()
```
    OS version name for compare with client. No compare when this string is null.
    
    Returns:
    
    the osVersion
  - setOsVersion
```
public void setOsVersion(String osVersion)
```
    OS version name for compare with client. No compare when this string is null.
    
    Parameters:
    
    osVersion - the osVersion to set
  - getOsVersionWild
```
public int getOsVersionWild()
```
    osVersion wild card position, or -1 if none.
    
    Returns:
    
    the osVersionWild
  - setOsVersionWild
```
public void setOsVersionWild(int osVersionWild)
```
    osVersion wild card position, or -1 if none.
    
    Parameters:
    
    osVersionWild - the osVersionWild to set
  - getIsApplet
```
public int getIsApplet()
```
    Applet flag, -1=doesn't matter, 0=not browser, 1=is browser.
    
    Returns:
    
    the isApplet
  - setIsApplet
```
public void setIsApplet(int isApplet)
```
    Applet flag, -1=doesn't matter, 0=not browser, 1=is browser.
    
    Parameters:
    
    isApplet - the isApplet to set
  - getFontMetrics
```
public byte[] getFontMetrics()
```
    The binary array of special font metrics (null for none). The format is the same as the one used when client font metrics are used. Once the call to the method terminate is called, this value is set to null.
    
    Returns:
    
    the fontMetrics
  - setFontMetrics
```
public void setFontMetrics(byte[] fontMetrics)
```
    The binary array of special font metrics (null for none). The format is the same as the one used when client font metrics are used. Once the call to the method terminate is called, this value is set to null.
    
    Parameters:
    
    fontMetrics - the fontMetrics to set
  - addItem
```
public boolean addItem(String item,
                       String value)
                throws IOException
```
    Adds a new font substitution item (e.g. from the INI file or programmatically). If the "item" parameter is set to "FONTMETRICS" (case insensitive), the "value" parameter will be used to load a "font metrics file created e.g. in the Server Administration Program).
    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
 
```
    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.
    Syntax:
```
   PointSize(4-255)[Styles] FontIndex(0-6) =
         PointSize1[Styles] FontName1[:heightDiff1]
      [, PointSize2[Styles] FontName2[:heightDiff2]]
      [, ...etc...]
 
```
    where [Styles] (note: directly after point size without space) can be:
```
   B    Bold
   I    Italic
   BI   Bold and Italic
 
```
    The [:heightDiff] is optional and causes the height of the font to be adjusted by the number specified with heightDiff as pixels (the number may be negative). This new font height is only used by listboxes and is intended to make a perfect match for a font under Windows environment with a font for the NetPhantom Client.
    Example: map Monospaced Bold 10 to Monospaced/Courier Bold Italic 8:
    10B 1 = 8BI Monospaced, 8BI Courier
    Returns:
    
    true for OK, false for failure.
    
    Throws:
    
    IOException - for format errors in the value String parameter.
  - terminate
```
public void terminate()
```
    Terminate the transaction when all items are added.
  - getTransaction
```
public Transaction getTransaction()
```
    Instance method to actually get this FontSubstitution's transaction.

Class FontSubstitution

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FontSubstitution

Method Detail

getSubstitutions

getDefaultSubstitution

setDefaultSubstitution

getFsNameList

setFsNameList

createFontSubstitution

createDefault

createClient

getJavaVersion

setJavaVersion

getJavaVersionWild

setJavaVersionWild

getJavaVendor

setJavaVendor

getJavaVendorWild

setJavaVendorWild

getOsName

setOsName

getOsNameWild

setOsNameWild

getOsVersion

setOsVersion

getOsVersionWild

setOsVersionWild

getIsApplet

setIsApplet

getFontMetrics

setFontMetrics

addItem

terminate

getTransaction