All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.hi.customizer.beans.CustomTerminal

com.ibm.hi.customizer.beans.CustomTerminal

public final class CustomTerminal
implements FocusListener, HelpListener
CustomTerminal is a Bean which displays 3270, 5250, and CICS host data. CustomTerminal can also be used in conjunction with custom screen maps created using Screen Customizer. The CustomTerminal Bean also incorporates the Operator Information Area (OIA) that can be turned on or off by the oiaVisible boolean property.

CustomTerminal is sensitive to both the session type and code page and has a different behavior for the different session types and for single-byte, double-byte, and bi-directional codePages. The OIA of CustomTerminal also displays different information based on the session type and code page.

The CustomTerminal Bean has a set of public properties that can be accessed through the standard bean accessor methods. For example, CustomTerminal has a sessionType property that affects its display of host data. The sessionType property is read and write and correspondingly has a getSessionType() method and a setSessionType() method that provide access to the property.

The properties can also be initialized when the bean is constructed using a java.util.Properties object with the appropriate keyword/value pairs. In the java.util.Properties object, the keyword for properties is the same as the property name. The keyword for the sessionType property is "sessionType". The valid values are determined by the property type. The sessionType property is an enumeration for which the valid values are "1" for 3270, "2" for 5250, and "4" for CICS.

Properties

The following table lists the properties of the CustomTerminal Bean:

* - Properties with type "enum" are String types that accept a specific set of string values. The valid values for an enum property can be obtained by calling the list <property name> method. The set method for enum properties validates the value before any changes are accepted, and a PropertyVetoException is thrown if an incorrect value is given.

Note: All properties are bound and vetoable. A PropertyChangeEvent is fired to all PropertyChangeListeners after a property is changed. A vetoable PropertyChangeEvent is fired to all VetoableChangeListeners before a property is changed. VetoableChangeListeners can veto a property change by throwing a PropertyVetoException.

Property Name Type Default Access
accessibilityEnabled boolean false read/write
autoConnect boolean See Session.autoConnect read/write
autoReconnect boolean See Session.autoReconnect read/write
CICSGWCodePage enum* See Session.CICSGWCodePage read/write
CICSServerName String See Session.CICSServerName read/write
codePage enum* See Session.codePage read/write
customDir String custom read/write
customURL String read/write
DBCSInputVisible boolean false read/write
fontName enum* Monospaced read/write
fontSize int 12 read/write
fontStyle enum* java.awt.Font.PLAIN read/write
get2PointEnabled boolean true read/write
host String See Session.host read/write
hostModeTabEnabled boolean false read/write
hotspotsEnabled boolean true read/write
hotspotsTabEnabled boolean false read/write
imageButtonStyle enum* CustomTerminal.STANDARD_BUTTON_STYLE read/write
lightPenMode boolean false read/write
lookupFile String lookup.xml read/write
LUName String See Session.LUName read/write
LUMPort int See Session.LUMPort read/write
LUMLicensing String See Session.LUMLicensing read/write
LUMServer String See Session.LUMServer read/write
mapEnabled boolean true read/write
menuButtonsEnabled boolean true read/write
menuButtonStyle enum* CustomTerminal.DYNAMIC_BUTTON_STYLE read/write
menuButtonsTabEnabled boolean false read/write
numeralShape enum* See Session.NumeralShape read/write
numericSwapEnabled boolean See Session.numericSwapEnabled read/write
OIAVisible boolean true read/write
port int See Session.port read/write
screenSize enum* See Session.screenSize read/write
serviceMgrHost String See Session.serviceMgrHost read/write
sessionID String See Session.sessionID read/write
sessionName String See Session.sessionName read/write
sessionType enum* See Session.sessionType read/write
SLPAS400Name String See Session.SLPAS400Name read/write
SLPEnabled boolean See Session.SLPEnabled read/write
SLPMaxWaitTime int See Session.SLPMaxWaitTime read/write
SLPScope String See Session.SLPScope read/write
SLPThisScopeOnly boolean See Session.SLPThisScopeOnly read/write
SOSIVisible boolean false read/write
SSL boolean See Session.SSL read/write
SSLTelnetNegotiated boolean See Session.SSLTelnetNegotiated read/write
SSLServerAuthentication boolean See Session.SSLServerAuthentication read/write
SSLCertificatePassword String See Session.SSLCertificatePassword write
SSLCertificatePrompted boolean See Session.SSLCertificatePrompted read/write
SSLCertificateProvided boolean See Session.SSLCertificateProvided read/write
SSLCertificateRemembered boolean See Session.SSLCertificateRemembered read/write
SSLCertificateURL String See Session.SSLCertificateURL read/write
symmetricSwapEnabled boolean See Session.SymmetricSwapEnabled read/write
template String read/write
textOrientation enum* See Session.TextOrientation read/write
textType enum* See Session.TextType read/write
ThaiDisplayMode int See Session.ThaiDisplayMode read/write
TNEnhanced boolean See Session.TNEnhanced read/write
validValueButtonStyle enum* CustomTerminal.STANDARD_BUTTON_STYLE read/write
webLinkButtonStyle enum* CustomTerminal.STANDARD_BUTTON_STYLE read/write
workstationID String See Session.workstationID read/write

Events Fired

Event Type Fired To Event Handler Method
SendKeyEvent - Fired when CustomTerminal receives a keystroke. CustomTerminal also acts as a concentrator for SendKeyEvents--it refires SendKeyEvents that are fired to it from any of the other Beans such as KeyRemap or KeyPad, regardless of the number of java.awt.event.KeyListeners. Contains the keystroke or function formatted as an ECLPS.SendKeys() style mnemonic keyword. Any SendKeyListener, sendKeys(SendKeyEvent)
CustomEvent - Fired when CustomTerminal events need to be handled by external listeners. These include screen events, status events, and macro events. Any CustomListener CustomScreenEvent(CustomScreenEvent) CustomMacroEvent(CustomMacroEvent) CustomStatusEvent(CustomStatusEvent)
KeyEvent - Standard Java awt event fired when CustomTerminal has focus and any key on the keyboard is pressed. KeyRemap keyPressed(java.awt.event.KeyEvent)
keyReleased(java.awt.event.KeyEvent)
keyTyped(java.awt.event.KeyEvent)
PropertyChangeEvent - Fired when a property is changed. Any PropertyChangeListener propertyChange(PropertyChangeEvent)
Vetoable PropertyChangeEvent - Fired when a vetoable property is changed. Any VetoableChangeListener vetoableChange(PropertyChangeEvent)

Events Accepted

Event Type Fired From Event Handler Method
SendKeyEvent - Contains the keystroke or function formatted as an ECLPS.SendKeys() style mnemonic keyword. CustomTerminal refires this event to its own SendKeyListeners. KeyRemap, KeyPad sendKeys(SendKeyEvent)
GUIEvent - Fired from CustomTerminal when SendKeys is invoked with a GUI mnemonic, such as [cut]. Any GUIListener GUIEvent(GUIEvent)
PropertyChangeEvent - Fired when a property of the source Bean is changed. Because CustomTerminal is sensitive to the sessionType and codePage properties, it can listen to Property change events of other Beans and sync its own properties to correspond to those of the source Bean. Session propertyChange(PropertyChangeEvent)


