TerminalSettings (NetPhantom® 7.7 Java API Specification)

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

```
public class TerminalSettings
extends Object
```
This class is the storage class for terminal settings. These settings are set individually on per-user basis.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`areKeyHotSpotsEnabled` If send key hot spots are enabled.
`boolean`	`areLinksEnabled` If links hot spots are enabled.
`HostColors`	`colors` The host colors (or null when not set).
`Rectangle`	`currentWindowBounds` The current window bounds.
`int`	`cursorHeight` The cursor size in % of font height (1-100).
`int`	`cursorHeightInsertMode` The cursor size in % of font height (1-100) when in insert mode.
`int`	`cutCopyParsing` The type of Cut/Copy parsing.
`boolean`	`doAntiAlias` Flag for anti-aliasing.
`boolean`	`doKeepAspectRatio` Flag for font keep aspect ratio.
`boolean`	`doKeyboardAutoReset` If keyboard auto-reset is enabled.
`boolean`	`dontOutlinePresentationSpace` Flag indicating outlining of presentation space (default).
`boolean`	`doPasteTextWrapping` Flag indicating that text should be pasted with wrap.
`boolean`	`doPromptOnParse` Prompting required on each parse operation.
`boolean`	`doRuleCursor` Rule cursor is to be shown.
`boolean`	`doSaveOriginalFieldSpacing` Flag indicating if original field spacing should be kept.
`String`	`fontName` Font name (null = default).
`int`	`fontSize` Font size (0 = auto-size, default).
`static String`	`hexes` Hex characters.
`boolean`	`is3270BoxDrawingEnabled` If 3270 box drawing is enabled.
`boolean`	`isBoldFont` Flag indicating bold font.
`boolean`	`isCursorNonBlinking` Flag indicating non-blinking cursor.
`boolean`	`isEditor` If this is an editor instance.
`boolean`	`isHostAlarmEnabled` Host alarm active or not.
`boolean`	`isPCInsertModeEnabled` If PC Insert mode is enabled.
`boolean`	`isSmartInsertModeEnabled` If Smart Insert mode is enabled.
`boolean`	`isTypeAheadEnabled` The type-ahead flag.
`KeyboardRemapper`	`keyboardRemapper` The keyboard mapper (or null for none).
`String`	`keyHotSpotStrings` The table of key hot spots strings (HLLAPI send code, space, comma separated strings), items in list separated by '\|'.
`String`	`linkTexts` The table of links texts.
`int`	`ruleCursorLineStyle` Line style of rule cursor.
`int`	`ruleCursorOrientation` Orientation of rule cursor.
`Rectangle`	`windowBounds` The window bounds.

Constructor Summary

Constructors
Constructor and Description

TerminalSettings()

Constructors
Constructor and Description
`TerminalSettings()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClientSetup(Transaction trans)` Gets the client transaction for the setup.
`String`	`getClientSetupString()` Gets the client string for the setup.
`void`	`getColors(String clr)` Get host color mappings from a string.
`void`	`getProperties(Hashtable<String,String> table)` Gets the terminal settings from the properties in the client.
`void`	`getProperties(IniFile ini)` Gets the properties table from the [host] section of the INI file and initialized them.
`int`	`mapToSendKey(int key, boolean isShift, boolean isControl, boolean isAlt)` The keyboard mapper.
`void`	`saveProperties(Hashtable<String,String> table)` Saves the properties from the variable settings in this class.
`static void`	`saveProperties(Hashtable<String,String> ht, IniFile ini)` Saves the properties to the INI file.

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

- Field Detail
  - hexes
```
public static final String hexes
```
    Hex characters.
    
    See Also:
    
    Constant Field Values
  - currentWindowBounds
```
public final Rectangle currentWindowBounds
```
    The current window bounds. This rectangle is updated each time the mark selection is retrieved.
  - windowBounds
```
public Rectangle windowBounds
```
    The window bounds.
  - cutCopyParsing
```
public int cutCopyParsing
```
    The type of Cut/Copy parsing. 0 = Parse data on field boundaries (default), 1 = Parse data on word boundaries, 2 = Do not parse, data only.
  - doPromptOnParse
```
public boolean doPromptOnParse
```
    Prompting required on each parse operation.
  - doSaveOriginalFieldSpacing
```
public boolean doSaveOriginalFieldSpacing
```
    Flag indicating if original field spacing should be kept.
  - doPasteTextWrapping
```
public boolean doPasteTextWrapping
```
    Flag indicating that text should be pasted with wrap.
  - cursorHeight
```
public int cursorHeight
```
    The cursor size in % of font height (1-100).
  - cursorHeightInsertMode
```
public int cursorHeightInsertMode
```
    The cursor size in % of font height (1-100) when in insert mode.
  - isCursorNonBlinking
```
public boolean isCursorNonBlinking
```
    Flag indicating non-blinking cursor.
  - dontOutlinePresentationSpace