Variable Index

 o BALL_BUTTON_STYLE
 o CUSTOM_DIR
 o CUSTOM_URL
 o DBCS_INPUT_VISIBLE
 o DYNAMIC_BUTTON_STYLE
 o FONT_NAME
 o FONT_SIZE
 o FONT_STYLE
 o GET2POINT
 o HOTSPOTS
 o IMAGE_BUTTON_STYLE
 o LABEL_BUTTON_STYLE
 o LIGHTPEN
 o LOOKUP_FILE
 o MAP_ENABLED
 o MENU_BUTTON_STYLE
 o MENU_BUTTONS
 o OIA_VISIBLE
 o SOSI_VISIBLE
 o STANDARD_BUTTON_STYLE
 o TAB_HOSTMODE
 o TAB_HOTSPOTS
 o TAB_MENU_BUTTONS
 o TEMPLATE
 o VALID_VALUE_BUTTON_STYLE
 o WEBLINK_BUTTON_STYLE

Constructor Index

 o CustomTerminal()
Default Constructor
 o CustomTerminal(Properties)
Constructor that takes a Properties object containing the initial property settings.

Method Index

 o addCommListener(CommListener)
See Session.addCommListener()
 o addCustomListener(CustomListener)
Adds a CustomListener.
 o addGUIListener(GUIListener)
See Session.addGUIListener()
 o addKeyListener(KeyListener)
Adds a java.awt.event.KeyListener to the Bean.
 o addOIAListener(OIAListener)
See Session.addOIAListener()
 o addPropertyChangeListener(PropertyChangeListener)
Adds a PropertyChangeListener.
 o addPSListener(PSListener)
See Session.addPSListener()
 o addSendKeyListener(SendKeyListener)
Adds a SendKeyListener.
 o addTraceListener(TraceListener)
See Session.addTraceListener()
 o addVetoableChangeListener(VetoableChangeListener)
Adds a VetoableChangeListener.
 o copyAllToClipboard()
Copies all text to the clipboard.
 o copyToClipboard()
Copies the current selected text to the clipboard.
 o cutToClipboard()
Cuts the current selected text to the clipboard.
 o defaults()
Returns a Properties object containing the default properties for this Bean.
 o dispose()
Disposes CustomTerminal and all of its resources.
 o doFontDecrease()
Decreases the font by one point size.
 o doFontIncrease()
Increases the font by one point size.
 o doValidValues()
Show the valid values for the current text field.
 o doValidValuesMenu()
 o doWhatIsIt()
Show the help for the current text field.
 o focusLost(FocusEvent)
 o getAllGlobalVariables()
Returns all global variables in the form of a Properties object.
 o getBalls()
Returns an array of all SCBall objects on the current screen.
 o getButtons()
Returns an array of all SCButton objects on the current screen.
 o getButtonVVs()
Returns an array of all SCButtonVV objects on the current screen.
 o getCheckboxes()
Returns an array of all SCCheckbox objects on the current screen.
 o getChoices()
Returns an array of all SCChoice objects on the current screen.
 o getCICSGWCodePage()
See Session.getCICSGWCodePage()
 o getCICSServerName()
See Session.getCICSServerName()
 o getCodePage()
See Session.getCodePage()
 o getColumns()
Returns the number of columns represented on the screen.
 o getCommStatus()
See Session.getCommStatus()
 o getCustomComponents()
Returns an array of all Custom Components on the current screen.
 o getCustomDir()
Returns the customDir property set by setCustomDir().
 o getCustomURL()
Returns the customURL property set by setCustomURL().
 o getDeviceName()
See Session.getDeviceName()
 o getECLSession()
See Session.getECLSession()
 o getFieldKeyMacro()
 o getFont()
Returns the current CustomTerminal font.
 o getFontName()
Returns the value of the fontName property.
 o getFontSize()
Returns the value of the fontSize property.
 o getFontStyle()
Returns the value of the fontStyle property.
 o getFrames()
Returns an array of all SCFrame objects on the current screen.
 o getGlobalVariable(String)
Returns the global variable value mapped to the specified global variable name.
 o getHost()
See Session.getHost()
 o getHostBeforeIPMon()
 o getHostLists()
Returns an array of all SCHostList objects on the current screen.
 o getImageButtons()
Returns an array of all SCImageButton objects on the current screen.
 o getImageButtonStyle()
Returns the image button style.
 o getImages()
Returns an array of all SCImage objects on the current screen.
 o getLabels()
Returns an array of all SCLabel objects on the current screen.
 o getLists()
Returns an array of all SCList objects on the current screen.
 o getLookupFile()
Returns the lookup table name.
 o getLUMLicensing()
See Session.getLUMLicensing()
 o getLUMPort()
See Session.getLUMPort()
 o getLUMServer()
See Session.getLUMServer()
 o getLUName()
See Session.getLUName()
 o getMenuButtonStyle()
Returns the menu button style.
 o getNumeralShape()
See Session.getNumeralShape()
 o getPort()
See Session.getPort()
 o getPortBeforeIPMon()
 o getProperties()
Get the properties for this bean.
 o getRadioButtons()
Returns an array of all SCRadioButton objects on the current screen.
 o getRows()
Returns the number of rows represented on the screen.
 o getScreenID()
Returns the current screen ID.
 o getScreenSize()
See Session.getScreenSize()
 o getServiceMgrHost()
See Session.getServiceMgrHost()
 o getSession()
Returns the Session bean associated with this Terminal
 o getSessionID()
See Session.getSessionID()
 o getSessionName()
See Session.getSessionName()
 o getSessionType()
See Session.getSessionType()
 o getSLPAS400Name()
See Session.getSLPAS400Name()
 o getSLPMaxWaitTime()
See Session.getSLPMaxWaitTime()
 o getSLPScope()
See Session.getSLPScope()
 o getSSLCertificateURL()
See Session.getSSLCertificateURL()
 o getTemplate()
Returns the template property set by setTemplate().
 o getTextfields()
Returns an array of all SCTextfield objects on the current screen.
 o getTextOrientation()
See Session.getTextOrientation()
 o getTextType()
See Session.getTextType()
 o getThaiDisplayMode()
See Session.getThaiDisplayMode()
 o getTraceName()
Returns a trace identifier for this bean.
 o getValidValueButtonStyle()
Returns the valid values button style.
 o getWebLinkButtonStyle()
Returns the web link button style.
 o getWebLinks()
Returns an array of all SCWebLink objects on the current screen.
 o getWorkstationID()
See Session.getWorkstationID()
 o GUIEvent(GUIEvent)
Handler method for GUIEvents.
 o isAccessibilityEnabled()
Returns accessibilityEnabled state.
 o isAutoConnect()
See Session.isAutoConnect()
 o isAutoReconnect()
See Session.isAutoReconnect()
 o isCommStarted()
See Session.isCommStarted()
 o isDBCSInputVisible()
Returns the value of the DBCSInputVisible property.
 o isDeviceNameReady()
See Session.isDeviceNameReady()
 o isFontDecreaseEnabled()
Returns if the font size can be decreased.
 o isFontIncreaseEnabled()
Returns if the font size can be decreased.
 o isGet2PointEnabled()
Returns Get2PointEnabled state.
 o isHostModeTabEnabled()
Returns the host mode tab state.
 o isHotspotsEnabled()
Returns the hotspot enabled state.
 o isHotspotsTabEnabled()
Returns the hotspots tab state.
 o isLightPenMode()
Returns the value of the lightPenMode property.
 o isMapEnabled()
Get map enabled state.
 o isMenuButtonsEnabled()
Returns the menu enabled state.
 o isMenuButtonsTabEnabled()
Returns the menu button tab state.
 o isNumericSwapEnabled()
See Session.isNumericSwapEnabled()
 o isOIAVisible()
Returns the value of the OIAVisible property.
 o isSLPEnabled()
See Session.isSLPEnabled()
 o isSLPThisScopeOnly()
See Session.isSLPThisScopeOnly()
 o isSOSIVisible()
Returns the value of the SOSIVisible property.
 o isSSL()
See Session.isSSL()
 o isSSLCertificatePrompted()
See Session.isSSLCertificatePrompted()
 o isSSLCertificateProvided()
See Session.isSSLCertificateProvided()
 o isSSLCertificateRemembered()
See Session.isSSLCertificateRemembered()
 o isSSLServerAuthentication()
See Session.isSSLServerAuthentication()
 o isSSLTelnetNegotiated()
See Session.isSSLTelnetNegotiated()
 o isSymmetricSwapEnabled()
See Session.isSymmetricSwapEnabled()
 o isTemplateEnabled()
Returns the state of the template.
 o isTNEnhanced()
See Session.isTNEnhanced()
 o isWorkstationIDReady()
See Session.isWorkstationIDReady()
 o listCICSGWCodePages()
See Session.listCICSGWCodePages()
 o listCodePages()
See Session.listCodePages()
 o listCodePages(String)
See Session.listCodePages(java.lang.String)
 o listNumeralShapes()
See Session.listNumeralShapes()
 o listScreenSizes()
See Session.listScreenSizes()
 o listScreenSizes(String)
See Session.listScreenSizes(java.lang.String)
 o listTextOrientations()
See Session.listTextOrientations()
 o listTextTypes()
See Session.listTextTypes()
 o listThaiDisplayModes()
See Session.listThaiDisplayModes()
 o pasteFromClipboard()
Pastes the data from the clipboard at the current cursor location.
 o printPreview()
Displays a preview of the current screen for printing.
 o printScreen()
Prints the current screen contents to the default printer.
 o processCustomEvent(CustomEvent)
Method used to fire CustomEvents.
 o putVarsIntoComponents()
Writes global variables to all components.
 o refresh()
Refreshes the screen.
 o removeCommListener(CommListener)
See Session.removeCommListener()
 o removeCustomListener(CustomListener)
Removes a CustomListener.
 o removeGlobalVariable(String)
Removes the specified global variable.
 o removeGUIListener(GUIListener)
See Session.removeGUIListener()
 o removeKeyListener(KeyListener)
Removes a java.awt.event.KeyListener from the Bean.
 o removeOIAListener(OIAListener)
See Session.removeOIAListener()
 o removePropertyChangeListener(PropertyChangeListener)
Removes a PropertyChangeListener.
 o removePSListener(PSListener)
See Session.removePSListener()
 o removeSendKeyListener(SendKeyListener)
Removes a SendKeyListener.
 o removeTraceListener(TraceListener)
See Session.removeTraceListener()
 o removeVetoableChangeListener(VetoableChangeListener)
Removes a VetoableChangeListener.
 o requestFocus()
Request focus on CustomTerminal.
 o saveSessionInfoBeforeIPMon()
 o selectAll()
Selects the contents of the current text field or label.
 o sendKeys(SendKeyEvent)
Handler method for SendKeyEvents.
 o setAccessibilityEnabled(boolean)
Enable or disable accessibility
 o setAllGlobalVariables(Properties)
Sets all global variables using a specified Properties object.
 o setAutoConnect(boolean)
See Session.setAutoConnect()
 o setAutoReconnect(boolean)
See Session.setAutoReconnect()
 o setCICSGWCodePage(String)
See Session.setCICSGWCodePage()
 o setCICSServerName(String)
See Session.setCICSServerName()
 o setCodePage(String)
See Session.setCodePage()
 o setCustomDir(String)
Sets the customDir property.
 o setCustomURL(String)
Sets the customURL property.
 o setDBCSInputVisible(boolean)
Sets the DBCSInputVisible property (3270 and 5250 DBCS sessions only).
 o setFont(Font)
Sets the CustomTerminal font.
 o setFontName(String)
Sets the fontName property.
 o setFontSize(int)
Sets the fontSize property.
 o setFontStyle(int)
Sets the fontStyle property.
 o setGet2PointEnabled(boolean)
Enable or disable Get2Point macro.
 o setGlobalVariable(String, String)
Sets a specified global variable with a specified value.
 o setHost(String)
See Session.setHost()
 o setHostModeTabEnabled(boolean)
Sets the Host mode tab state.
 o setHotspotsEnabled(boolean)
Enable or disable hotspots.
 o setHotspotsTabEnabled(boolean)
Sets the hotspot tab state.
 o setImageButtonStyle(String)
Set the image button style.
 o setInsertEnabled(boolean)
Set the insert enabled state.
 o setLightPenMode(boolean)
Sets the lightPenMode property (3270 and CICS sessions only).
 o setLookupFile(String)
Sets the lookup table name.
 o setLUMLicensing(String)
See Session.setLUMLicensing(String)
 o setLUMPort(int)
See Session.setLUMPort(int)
 o setLUMServer(String)
See Session.setLUMServer(String)
 o setLUName(String)
See Session.setLUName()
 o setMapEnabled(boolean)
Turn current map on or off.
 o setMenuButtonsEnabled(boolean)
Enable or disable menu buttons.
 o setMenuButtonsTabEnabled(boolean)
Sets the menu button tab state.
 o setMenuButtonStyle(String)
Set the menu button style.
 o setNumeralShape(String)
See Session.setNumeralShape()
 o setNumericSwapEnabled(boolean)
See Session.setNumericSwapEnabled()
 o setOIAVisible(boolean)
Sets the OIAVisible property.
 o setPort(int)
See Session.setPort()
 o setProperties(Properties)
Set the properties on this bean.
 o setScreenSize(String)
See Session.setScreenSize()
 o setServiceMgrHost(String)
See Session.setServiceMgrHost(String)
 o setSessionID(String)
See Session.setSessionID()
 o setSessionName(String)
See Session.setSessionName()
 o setSessionType(String)
Set the Session type.
 o setSLPAS400Name(String)
See Session.setSLPAS400Name()
 o setSLPEnabled(boolean)
See Session.setSLPEnabled()
 o setSLPMaxWaitTime(int)
See Session.setSLPMaxWaitTime()
 o setSLPScope(String)
See Session.setSLPScope()
 o setSLPThisScopeOnly(boolean)
See Session.setSLPThisScopeOnly()
 o setSOSIVisible(boolean)