```
public boolean dontOutlinePresentationSpace
```
    Flag indicating outlining of presentation space (default).
  - doRuleCursor
```
public boolean doRuleCursor
```
    Rule cursor is to be shown.
  - ruleCursorOrientation
```
public int ruleCursorOrientation
```
    Orientation of rule cursor. 0 = none, 1 = vertical, 2 = horizontal, 3 = both.
  - ruleCursorLineStyle
```
public int ruleCursorLineStyle
```
    Line style of rule cursor. 0 = Solid, 1 = Dot (default), 2 = Single dash, 3 = Double dash, 4 = Triple dash.
  - fontName
```
public String fontName
```
    Font name (null = default).
  - fontSize
```
public int fontSize
```
    Font size (0 = auto-size, default).
  - isBoldFont
```
public boolean isBoldFont
```
    Flag indicating bold font.
  - doAntiAlias
```
public boolean doAntiAlias
```
    Flag for anti-aliasing.
  - doKeepAspectRatio
```
public boolean doKeepAspectRatio
```
    Flag for font keep aspect ratio.
  - colors
```
public HostColors colors
```
    The host colors (or null when not set).
  - keyboardRemapper
```
public KeyboardRemapper keyboardRemapper
```
    The keyboard mapper (or null for none).
  - isTypeAheadEnabled
```
public boolean isTypeAheadEnabled
```
    The type-ahead flag.
  - isHostAlarmEnabled
```
public boolean isHostAlarmEnabled
```
    Host alarm active or not.
  - doKeyboardAutoReset
```
public boolean doKeyboardAutoReset
```
    If keyboard auto-reset is enabled.
  - is3270BoxDrawingEnabled
```
public boolean is3270BoxDrawingEnabled
```
    If 3270 box drawing is enabled.
  - isSmartInsertModeEnabled
```
public boolean isSmartInsertModeEnabled
```
    If Smart Insert mode is enabled.
  - isPCInsertModeEnabled
```
public boolean isPCInsertModeEnabled
```
    If PC Insert mode is enabled.
  - areLinksEnabled
```
public boolean areLinksEnabled
```
    If links hot spots are enabled.
  - linkTexts
```
public String linkTexts
```
    The table of links texts.
  - areKeyHotSpotsEnabled
```
public boolean areKeyHotSpotsEnabled
```
    If send key hot spots are enabled.
  - keyHotSpotStrings
```
public String keyHotSpotStrings
```
    The table of key hot spots strings (HLLAPI send code, space, comma separated strings), items in list separated by '|'.
  - isEditor
```
public boolean isEditor
```
    If this is an editor instance.
- Constructor Detail
  - TerminalSettings
```
public TerminalSettings()
```
- Method Detail
  - getProperties
```
public void getProperties(IniFile ini)
```
    Gets the properties table from the [host] section of the INI file and initialized them.
  - getColors
```
public void getColors(String clr)
```
    Get host color mappings from a string.
    
    Parameters:
    
    clr - hex decoded string
  - getProperties
```
public void getProperties(Hashtable<String,String> table)
```
    Gets the terminal settings from the properties in the client.
  - getClientSetupString
```
public String getClientSetupString()
```
    Gets the client string for the setup.
  - addClientSetup
```
public void addClientSetup(Transaction trans)
```
    Gets the client transaction for the setup.
  - saveProperties
```
public static void saveProperties(Hashtable<String,String> ht,
                                  IniFile ini)
```
    Saves the properties to the INI file. The INI file itself is not saved.
  - saveProperties
```
public void saveProperties(Hashtable<String,String> table)
```
    Saves the properties from the variable settings in this class.
  - mapToSendKey
```
public int mapToSendKey(int key,
                        boolean isShift,
                        boolean isControl,
                        boolean isAlt)
```
    The keyboard mapper. It maps a VirtualKey (java.awt.event.KeyEvent.VK_*) to a se.entra.phantom.common.TerminalKeys.KEY_*.
    
    Returns:
    
    phantomSendKey the send key used by HostSession.sendKey.
    -1 for no valid send key.

Class TerminalSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

hexes

currentWindowBounds

windowBounds

cutCopyParsing

doPromptOnParse

doSaveOriginalFieldSpacing

doPasteTextWrapping

cursorHeight

cursorHeightInsertMode

isCursorNonBlinking

dontOutlinePresentationSpace

doRuleCursor

ruleCursorOrientation

ruleCursorLineStyle

fontName

fontSize

isBoldFont

doAntiAlias

doKeepAspectRatio

colors

keyboardRemapper

isTypeAheadEnabled

isHostAlarmEnabled

doKeyboardAutoReset

is3270BoxDrawingEnabled

isSmartInsertModeEnabled

isPCInsertModeEnabled

areLinksEnabled

linkTexts

areKeyHotSpotsEnabled

keyHotSpotStrings

isEditor

Constructor Detail

TerminalSettings

Method Detail

getProperties

getColors

getProperties

getClientSetupString

addClientSetup

saveProperties

saveProperties

mapToSendKey