Sets the SOSIVisible property (3270 and 5250 DBCS sessions only).
 o setSSL(boolean)
See Session.setSSL()
 o setSSLCertificatePassword(String)
See Session.setSSLCertificatePassword()
 o setSSLCertificatePrompted(boolean)
See Session.setSSLCertificatePrompted()
 o setSSLCertificateProvided(boolean)
See Session.setSSLCertificateProvided()
 o setSSLCertificateRemembered(boolean)
See Session.setSSLCertificateRemembered()
 o setSSLCertificateURL(String)
See Session.setSSLCertificateURL()
 o setSSLServerAuthentication(boolean)
See Session.setSSLServerAuthentication()
 o setSSLTelnetNegotiated(boolean)
See Session.setSSLTelnetNegotiated()
 o setSymmetricSwapEnabled(boolean)
See Session.setSymmetricSwapEnabled()
 o setTemplate(String)
Sets the template property.
 o setTextOrientation(String)
See Session.setTextOrientation()
 o setTextType(String)
See Session.setTextType()
 o setThaiDisplayMode(int)
See Session.setThaiDisplayMode
 o setTNEnhanced(boolean)
See Session.setTNEnhanced()
 o setValidValueButtonStyle(String)
Set the valid values button style.
 o setWebLinkButtonStyle(String)
Set the Web-Link button style.
 o setWorkstationID(String)
See Session.setWorkstationID()
 o showColorRemapDialog()
Show the color remap dialog.
 o startCommunication()
See Session.startCommunication()
 o stopCommunication()
See Session.stopCommunication()
 o writeComponentsToVars()
Writes all components to global variables.

Variables

 o STANDARD_BUTTON_STYLE
 public static final String STANDARD_BUTTON_STYLE
 o DYNAMIC_BUTTON_STYLE
 public static final String DYNAMIC_BUTTON_STYLE
 o LABEL_BUTTON_STYLE
 public static final String LABEL_BUTTON_STYLE
 o BALL_BUTTON_STYLE
 public static final String BALL_BUTTON_STYLE
 o FONT_NAME
 public static final String FONT_NAME
 o FONT_STYLE
 public static final String FONT_STYLE
 o FONT_SIZE
 public static final String FONT_SIZE
 o TEMPLATE
 public static final String TEMPLATE
 o HOTSPOTS
 public static final String HOTSPOTS
 o LIGHTPEN
 public static final String LIGHTPEN
 o GET2POINT
 public static final String GET2POINT
 o MENU_BUTTONS
 public static final String MENU_BUTTONS
 o TAB_MENU_BUTTONS
 public static final String TAB_MENU_BUTTONS
 o TAB_HOTSPOTS
 public static final String TAB_HOTSPOTS
 o TAB_HOSTMODE
 public static final String TAB_HOSTMODE
 o MAP_ENABLED
 public static final String MAP_ENABLED
 o MENU_BUTTON_STYLE
 public static final String MENU_BUTTON_STYLE
 o IMAGE_BUTTON_STYLE
 public static final String IMAGE_BUTTON_STYLE
 o WEBLINK_BUTTON_STYLE
 public static final String WEBLINK_BUTTON_STYLE
 o VALID_VALUE_BUTTON_STYLE
 public static final String VALID_VALUE_BUTTON_STYLE
 o OIA_VISIBLE
 public static final String OIA_VISIBLE
 o DBCS_INPUT_VISIBLE
 public static final String DBCS_INPUT_VISIBLE
 o SOSI_VISIBLE
 public static final String SOSI_VISIBLE
 o CUSTOM_URL
 public static final String CUSTOM_URL
 o CUSTOM_DIR
 public static final String CUSTOM_DIR
 o LOOKUP_FILE
 public static final String LOOKUP_FILE

Constructors

 o CustomTerminal
 public CustomTerminal()
Default Constructor

 o CustomTerminal
 public CustomTerminal(Properties newProperties) throws PropertyVetoException
Constructor that takes a Properties object containing the initial property settings. Any properties which are not specified in the Properties object are initialized to their default values.

Parameters:
p - Properties for the Bean.
Throws: PropertyVetoException
Thrown if an incorrect property value is given.

Methods

 o setProperties
 public void setProperties(Properties p) throws PropertyVetoException
Set the properties on this bean.

 o getProperties
 public Properties getProperties()
Get the properties for this bean.

 o defaults
 public static Properties defaults()
Returns a Properties object containing the default properties for this Bean.

See Also:
setProperties
 o dispose
 public void dispose()
Disposes CustomTerminal and all of its resources. This method should be called when the CustomTerminal instance is no longer needed.

 o refresh
 public void refresh()
Refreshes the screen.

 o getScreenID
 public String getScreenID()
Returns the current screen ID. If no ID exists, then null is returned.

 o setMapEnabled
 public void setMapEnabled(boolean enable) throws PropertyVetoException
Turn current map on or off.

 o isMapEnabled
 public boolean isMapEnabled()
Get map enabled state.

 o setGet2PointEnabled
 public void setGet2PointEnabled(boolean enable) throws PropertyVetoException
Enable or disable Get2Point macro.

See Also:
isGet2PointEnabled
 o isGet2PointEnabled
 public boolean isGet2PointEnabled()
Returns Get2PointEnabled state.

See Also:
setGet2PointEnabled
 o setAccessibilityEnabled
 public void setAccessibilityEnabled(boolean enable) throws PropertyVetoException
Enable or disable accessibility

See Also:
isAccessibilityEnabled
 o isAccessibilityEnabled
 public boolean isAccessibilityEnabled()
Returns accessibilityEnabled state.

See Also:
setAccessibilityEnabled
 o setHotspotsEnabled
 public void setHotspotsEnabled(boolean enable) throws PropertyVetoException
Enable or disable hotspots.

See Also:
isHotspotsEnabled
 o isHotspotsEnabled
 public boolean isHotspotsEnabled()
Returns the hotspot enabled state.

See Also:
setHotspotsEnabled
 o setMenuButtonsEnabled
 public void setMenuButtonsEnabled(boolean enable) throws PropertyVetoException
Enable or disable menu buttons.

See Also:
isMenuButtonsEnabled
 o isMenuButtonsEnabled
 public boolean isMenuButtonsEnabled()
Returns the menu enabled state.

See Also:
setMenuButtonsEnabled
 o setMenuButtonStyle
 public void setMenuButtonStyle(String style) throws PropertyVetoException
Set the menu button style.

Valid values:

See Also:
getMenuButtonStyle
 o getMenuButtonStyle
 public String getMenuButtonStyle()
Returns the menu button style.

See Also:
setMenuButtonStyle
 o setImageButtonStyle
 public void setImageButtonStyle(String style) throws PropertyVetoException
Set the image button style.

Valid values:

See Also:
getImageButtonStyle
 o getImageButtonStyle
 public String getImageButtonStyle()
Returns the image button style.

See Also:
setImageButtonStyle
 o setWebLinkButtonStyle
 public void setWebLinkButtonStyle(String style) throws PropertyVetoException
Set the Web-Link button style.

Valid values:

See Also:
getWebLinkButtonStyle
 o getWebLinkButtonStyle
 public String getWebLinkButtonStyle()
Returns the web link button style.

See Also:
setWebLinkButtonStyle
 o setValidValueButtonStyle
 public void setValidValueButtonStyle(String style) throws PropertyVetoException
Set the valid values button style.

Valid values:

See Also:
getValidValueButtonStyle
 o getValidValueButtonStyle
 public String getValidValueButtonStyle()
Returns the valid values button style.

See Also:
setValidValueButtonStyle
 o setHostModeTabEnabled
 public void setHostModeTabEnabled(boolean enable) throws PropertyVetoException
Sets the Host mode tab state. If enabled, you can only tab to the host created input fields and the tab order is defined by the host. If disabled, you can tab to each custom object that is tabbable and tabbing is defined by the screen map.

See Also:
isHostModeTabEnabled, setHotspotsTabEnabled, setMenuButtonsTabEnabled
 o isHostModeTabEnabled
 public boolean isHostModeTabEnabled()
Returns the host mode tab state.

See Also:
setHostModeTabEnabled
 o setHotspotsTabEnabled
 public void setHotspotsTabEnabled(boolean enable) throws PropertyVetoException
Sets the hotspot tab state. If hotspots are enabled and this setting is true, then you can tab to hotspots. Note: This is only valid if host mode tab is disabled.

See Also:
isHotspotsTabEnabled, setHotspotsEnabled, setHostModeTabEnabled
 o isHotspotsTabEnabled
 public boolean isHotspotsTabEnabled()
Returns the hotspots tab state.

See Also:
isHotspotsTabEnabled, setHostModeTabEnabled
 o setMenuButtonsTabEnabled
 public void setMenuButtonsTabEnabled(boolean enable) throws PropertyVetoException
Sets the menu button tab state. If menu buttons are enabled and this setting is true, then you can tab to menu buttons. Note: This is only valid if host mode tab is disabled.

See Also:
isMenuButtonsTabEnabled, setMenuButtonsEnabled, setHostModeTabEnabled
 o isMenuButtonsTabEnabled
 public boolean isMenuButtonsTabEnabled()
Returns the menu button tab state.

See Also:
setMenuButtonsTabEnabled
 o setInsertEnabled
 public void setInsertEnabled(boolean enable)
Set the insert enabled state.

 o addVetoableChangeListener
 public void addVetoableChangeListener(VetoableChangeListener listener)
Adds a VetoableChangeListener. Vetoable PropertyChangeEvents are fired to VetoableChangeListeners before any of Terminal properties are changed. The VetoableChangeListeners can veto a property change by throwing a PropertyVetoException.

See Also:
removeVetoableChangeListener
 o removeVetoableChangeListener
 public void removeVetoableChangeListener(VetoableChangeListener listener)
Removes a VetoableChangeListener.

See Also:
addVetoableChangeListener
 o addPropertyChangeListener
 public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a PropertyChangeListener. PropertyChangeEvents are fired to PropertyChangeListeners after any of Terminal properties are changed.

See Also:
removePropertyChangeListener
 o removePropertyChangeListener
 public void removePropertyChangeListener(PropertyChangeListener listener)
Removes a PropertyChangeListener.

See Also:
addPropertyChangeListener
 o addCommListener
 public void addCommListener(CommListener l)
See Session.addCommListener()

 o addOIAListener
 public void addOIAListener(OIAListener l)
See Session.addOIAListener()

 o addPSListener
 public void addPSListener(PSListener l)
See Session.addPSListener()

 o addGUIListener
 public void addGUIListener(GUIListener l)
See Session.addGUIListener()

 o addTraceListener
 public void addTraceListener(TraceListener l)
See Session.addTraceListener()

 o removeTraceListener
 public void removeTraceListener(TraceListener l)
See Session.removeTraceListener()

 o removeCommListener
 public void removeCommListener(CommListener l)
See Session.removeCommListener()

 o removeOIAListener
 public void removeOIAListener(OIAListener l)
See Session.removeOIAListener()

 o removePSListener
 public void removePSListener(PSListener l)
See Session.removePSListener()

 o removeGUIListener
 public void removeGUIListener(GUIListener l)
See Session.removeGUIListener()

 o startCommunication
 public void startCommunication()
See Session.startCommunication()

 o stopCommunication
 public void stopCommunication()
See Session.stopCommunication()

 o isAutoConnect
 public boolean isAutoConnect()
See Session.isAutoConnect()

 o setAutoConnect
 public void setAutoConnect(boolean autoConnect) throws PropertyVetoException
See Session.setAutoConnect()

 o isAutoReconnect
 public boolean isAutoReconnect()
See Session.isAutoReconnect()

 o setAutoReconnect
 public void setAutoReconnect(boolean autoReconnect) throws PropertyVetoException
See Session.setAutoReconnect()

 o getCICSGWCodePage
 public String getCICSGWCodePage()
See Session.getCICSGWCodePage()

 o setCICSGWCodePage
 public void setCICSGWCodePage(String codePage) throws PropertyVetoException
See Session.setCICSGWCodePage()

 o listCICSGWCodePages
 public Enumeration listCICSGWCodePages()
See Session.listCICSGWCodePages()

 o getCICSServerName
 public String getCICSServerName()
See Session.getCICSServerName()

 o setCICSServerName
 public void setCICSServerName(String server) throws PropertyVetoException
See Session.setCICSServerName()

 o getCodePage
 public String getCodePage()
See Session.getCodePage()

 o setCodePage
 public void setCodePage(String codePage) throws PropertyVetoException
See Session.setCodePage()

 o listCodePages
 public Enumeration listCodePages()
See Session.listCodePages()

 o listCodePages
 public static Enumeration listCodePages(String sessionType)
See Session.listCodePages(java.lang.String)

 o isCommStarted
 public boolean isCommStarted()
See Session.isCommStarted()

 o isDeviceNameReady
 public boolean isDeviceNameReady()
See Session.isDeviceNameReady()

 o isWorkstationIDReady
 public boolean isWorkstationIDReady()
See Session.isWorkstationIDReady()

 o getDeviceName
 public String getDeviceName()
See Session.getDeviceName()

 o getCommStatus
 public int getCommStatus()
See Session.getCommStatus()

 o getHost
 public String getHost()
See Session.getHost()

 o setHost
 public void setHost(String host) throws PropertyVetoException
See Session.setHost()

 o getPort
 public int getPort()
See Session.getPort()

 o setPort
 public void setPort(int port) throws PropertyVetoException
See Session.setPort()

 o isTNEnhanced
 public boolean isTNEnhanced()
See Session.isTNEnhanced()

 o setTNEnhanced
 public void setTNEnhanced(boolean enhanced) throws PropertyVetoException
See Session.setTNEnhanced()

 o getLUName
 public String getLUName()
See Session.getLUName()

 o setLUName
 public void setLUName(String luName) throws PropertyVetoException
See Session.setLUName()

 o getWorkstationID
 public String getWorkstationID()
See Session.getWorkstationID()

 o setWorkstationID
 public void setWorkstationID(String wsID) throws PropertyVetoException
See Session.setWorkstationID()

 o getSessionName
 public String getSessionName()
See Session.getSessionName()

 o setSessionName
 public void setSessionName(String name) throws PropertyVetoException
See Session.setSessionName()

 o getSessionID
 public String getSessionID()
See Session.getSessionID()

 o setSessionID
 public void setSessionID(String ID) throws PropertyVetoException
See Session.setSessionID()

 o getScreenSize
 public String getScreenSize()
See Session.getScreenSize()

 o setScreenSize
 public void setScreenSize(String size) throws PropertyVetoException
See Session.setScreenSize()

 o listScreenSizes
 public Enumeration listScreenSizes()
See Session.listScreenSizes()

 o listScreenSizes
 public Enumeration listScreenSizes(String sessionType)
See Session.listScreenSizes(java.lang.String)

 o getSessionType
 public String getSessionType()
See Session.getSessionType()

 o setSessionType
 public void setSessionType(String type) throws PropertyVetoException
Set the Session type. See Session.setSessionType(). Note that CustomTerminal does not support VT sessions.

 o isSSL
 public boolean isSSL()
See Session.isSSL()

 o setSSL
 public void setSSL(boolean SSL) throws PropertyVetoException
See Session.setSSL()

 o isSSLTelnetNegotiated
 public boolean isSSLTelnetNegotiated()
See Session.isSSLTelnetNegotiated()

 o setSSLTelnetNegotiated
 public void setSSLTelnetNegotiated(boolean tnNegotiated) throws PropertyVetoException
See Session.setSSLTelnetNegotiated()

 o isSSLServerAuthentication
 public boolean isSSLServerAuthentication()
See Session.isSSLServerAuthentication()

 o setSSLServerAuthentication
 public void setSSLServerAuthentication(boolean authentication) throws PropertyVetoException
See Session.setSSLServerAuthentication()

 o isSSLCertificateProvided
 public boolean isSSLCertificateProvided()
See Session.isSSLCertificateProvided()

 o setSSLCertificateProvided
 public void setSSLCertificateProvided(boolean provided) throws PropertyVetoException
See Session.setSSLCertificateProvided()

 o getSSLCertificateURL
 public String getSSLCertificateURL()
See Session.getSSLCertificateURL()

 o setSSLCertificateURL
 public void setSSLCertificateURL(String url) throws PropertyVetoException
See Session.setSSLCertificateURL()

 o setSSLCertificatePassword
 public void setSSLCertificatePassword(String pw) throws PropertyVetoException
See Session.setSSLCertificatePassword()

 o isSSLCertificateRemembered
 public boolean isSSLCertificateRemembered()
See Session.isSSLCertificateRemembered()

 o setSSLCertificateRemembered
 public void setSSLCertificateRemembered(boolean remembered) throws PropertyVetoException
See Session.setSSLCertificateRemembered()

 o setSSLCertificatePrompted
 public void setSSLCertificatePrompted(boolean prompted) throws PropertyVetoException
See Session.setSSLCertificatePrompted()

 o isSSLCertificatePrompted
 public boolean isSSLCertificatePrompted()
See Session.isSSLCertificatePrompted()

 o setSymmetricSwapEnabled
 public void setSymmetricSwapEnabled(boolean state) throws PropertyVetoException
See Session.setSymmetricSwapEnabled()

 o isSymmetricSwapEnabled
 public boolean isSymmetricSwapEnabled()
See Session.isSymmetricSwapEnabled()

 o setNumericSwapEnabled
 public void setNumericSwapEnabled(boolean state) throws PropertyVetoException
See Session.setNumericSwapEnabled()

 o isNumericSwapEnabled
 public boolean isNumericSwapEnabled()
See Session.isNumericSwapEnabled()

 o setNumeralShape
 public void setNumeralShape(String ns) throws PropertyVetoException
See Session.setNumeralShape()

 o getNumeralShape
 public String getNumeralShape()
See Session.getNumeralShape()

 o listNumeralShapes
 public Enumeration listNumeralShapes()
See Session.listNumeralShapes()

 o setTextOrientation
 public void setTextOrientation(String to) throws PropertyVetoException
See Session.setTextOrientation()

 o getTextOrientation
 public String getTextOrientation()
See Session.getTextOrientation()

 o listTextOrientations
 public Enumeration listTextOrientations()
See Session.listTextOrientations()

 o setTextType
 public void setTextType(String tt) throws PropertyVetoException
See Session.setTextType()

 o getTextType
 public String getTextType()
See Session.getTextType()

 o listTextTypes
 public Enumeration listTextTypes()
See Session.listTextTypes()

 o getThaiDisplayMode
 public int getThaiDisplayMode()
See Session.getThaiDisplayMode()

 o setThaiDisplayMode
 public void setThaiDisplayMode(int mode) throws PropertyVetoException
See Session.setThaiDisplayMode

 o listThaiDisplayModes
 public Enumeration listThaiDisplayModes()
See Session.listThaiDisplayModes()

 o isSLPEnabled
 public boolean isSLPEnabled()
See Session.isSLPEnabled()

 o setSLPEnabled
 public void setSLPEnabled(boolean slp) throws PropertyVetoException
See Session.setSLPEnabled()

 o setSLPAS400Name
 public void setSLPAS400Name(String as400name) throws PropertyVetoException
See Session.setSLPAS400Name()

 o getSLPAS400Name
 public String getSLPAS400Name()
See Session.getSLPAS400Name()

 o setSLPScope
 public void setSLPScope(String scope) throws PropertyVetoException
See Session.setSLPScope()

 o getSLPScope
 public String getSLPScope()
See Session.getSLPScope()

 o isSLPThisScopeOnly
 public boolean isSLPThisScopeOnly()
See Session.isSLPThisScopeOnly()

 o setSLPThisScopeOnly
 public void setSLPThisScopeOnly(boolean thisScopeOnly) throws PropertyVetoException
See Session.setSLPThisScopeOnly()

 o getSLPMaxWaitTime
 public int getSLPMaxWaitTime()
See Session.getSLPMaxWaitTime()

 o setSLPMaxWaitTime
 public void setSLPMaxWaitTime(int maxWait) throws PropertyVetoException
See Session.setSLPMaxWaitTime()

 o setOIAVisible
 public void setOIAVisible(boolean showOIA) throws PropertyVetoException
Sets the OIAVisible property. When true CustomTerminal displays the Operator Information Area (OIA).

Parameters:
showOIA - Whether the CustomTerminal shows OIA or not.
Throws: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isOIAVisible
 o isOIAVisible
 public boolean isOIAVisible()
Returns the value of the OIAVisible property.

See Also:
setOIAVisible
 o setDBCSInputVisible
 public void setDBCSInputVisible(boolean showDBCSInput) throws PropertyVetoException
Sets the DBCSInputVisible property (3270 and 5250 DBCS sessions only). When true, Screen displays the DBCS Input field.

Parameters:
showDBCSInput - Whether the Screen shows DBCS Input field or not.
Throws: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isDBCSInputVisible
 o isDBCSInputVisible
 public boolean isDBCSInputVisible()
Returns the value of the DBCSInputVisible property.

See Also:
setDBCSInputVisible
 o setSOSIVisible
 public void setSOSIVisible(boolean showSOSI) throws PropertyVetoException
Sets the SOSIVisible property (3270 and 5250 DBCS sessions only). When true, Screen displays the Shift In/Shift Out characters.

Parameters:
showSOSI - Whether the Screen shows Shift In/Shift Out characters or not.
Throws: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isSOSIVisible
 o isSOSIVisible
 public boolean isSOSIVisible()
Returns the value of the SOSIVisible property.

See Also:
setSOSIVisible
 o doValidValues
 public void doValidValues()
Show the valid values for the current text field.

 o doWhatIsIt
 public void doWhatIsIt()
Show the help for the current text field.

 o doValidValuesMenu
 public void doValidValuesMenu()
 o setLightPenMode
 public void setLightPenMode(boolean enable) throws PropertyVetoException
Sets the lightPenMode property (3270 and CICS sessions only). When true, this property causes the CustomTerminal to enable light pen support.

Parameters:
enable - Whether or not the CustomTerminal enables light pen support.
Throws: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isLightPenMode
 o isLightPenMode
 public boolean isLightPenMode()
Returns the value of the lightPenMode property.

See Also:
setLightPenMode
 o setTemplate
 public void setTemplate(String template) throws PropertyVetoException
Sets the template property. Setting this property will override any template defined in the HTML parameters or defined in a screen map.

Parameters:
template - Template file name.
Throws: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
getTemplate
 o getTemplate
 public String getTemplate()
Returns the template property set by setTemplate().

See Also:
setTemplate
 o isTemplateEnabled
 public boolean isTemplateEnabled()
Returns the state of the template. The state of the template becomes valid after the connection has been established.

See Also:
setTemplate
 o setCustomURL
 public void setCustomURL(String customURL) throws PropertyVetoException
Sets the customURL property. Setting this property will override any customURL defined in the HTML parameters.

Parameters:
CustomURL - Custom URL.
Throws: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
getCustomURL
 o getCustomURL
 public String getCustomURL()
Returns the customURL property set by setCustomURL().

See Also:
setCustomURL
 o setCustomDir
 public void setCustomDir(String dir) throws PropertyVetoException
Sets the customDir property. Setting this property will override any customDir defined in the HTML parameters.

Parameters:
customDir - Custom Directory name.
Throws: PropertyVetoException
Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
getCustomDir
 o getCustomDir
 public String getCustomDir()
Returns the customDir property set by setCustomDir().

See Also:
setCustomDir
 o GUIEvent
 public void GUIEvent(GUIEvent e)
Handler method for GUIEvents. CustomTerminal reacts to GUI events generated by the SendKeys() method.

Parameters:
evt - A GUIEvent generated by the Session Bean.
 o printScreen
 public void printScreen()
Prints the current screen contents to the default printer.

 o printPreview
 public void printPreview()
Displays a preview of the current screen for printing.

 o getFont
 public Font getFont()
Returns the current CustomTerminal font.

See Also:
setFont
 o setFont
 public void setFont(Font f)
Sets the CustomTerminal font.

Parameters:
f - The new font for CustomTerminal.
See Also:
getFont
 o setFontName
 public void setFontName(String fontName) throws PropertyVetoException
Sets the fontName property. The font name must be a monospaced font, such as Courier or Monospaced if you want components to maintain proper alignment.

Parameters:
fontName - The new monospaced font name.
Throws: PropertyVetoException
Thrown if the specified font name is not a monospaced font.
See Also:
getFontName
 o getFontName
 public String getFontName()
Returns the value of the fontName property.

See Also:
setFontName
 o setFontSize
 public void setFontSize(int fontSize) throws PropertyVetoException
Sets the fontSize property. Valid sizes are 6 to 30 points.

Parameters:
fontSize - The new font size.
Throws: PropertyVetoException
Thrown if the specified font size is too large.
See Also:
getFontSize
 o getFontSize
 public int getFontSize()
Returns the value of the fontSize property. Valid sizes are 6 to 30 points.

See Also:
setFontSize
 o setFontStyle
 public void setFontStyle(int fontStyle) throws PropertyVetoException
Sets the fontStyle property.

Valid values:

The styles can be combined for mixed styles.

Parameters:
fontStyle - The new font style.
Throws: PropertyVetoException
Thrown if the specified font style is not valid.
See Also:
listFontStyles, getFontStyle
 o getFontStyle
 public int getFontStyle()
Returns the value of the fontStyle property.

See Also:
setFontStyle
 o getColumns
 public int getColumns()
Returns the number of columns represented on the screen.

 o getRows
 public int getRows()
Returns the number of rows represented on the screen.

 o getCustomComponents
 public SCCustomComponent[] getCustomComponents()
Returns an array of all Custom Components on the current screen.

See Also:
SCCustomComponent

 o getBalls
 public SCBall[] getBalls()
Returns an array of all SCBall objects on the current screen.

See Also:
SCBall

 o getButtons
 public SCButton[] getButtons()
Returns an array of all SCButton objects on the current screen.

See Also:
SCButton

 o getButtonVVs
 public SCButtonVV[] getButtonVVs()
Returns an array of all SCButtonVV objects on the current screen.

See Also:
SCButtonVV

 o getCheckboxes
 public SCCheckbox[] getCheckboxes()
Returns an array of all SCCheckbox objects on the current screen.

See Also:
SCCheckbox

 o getChoices
 public SCChoice[] getChoices()
Returns an array of all SCChoice objects on the current screen.

See Also:
SCChoice

 o getFrames
 public SCFrame[] getFrames()
Returns an array of all SCFrame objects on the current screen.

See Also:
SCFrame

 o getHostLists
 public SCHostList[] getHostLists()
Returns an array of all SCHostList objects on the current screen.

See Also:
SCHostList

 o getImages
 public SCImage[] getImages()
Returns an array of all SCImage objects on the current screen.

See Also:
SCImage

 o getImageButtons
 public SCImageButton[] getImageButtons()
Returns an array of all SCImageButton objects on the current screen.

See Also:
SCImageButton

 o getLabels
 public SCLabel[] getLabels()
Returns an array of all SCLabel objects on the current screen.

See Also:
SCLabel

 o getLists
 public SCList[] getLists()
Returns an array of all SCList objects on the current screen.

See Also:
SCList

 o getTextfields
 public SCTextfield[] getTextfields()
Returns an array of all SCTextfield objects on the current screen.

See Also:
SCTextfield

 o getRadioButtons
 public SCRadioButton[] getRadioButtons()
Returns an array of all SCRadioButton objects on the current screen.

See Also:
SCRadioButton

 o getWebLinks
 public SCWebLink[] getWebLinks()
Returns an array of all SCWebLink objects on the current screen.

See Also:
SCWebLink

 o selectAll
 public void selectAll()
Selects the contents of the current text field or label.

 o copyToClipboard
 public void copyToClipboard()
Copies the current selected text to the clipboard.

 o copyAllToClipboard
 public void copyAllToClipboard()
Copies all text to the clipboard.

 o cutToClipboard
 public void cutToClipboard()
Cuts the current selected text to the clipboard.

 o pasteFromClipboard
 public void pasteFromClipboard()
Pastes the data from the clipboard at the current cursor location.

 o sendKeys
 public void sendKeys(SendKeyEvent evt)
Handler method for SendKeyEvents. CustomTerminal acts as a concentrator of SendKeyEvents for other Beans like KeyRemap and KeyPad. SendKeyEvents which are fired to Terminal are refired to Screen SendKeyListeners.

Parameters:
evt - SendKeyEvent that is refired to Screen SendKeyListeners.
 o addSendKeyListener
 public synchronized void addSendKeyListener(SendKeyListener l)
Adds a SendKeyListener. SendKeyListeners are notified when Screen fires a SendKeyEvent.

See Also:
removeSendKeyListener, SendKeyEvent
 o removeSendKeyListener
 public synchronized void removeSendKeyListener(SendKeyListener l)
Removes a SendKeyListener.

See Also:
addSendKeyListener, SendKeyEvent
 o addCustomListener
 public void addCustomListener(CustomListener l)
Adds a CustomListener. CustomListeners are notified when the CustomTerminal is updated.

Parameters:
l - CustomListener that receives CustomEvents
See Also:
removeCustomListener, CustomEvent
 o removeCustomListener
 public synchronized void removeCustomListener(CustomListener l)
Removes a CustomListener.

Parameters:
l - CustomListener that is removed
See Also:
addCustomListener, CustomEvent
 o addKeyListener
 public synchronized void addKeyListener(KeyListener l)
Adds a java.awt.event.KeyListener to the Bean. KeyListeners receive a java.awt.event.KeyEvent whenever the Bean has focus and a keyboard key is pressed.

Parameters:
l - KeyListener that receives KeyEvents.
See Also:
removeKeyListener
 o removeKeyListener
 public synchronized void removeKeyListener(KeyListener l)
Removes a java.awt.event.KeyListener from the Bean.

Parameters:
l - KeyListener that no longer receives KeyEvents.
See Also:
addKeyListener
 o requestFocus
 public void requestFocus()
Request focus on CustomTerminal.

 o getTraceName
 public String getTraceName()
Returns a trace identifier for this bean.

 o getECLSession
 public ECLSession getECLSession()
See Session.getECLSession()

 o getSession
 public Session getSession()
Returns the Session bean associated with this Terminal

 o setLUMPort
 public void setLUMPort(int PortNumber) throws PropertyVetoException
See Session.setLUMPort(int)

 o getLUMPort
 public int getLUMPort()
See Session.getLUMPort()

 o setServiceMgrHost
 public void setServiceMgrHost(String ServerMgrHost) throws PropertyVetoException
See Session.setServiceMgrHost(String)

 o getServiceMgrHost
 public String getServiceMgrHost()
See Session.getServiceMgrHost()

 o setLUMLicensing
 public void setLUMLicensing(String servertype) throws PropertyVetoException
See Session.setLUMLicensing(String)

 o getLUMLicensing
 public String getLUMLicensing()
See Session.getLUMLicensing()

 o setLUMServer
 public void setLUMServer(String LumServer) throws PropertyVetoException
See Session.setLUMServer(String)

 o getLUMServer
 public String getLUMServer()
See Session.getLUMServer()

 o getLookupFile
 public String getLookupFile()
Returns the lookup table name.

See Also:
getLookupFile
 o setLookupFile
 public void setLookupFile(String fileName) throws PropertyVetoException
Sets the lookup table name.

See Also:
getLookupFile
 o doFontIncrease
 public void doFontIncrease()
Increases the font by one point size. The valid point size range is 6 to 30 points.

See Also:
isFontIncreaseEnabled, doFontDecrease
 o doFontDecrease
 public void doFontDecrease()
Decreases the font by one point size. The valid point size range is 6 to 30 points.

See Also:
isFontDecreaseEnabled, doFontIncrease
 o isFontIncreaseEnabled
 public boolean isFontIncreaseEnabled()
Returns if the font size can be decreased.

 o isFontDecreaseEnabled
 public boolean isFontDecreaseEnabled()
Returns if the font size can be decreased.

 o focusLost
 public void focusLost(FocusEvent e)
 o showColorRemapDialog
 public void showColorRemapDialog()
Show the color remap dialog.

 o processCustomEvent
 public void processCustomEvent(CustomEvent e)
Method used to fire CustomEvents.

 o getGlobalVariable
 public String getGlobalVariable(String gvName)
Returns the global variable value mapped to the specified global variable name.

Parameters:
gvName - the name of the global variable to lookup.
Returns:
the value of a the named global variable, or null if no such global variable exists.
See Also:
setGlobalVariable, removeGlobalVariable, setAllGlobalVariables
 o setGlobalVariable
 public void setGlobalVariable(String gvName,
                               String gvValue)
Sets a specified global variable with a specified value. If the specified global variable does not exist, it will be created and its value set. If the specified global variable already exists its value will be overwritten with the specified value.

Parameters:
gvName - the name of the global variable to set.
gvValue - the value to set.
See Also:
getGlobalVariable, removeGlobalVariable, setAllGlobalVariables, getAllGlobalVariables
 o removeGlobalVariable
 public void removeGlobalVariable(String gvName)
Removes the specified global variable. If the global variable does not exists, this method does nothing.

Parameters:
gvName - the global variable to remove.
See Also:
setGlobalVariable, getGlobalVariable, setAllGlobalVariables, getAllGlobalVariables
 o getAllGlobalVariables
 public Properties getAllGlobalVariables()
Returns all global variables in the form of a Properties object. The returned properties object is not the actual run-time global variable data structure, but merely a copy. Any changes to the returned properties object will not affect the run-time copy.

Returns:
all global variables in the form of a Properties object.
See Also:
setAllGlobalVariables, setGlobalVariable, getGlobalVariable, removeGlobalVariable
 o setAllGlobalVariables
 public void setAllGlobalVariables(Properties properties)
Sets all global variables using a specified Properties object. This method will replace all global variables with those specified in the Properties object. In effect, first all global variables are deleted, and then repopulated with the variables specified in the properties object.

Parameters:
properties - the Properties object specifying the global variables.
See Also:
getAllGlobalVariables, setGlobalVariable, getGlobalVariable, removeGlobalVariable
 o writeComponentsToVars
 public void writeComponentsToVars()
Writes all components to global variables. Each component on the current screen (whether visible or invisible) having an associated write global variable will write its current value to that global variable. All components writing to the same global variable will overwrite that global variable in an arbitrary order; the global variable will equal the last value written.

See Also:
putVarsIntoComponents, writeGlobalVariable, readGlobalVariable
 o putVarsIntoComponents
 public void putVarsIntoComponents()
Writes global variables to all components. Each component on the current screen (whether visible or invisible) having an associated read global variable will set its value to the value of that global variable.

See Also:
writeComponentsToVars, writeGlobalVariable, readGlobalVariable
 o saveSessionInfoBeforeIPMon
 public void saveSessionInfoBeforeIPMon()
 o getHostBeforeIPMon
 public String getHostBeforeIPMon()
 o getPortBeforeIPMon
 public int getPortBeforeIPMon()
 o getFieldKeyMacro
 public boolean getFieldKeyMacro()

All Packages  Class Hierarchy  This Package  Previous  Next  Index