com.ibm.hi.customizer.beans
Class CustomTerminal

com.ibm.hi.customizer.beans.CustomTerminal
All Implemented Interfaces:
java.util.EventListener, java.awt.event.FocusListener, com.ibm.eNetwork.HOD.help.HelpListener

public final class CustomTerminal
implements java.awt.event.FocusListener, com.ibm.eNetwork.HOD.help.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)


Field Summary
static java.lang.String BALL_BUTTON_STYLE
           
static java.lang.String CUSTOM_DIR
           
static java.lang.String CUSTOM_URL
           
static java.lang.String DBCS_INPUT_VISIBLE
           
static java.lang.String DYNAMIC_BUTTON_STYLE
           
static java.lang.String FONT_NAME
           
static java.lang.String FONT_SIZE
           
static java.lang.String FONT_STYLE
           
static java.lang.String GET2POINT
           
static java.lang.String HOTSPOTS
           
static java.lang.String IMAGE_BUTTON_STYLE
           
static java.lang.String LABEL_BUTTON_STYLE
           
static java.lang.String LIGHTPEN
           
static java.lang.String LOOKUP_FILE
           
static java.lang.String MAP_ENABLED
           
static java.lang.String MENU_BUTTON_STYLE
           
static java.lang.String MENU_BUTTONS
           
static java.lang.String OIA_VISIBLE
           
static java.lang.String SOSI_VISIBLE
           
static java.lang.String STANDARD_BUTTON_STYLE
           
static java.lang.String TAB_HOSTMODE
           
static java.lang.String TAB_HOTSPOTS
           
static java.lang.String TAB_MENU_BUTTONS
           
static java.lang.String TEMPLATE
           
static java.lang.String VALID_VALUE_BUTTON_STYLE
           
static java.lang.String WEBLINK_BUTTON_STYLE
           
 
Constructor Summary
CustomTerminal()
          Default Constructor
CustomTerminal(java.util.Properties newProperties)
          Constructor that takes a Properties object containing the initial property settings.
 
Method Summary
 void addCommListener(CommListener l)
          See Session.addCommListener()
 void addCustomListener(CustomListener l)
          Adds a CustomListener.
 void addGUIListener(GUIListener l)
          See Session.addGUIListener()
 void addKeyListener(java.awt.event.KeyListener l)
          Adds a java.awt.event.KeyListener to the Bean.
 void addOIAListener(OIAListener l)
          See Session.addOIAListener()
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Adds a PropertyChangeListener.
 void addPSListener(PSListener l)
          See Session.addPSListener()
 void addSendKeyListener(SendKeyListener l)
          Adds a SendKeyListener.
 void addTraceListener(TraceListener l)
          See Session.addTraceListener()
 void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
          Adds a VetoableChangeListener.
 void copyAllToClipboard()
          Copies all text to the clipboard.
 void copyToClipboard()
          Copies the current selected text to the clipboard.
 void cutToClipboard()
          Cuts the current selected text to the clipboard.
static java.util.Properties defaults()
          Returns a Properties object containing the default properties for this Bean.
 void dispose()
          Disposes CustomTerminal and all of its resources.
 void doFontDecrease()
          Decreases the font by one point size.
 void doFontIncrease()
          Increases the font by one point size.
 void doValidValues()
          Show the valid values for the current text field.
 void doValidValuesMenu()
           
 void doWhatIsIt()
          Show the help for the current text field.
 void focusLost(java.awt.event.FocusEvent e)
           
 java.util.Properties getAllGlobalVariables()
          Returns all global variables in the form of a Properties object.
 com.ibm.hi.customizer.beans.SCBall[] getBalls()
          Returns an array of all SCBall objects on the current screen.
 com.ibm.hi.customizer.beans.SCButton[] getButtons()
          Returns an array of all SCButton objects on the current screen.
 com.ibm.hi.customizer.beans.SCButtonVV[] getButtonVVs()
          Returns an array of all SCButtonVV objects on the current screen.
 com.ibm.hi.customizer.beans.SCCheckbox[] getCheckboxes()
          Returns an array of all SCCheckbox objects on the current screen.
 com.ibm.hi.customizer.beans.SCChoice[] getChoices()
          Returns an array of all SCChoice objects on the current screen.
 java.lang.String getCICSGWCodePage()
          See Session.getCICSGWCodePage()
 java.lang.String getCICSServerName()
          See Session.getCICSServerName()
 java.lang.String getCodePage()
          See Session.getCodePage()
 int getColumns()
          Returns the number of columns represented on the screen.
 int getCommStatus()
          See Session.getCommStatus()
 com.ibm.hi.customizer.beans.SCCustomComponent[] getCustomComponents()
          Returns an array of all Custom Components on the current screen.
 java.lang.String getCustomDir()
          Returns the customDir property set by setCustomDir().
 java.lang.String getCustomURL()
          Returns the customURL property set by setCustomURL().
 java.lang.String getDeviceName()
          See Session.getDeviceName()
 com.ibm.eNetwork.ECL.ECLSession getECLSession()
          See Session.getECLSession()
 java.awt.Font getFont()
          Returns the current CustomTerminal font.
 java.lang.String getFontName()
          Returns the value of the fontName property.
 int getFontSize()
          Returns the value of the fontSize property.
 int getFontStyle()
          Returns the value of the fontStyle property.
 com.ibm.hi.customizer.beans.SCFrame[] getFrames()
          Returns an array of all SCFrame objects on the current screen.
 java.lang.String getGlobalVariable(java.lang.String gvName)
          Returns the global variable value mapped to the specified global variable name.
 java.lang.String getHost()
          See Session.getHost()
 java.lang.String getHostBeforeIPMon()
           
 com.ibm.hi.customizer.beans.SCHostList[] getHostLists()
          Returns an array of all SCHostList objects on the current screen.
 com.ibm.hi.customizer.beans.SCImageButton[] getImageButtons()
          Returns an array of all SCImageButton objects on the current screen.
 java.lang.String getImageButtonStyle()
          Returns the image button style.
 com.ibm.hi.customizer.beans.SCImage[] getImages()
          Returns an array of all SCImage objects on the current screen.
 boolean getIsFileMacroKey()
           
 boolean getIsMacroKey()
           
 com.ibm.hi.customizer.beans.SCLabel[] getLabels()
          Returns an array of all SCLabel objects on the current screen.
 com.ibm.hi.customizer.beans.SCList[] getLists()
          Returns an array of all SCList objects on the current screen.
 java.lang.String getLookupFile()
          Returns the lookup table name.
 java.lang.String getLUMLicensing()
          See Session.getLUMLicensing()
 int getLUMPort()
          See Session.getLUMPort()
 java.lang.String getLUMServer()
          See Session.getLUMServer()
 java.lang.String getLUName()
          See Session.getLUName()
 java.lang.String getMenuButtonStyle()
          Returns the menu button style.
 java.lang.String getNumeralShape()
          See Session.getNumeralShape()
 int getPort()
          See Session.getPort()
 int getPortBeforeIPMon()
           
 java.util.Properties getProperties()
          Get the properties for this bean.
 com.ibm.hi.customizer.beans.SCRadioButton[] getRadioButtons()
          Returns an array of all SCRadioButton objects on the current screen.
 int getRows()
          Returns the number of rows represented on the screen.
 java.lang.String getScreenID()
          Returns the current screen ID.
 java.lang.String getScreenSize()
          See Session.getScreenSize()
 java.lang.String getServiceMgrHost()
          See Session.getServiceMgrHost()
 Session getSession()
          Returns the Session bean associated with this Terminal
 java.lang.String getSessionID()
          See Session.getSessionID()
 java.lang.String getSessionName()
          See Session.getSessionName()
 java.lang.String getSessionType()
          See Session.getSessionType()
 java.lang.String getSLPAS400Name()
          See Session.getSLPAS400Name()
 int getSLPMaxWaitTime()
          See Session.getSLPMaxWaitTime()
 java.lang.String getSLPScope()
          See Session.getSLPScope()
 java.lang.String getSSLCertificateURL()
          See Session.getSSLCertificateURL()
 java.lang.String getTemplate()
          Returns the template property set by setTemplate().
 com.ibm.hi.customizer.beans.SCTextfield[] getTextfields()
          Returns an array of all SCTextfield objects on the current screen.
 java.lang.String getTextOrientation()
          See Session.getTextOrientation()
 java.lang.String getTextType()
          See Session.getTextType()
 int getThaiDisplayMode()
          See Session.getThaiDisplayMode()
 java.lang.String getTraceName()
          Returns a trace identifier for this bean.
 java.lang.String getValidValueButtonStyle()
          Returns the valid values button style.
 java.lang.String getWebLinkButtonStyle()
          Returns the web link button style.
 com.ibm.hi.customizer.beans.SCWebLink[] getWebLinks()
          Returns an array of all SCWebLink objects on the current screen.
 java.lang.String getWorkstationID()
          See Session.getWorkstationID()
 void GUIEvent(GUIEvent e)
          Handler method for GUIEvents.
 boolean isAccessibilityEnabled()
          Returns accessibilityEnabled state.
 boolean isAutoConnect()
          See Session.isAutoConnect()
 boolean isAutoReconnect()
          See Session.isAutoReconnect()
 boolean isCommStarted()
          See Session.isCommStarted()
 boolean isDBCSInputVisible()
          Returns the value of the DBCSInputVisible property.
 boolean isDeviceNameReady()
          See Session.isDeviceNameReady()
 boolean isFontDecreaseEnabled()
          Returns if the font size can be decreased.
 boolean isFontIncreaseEnabled()
          Returns if the font size can be decreased.
 boolean isGet2PointEnabled()
          Returns Get2PointEnabled state.
 boolean isHostModeTabEnabled()
          Returns the host mode tab state.
 boolean isHotspotsEnabled()
          Returns the hotspot enabled state.
 boolean isHotspotsTabEnabled()
          Returns the hotspots tab state.
 boolean isLightPenMode()
          Returns the value of the lightPenMode property.
 boolean isMapEnabled()
          Get map enabled state.
 boolean isMenuButtonsEnabled()
          Returns the menu enabled state.
 boolean isMenuButtonsTabEnabled()
          Returns the menu button tab state.
 boolean isNumericSwapEnabled()
          See Session.isNumericSwapEnabled()
 boolean isOIAVisible()
          Returns the value of the OIAVisible property.
 boolean isSLPEnabled()
          See Session.isSLPEnabled()
 boolean isSLPThisScopeOnly()
          See Session.isSLPThisScopeOnly()
 boolean isSOSIVisible()
          Returns the value of the SOSIVisible property.
 boolean isSSL()
          See Session.isSSL()
 boolean isSSLCertificatePrompted()
          See Session.isSSLCertificatePrompted()
 boolean isSSLCertificateProvided()
          See Session.isSSLCertificateProvided()
 boolean isSSLCertificateRemembered()
          See Session.isSSLCertificateRemembered()
 boolean isSSLServerAuthentication()
          See Session.isSSLServerAuthentication()
 boolean isSSLTelnetNegotiated()
          See Session.isSSLTelnetNegotiated()
 boolean isSymmetricSwapEnabled()
          See Session.isSymmetricSwapEnabled()
 boolean isTemplateEnabled()
          Returns the state of the template.
 boolean isTNEnhanced()
          See Session.isTNEnhanced()
 boolean isWorkstationIDReady()
          See Session.isWorkstationIDReady()
 java.util.Enumeration listCICSGWCodePages()
          See Session.listCICSGWCodePages()
 java.util.Enumeration listCodePages()
          See Session.listCodePages()
static java.util.Enumeration listCodePages(java.lang.String sessionType)
          See Session.listCodePages(java.lang.String)
 java.util.Enumeration listNumeralShapes()
          See Session.listNumeralShapes()
 java.util.Enumeration listScreenSizes()
          See Session.listScreenSizes()
 java.util.Enumeration listScreenSizes(java.lang.String sessionType)
          See Session.listScreenSizes(java.lang.String)
 java.util.Enumeration listTextOrientations()
          See Session.listTextOrientations()
 java.util.Enumeration listTextTypes()
          See Session.listTextTypes()
 java.util.Enumeration listThaiDisplayModes()
          See Session.listThaiDisplayModes()
 void pasteFromClipboard()
          Pastes the data from the clipboard at the current cursor location.
 void printPreview()
          Displays a preview of the current screen for printing.
 void printScreen()
          Prints the current screen contents to the default printer.
 void printSetupPage()
           
 void printSetupPage(java.util.Properties p)
           
 void printSetupPrint()
           
 void printSetupPrint(java.util.Properties p)
           
 void processCustomEvent(CustomEvent e)
          Method used to fire CustomEvents.
 void putVarsIntoComponents()
          Writes global variables to all components.
 void refresh()
          Refreshes the screen.
 void removeCommListener(CommListener l)
          See Session.removeCommListener()
 void removeCustomListener(CustomListener l)
          Removes a CustomListener.
 void removeGlobalVariable(java.lang.String gvName)
          Removes the specified global variable.
 void removeGUIListener(GUIListener l)
          See Session.removeGUIListener()
 void removeKeyListener(java.awt.event.KeyListener l)
          Removes a java.awt.event.KeyListener from the Bean.
 void removeOIAListener(OIAListener l)
          See Session.removeOIAListener()
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Removes a PropertyChangeListener.
 void removePSListener(PSListener l)
          See Session.removePSListener()
 void removeSendKeyListener(SendKeyListener l)
          Removes a SendKeyListener.
 void removeTraceListener(TraceListener l)
          See Session.removeTraceListener()
 void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
          Removes a VetoableChangeListener.
 void requestFocus()
          Request focus on CustomTerminal.
 void saveSessionInfoBeforeIPMon()
           
 void selectAll()
          Selects the contents of the current text field or label.
 void sendKeys(SendKeyEvent evt)
          Handler method for SendKeyEvents.
 void setAccessibilityEnabled(boolean enable)
          Enable or disable accessibility
 void setAllGlobalVariables(java.util.Properties properties)
          Sets all global variables using a specified Properties object.
 void setAutoConnect(boolean autoConnect)
          See Session.setAutoConnect()
 void setAutoReconnect(boolean autoReconnect)
          See Session.setAutoReconnect()
 void setCICSGWCodePage(java.lang.String codePage)
          See Session.setCICSGWCodePage()
 void setCICSServerName(java.lang.String server)
          See Session.setCICSServerName()
 void setCodePage(java.lang.String codePage)
          See Session.setCodePage()
 void setCustomDir(java.lang.String dir)
          Sets the customDir property.
 void setCustomURL(java.lang.String customURL)
          Sets the customURL property.
 void setDBCSInputVisible(boolean showDBCSInput)
          Sets the DBCSInputVisible property (3270 and 5250 DBCS sessions only).
 void setFont(java.awt.Font f)
          Sets the CustomTerminal font.
 void setFontName(java.lang.String fontName)
          Sets the fontName property.
 void setFontSize(int fontSize)
          Sets the fontSize property.
 void setFontStyle(int fontStyle)
          Sets the fontStyle property.
 void setGet2PointEnabled(boolean enable)
          Enable or disable Get2Point macro.
 void setGlobalVariable(java.lang.String gvName, java.lang.String gvValue)
          Sets a specified global variable with a specified value.
 void setHODKeyRemap(KeyRemap hodKeyRemap)
           
 void setHost(java.lang.String host)
          See Session.setHost()
 void setHostModeTabEnabled(boolean enable)
          Sets the Host mode tab state.
 void setHotspotsEnabled(boolean enable)
          Enable or disable hotspots.
 void setHotspotsTabEnabled(boolean enable)
          Sets the hotspot tab state.
 void setImageButtonStyle(java.lang.String style)
          Set the image button style.
 void setInsertEnabled(boolean enable)
          Set the insert enabled state.
 void setIsFileMacroKey(boolean isFileMacro)
           
 void setIsMacroKey(boolean isMacro)
           
 void setLightPenMode(boolean enable)
          Sets the lightPenMode property (3270 and CICS sessions only).
 void setLookupFile(java.lang.String fileName)
          Sets the lookup table name.
 void setLUMLicensing(java.lang.String servertype)
          See Session.setLUMLicensing(String)
 void setLUMPort(int PortNumber)
          See Session.setLUMPort(int)
 void setLUMServer(java.lang.String LumServer)
          See Session.setLUMServer(String)
 void setLUName(java.lang.String luName)
          See Session.setLUName()
 void setMapEnabled(boolean enable)
          Turn current map on or off.
 void setMenuButtonsEnabled(boolean enable)
          Enable or disable menu buttons.
 void setMenuButtonsTabEnabled(boolean enable)
          Sets the menu button tab state.
 void setMenuButtonStyle(java.lang.String style)
          Set the menu button style.
 void setNumeralShape(java.lang.String ns)
          See Session.setNumeralShape()
 void setNumericSwapEnabled(boolean state)
          See Session.setNumericSwapEnabled()
 void setOIAVisible(boolean showOIA)
          Sets the OIAVisible property.
 void setPort(int port)
          See Session.setPort()
 void setProperties(java.util.Properties p)
          Set the properties on this bean.
 void setScreenSize(java.lang.String size)
          See Session.setScreenSize()
 void setServiceMgrHost(java.lang.String ServerMgrHost)
          See Session.setServiceMgrHost(String)
 void setSessionID(java.lang.String ID)
          See Session.setSessionID()
 void setSessionName(java.lang.String name)
          See Session.setSessionName()
 void setSessionType(java.lang.String type)
          Set the Session type/ See Session.setSessionType().
 void setSLPAS400Name(java.lang.String as400name)
          See Session.setSLPAS400Name()
 void setSLPEnabled(boolean slp)
          See Session.setSLPEnabled()
 void setSLPMaxWaitTime(int maxWait)
          See Session.setSLPMaxWaitTime()
 void setSLPScope(java.lang.String scope)
          See Session.setSLPScope()
 void setSLPThisScopeOnly(boolean thisScopeOnly)
          See Session.setSLPThisScopeOnly()
 void setSOSIVisible(boolean showSOSI)
          Sets the SOSIVisible property (3270 and 5250 DBCS sessions only).
 void setSSL(boolean SSL)
          See Session.setSSL()
 void setSSLCertificatePassword(java.lang.String pw)
          See Session.setSSLCertificatePassword()
 void setSSLCertificatePrompted(boolean prompted)
          See Session.setSSLCertificatePrompted()
 void setSSLCertificateProvided(boolean provided)
          See Session.setSSLCertificateProvided()
 void setSSLCertificateRemembered(boolean remembered)
          See Session.setSSLCertificateRemembered()
 void setSSLCertificateURL(java.lang.String url)
          See Session.setSSLCertificateURL()
 void setSSLServerAuthentication(boolean authentication)
          See Session.setSSLServerAuthentication()
 void setSSLTelnetNegotiated(boolean tnNegotiated)
          See Session.setSSLTelnetNegotiated()
 void setSymmetricSwapEnabled(boolean state)
          See Session.setSymmetricSwapEnabled()
 void setTemplate(java.lang.String template)
          Sets the template property.
 void setTextOrientation(java.lang.String to)
          See Session.setTextOrientation()
 void setTextType(java.lang.String tt)
          See Session.setTextType()
 void setThaiDisplayMode(int mode)
          See Session.setThaiDisplayMode
 void setTNEnhanced(boolean enhanced)
          See Session.setTNEnhanced()
 void setValidValueButtonStyle(java.lang.String style)
          Set the valid values button style.
 void setWebLinkButtonStyle(java.lang.String style)
          Set the Web-Link button style.
 void setWorkstationID(java.lang.String wsID)
          See Session.setWorkstationID()
 void showColorRemapDialog()
          Show the color remap dialog.
 void startCommunication()
          See Session.startCommunication()
 void stopCommunication()
          See Session.stopCommunication()
 void writeComponentsToVars()
          Writes all components to global variables.
 
Methods inherited from interface java.awt.event.FocusListener
focusGained
 
Methods inherited from interface com.ibm.eNetwork.HOD.help.HelpListener
helpRequest
 

Field Detail

STANDARD_BUTTON_STYLE

public static final java.lang.String STANDARD_BUTTON_STYLE

DYNAMIC_BUTTON_STYLE

public static final java.lang.String DYNAMIC_BUTTON_STYLE

LABEL_BUTTON_STYLE

public static final java.lang.String LABEL_BUTTON_STYLE

BALL_BUTTON_STYLE

public static final java.lang.String BALL_BUTTON_STYLE

FONT_NAME

public static final java.lang.String FONT_NAME

FONT_STYLE

public static final java.lang.String FONT_STYLE

FONT_SIZE

public static final java.lang.String FONT_SIZE

TEMPLATE

public static final java.lang.String TEMPLATE

HOTSPOTS

public static final java.lang.String HOTSPOTS

LIGHTPEN

public static final java.lang.String LIGHTPEN

GET2POINT

public static final java.lang.String GET2POINT

MENU_BUTTONS

public static final java.lang.String MENU_BUTTONS

TAB_MENU_BUTTONS

public static final java.lang.String TAB_MENU_BUTTONS

TAB_HOTSPOTS

public static final java.lang.String TAB_HOTSPOTS

TAB_HOSTMODE

public static final java.lang.String TAB_HOSTMODE

MAP_ENABLED

public static final java.lang.String MAP_ENABLED

MENU_BUTTON_STYLE

public static final java.lang.String MENU_BUTTON_STYLE

IMAGE_BUTTON_STYLE

public static final java.lang.String IMAGE_BUTTON_STYLE

WEBLINK_BUTTON_STYLE

public static final java.lang.String WEBLINK_BUTTON_STYLE

VALID_VALUE_BUTTON_STYLE

public static final java.lang.String VALID_VALUE_BUTTON_STYLE

OIA_VISIBLE

public static final java.lang.String OIA_VISIBLE

DBCS_INPUT_VISIBLE

public static final java.lang.String DBCS_INPUT_VISIBLE

SOSI_VISIBLE

public static final java.lang.String SOSI_VISIBLE

CUSTOM_URL

public static final java.lang.String CUSTOM_URL

CUSTOM_DIR

public static final java.lang.String CUSTOM_DIR

LOOKUP_FILE

public static final java.lang.String LOOKUP_FILE
Constructor Detail

CustomTerminal

public CustomTerminal()
Default Constructor

CustomTerminal

public CustomTerminal(java.util.Properties newProperties)
               throws java.beans.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:
java.beans.PropertyVetoException - Thrown if an incorrect property value is given.
Method Detail

setProperties

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

getProperties

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

defaults

public static java.util.Properties defaults()
Returns a Properties object containing the default properties for this Bean.
See Also:
setProperties(java.util.Properties)

dispose

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

refresh

public void refresh()
Refreshes the screen.

getScreenID

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

setMapEnabled

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

isMapEnabled

public boolean isMapEnabled()
Get map enabled state.

setGet2PointEnabled

public void setGet2PointEnabled(boolean enable)
                         throws java.beans.PropertyVetoException
Enable or disable Get2Point macro.
See Also:
isGet2PointEnabled()

isGet2PointEnabled

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

setAccessibilityEnabled

public void setAccessibilityEnabled(boolean enable)
                             throws java.beans.PropertyVetoException
Enable or disable accessibility
See Also:
isAccessibilityEnabled()

isAccessibilityEnabled

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

setHotspotsEnabled

public void setHotspotsEnabled(boolean enable)
                        throws java.beans.PropertyVetoException
Enable or disable hotspots.
See Also:
isHotspotsEnabled()

isHotspotsEnabled

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

setMenuButtonsEnabled

public void setMenuButtonsEnabled(boolean enable)
                           throws java.beans.PropertyVetoException
Enable or disable menu buttons.
See Also:
isMenuButtonsEnabled()

isMenuButtonsEnabled

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

setMenuButtonStyle

public void setMenuButtonStyle(java.lang.String style)
                        throws java.beans.PropertyVetoException
Set the menu button style.

Valid values:

See Also:
getMenuButtonStyle()

getMenuButtonStyle

public java.lang.String getMenuButtonStyle()
Returns the menu button style.
See Also:
setMenuButtonStyle(java.lang.String)

setImageButtonStyle

public void setImageButtonStyle(java.lang.String style)
                         throws java.beans.PropertyVetoException
Set the image button style.

Valid values:

See Also:
getImageButtonStyle()

getImageButtonStyle

public java.lang.String getImageButtonStyle()
Returns the image button style.
See Also:
setImageButtonStyle(java.lang.String)

setWebLinkButtonStyle

public void setWebLinkButtonStyle(java.lang.String style)
                           throws java.beans.PropertyVetoException
Set the Web-Link button style.

Valid values:

See Also:
getWebLinkButtonStyle()

getWebLinkButtonStyle

public java.lang.String getWebLinkButtonStyle()
Returns the web link button style.
See Also:
setWebLinkButtonStyle(java.lang.String)

setValidValueButtonStyle

public void setValidValueButtonStyle(java.lang.String style)
                              throws java.beans.PropertyVetoException
Set the valid values button style.

Valid values:

See Also:
getValidValueButtonStyle()

getValidValueButtonStyle

public java.lang.String getValidValueButtonStyle()
Returns the valid values button style.
See Also:
setValidValueButtonStyle(java.lang.String)

setHostModeTabEnabled

public void setHostModeTabEnabled(boolean enable)
                           throws java.beans.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(boolean), setMenuButtonsTabEnabled(boolean)

isHostModeTabEnabled

public boolean isHostModeTabEnabled()
Returns the host mode tab state.
See Also:
setHostModeTabEnabled(boolean)

setHotspotsTabEnabled

public void setHotspotsTabEnabled(boolean enable)
                           throws java.beans.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(boolean), setHostModeTabEnabled(boolean)

isHotspotsTabEnabled

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

setMenuButtonsTabEnabled

public void setMenuButtonsTabEnabled(boolean enable)
                              throws java.beans.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(boolean), setHostModeTabEnabled(boolean)

isMenuButtonsTabEnabled

public boolean isMenuButtonsTabEnabled()
Returns the menu button tab state.
See Also:
setMenuButtonsTabEnabled(boolean)

setInsertEnabled

public void setInsertEnabled(boolean enable)
Set the insert enabled state.

addVetoableChangeListener

public void addVetoableChangeListener(java.beans.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

removeVetoableChangeListener

public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes a VetoableChangeListener.
See Also:
addVetoableChangeListener

addPropertyChangeListener

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

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener.
See Also:
addPropertyChangeListener

addCommListener

public void addCommListener(CommListener l)
See Session.addCommListener()

addOIAListener

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

addPSListener

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

addGUIListener

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

addTraceListener

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

removeTraceListener

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

removeCommListener

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

removeOIAListener

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

removePSListener

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

removeGUIListener

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

startCommunication

public void startCommunication()
See Session.startCommunication()

stopCommunication

public void stopCommunication()
See Session.stopCommunication()

isAutoConnect

public boolean isAutoConnect()
See Session.isAutoConnect()

setAutoConnect

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

isAutoReconnect

public boolean isAutoReconnect()
See Session.isAutoReconnect()

setAutoReconnect

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

getCICSGWCodePage

public java.lang.String getCICSGWCodePage()
See Session.getCICSGWCodePage()

setCICSGWCodePage

public void setCICSGWCodePage(java.lang.String codePage)
                       throws java.beans.PropertyVetoException
See Session.setCICSGWCodePage()

listCICSGWCodePages

public java.util.Enumeration listCICSGWCodePages()
See Session.listCICSGWCodePages()

getCICSServerName

public java.lang.String getCICSServerName()
See Session.getCICSServerName()

setCICSServerName

public void setCICSServerName(java.lang.String server)
                       throws java.beans.PropertyVetoException
See Session.setCICSServerName()

getCodePage

public java.lang.String getCodePage()
See Session.getCodePage()

setCodePage

public void setCodePage(java.lang.String codePage)
                 throws java.beans.PropertyVetoException
See Session.setCodePage()

listCodePages

public java.util.Enumeration listCodePages()
See Session.listCodePages()

listCodePages

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

isCommStarted

public boolean isCommStarted()
See Session.isCommStarted()

isDeviceNameReady

public boolean isDeviceNameReady()
See Session.isDeviceNameReady()

isWorkstationIDReady

public boolean isWorkstationIDReady()
See Session.isWorkstationIDReady()

getDeviceName

public java.lang.String getDeviceName()
See Session.getDeviceName()

getCommStatus

public int getCommStatus()
See Session.getCommStatus()

getHost

public java.lang.String getHost()
See Session.getHost()

setHost

public void setHost(java.lang.String host)
             throws java.beans.PropertyVetoException
See Session.setHost()

getPort

public int getPort()
See Session.getPort()

setPort

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

isTNEnhanced

public boolean isTNEnhanced()
See Session.isTNEnhanced()

setTNEnhanced

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

getLUName

public java.lang.String getLUName()
See Session.getLUName()

setLUName

public void setLUName(java.lang.String luName)
               throws java.beans.PropertyVetoException
See Session.setLUName()

getWorkstationID

public java.lang.String getWorkstationID()
See Session.getWorkstationID()

setWorkstationID

public void setWorkstationID(java.lang.String wsID)
                      throws java.beans.PropertyVetoException
See Session.setWorkstationID()

getSessionName

public java.lang.String getSessionName()
See Session.getSessionName()

setSessionName

public void setSessionName(java.lang.String name)
                    throws java.beans.PropertyVetoException
See Session.setSessionName()

getSessionID

public java.lang.String getSessionID()
See Session.getSessionID()

setSessionID

public void setSessionID(java.lang.String ID)
                  throws java.beans.PropertyVetoException
See Session.setSessionID()

getScreenSize

public java.lang.String getScreenSize()
See Session.getScreenSize()

setScreenSize

public void setScreenSize(java.lang.String size)
                   throws java.beans.PropertyVetoException
See Session.setScreenSize()

listScreenSizes

public java.util.Enumeration listScreenSizes()
See Session.listScreenSizes()

listScreenSizes

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

getSessionType

public java.lang.String getSessionType()
See Session.getSessionType()

setSessionType

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

isSSL

public boolean isSSL()
See Session.isSSL()

setSSL

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

isSSLTelnetNegotiated

public boolean isSSLTelnetNegotiated()
See Session.isSSLTelnetNegotiated()

setSSLTelnetNegotiated

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

isSSLServerAuthentication

public boolean isSSLServerAuthentication()
See Session.isSSLServerAuthentication()

setSSLServerAuthentication

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

isSSLCertificateProvided

public boolean isSSLCertificateProvided()
See Session.isSSLCertificateProvided()

setSSLCertificateProvided

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

getSSLCertificateURL

public java.lang.String getSSLCertificateURL()
See Session.getSSLCertificateURL()

setSSLCertificateURL

public void setSSLCertificateURL(java.lang.String url)
                          throws java.beans.PropertyVetoException
See Session.setSSLCertificateURL()

setSSLCertificatePassword

public void setSSLCertificatePassword(java.lang.String pw)
                               throws java.beans.PropertyVetoException
See Session.setSSLCertificatePassword()

isSSLCertificateRemembered

public boolean isSSLCertificateRemembered()
See Session.isSSLCertificateRemembered()

setSSLCertificateRemembered

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

setSSLCertificatePrompted

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

isSSLCertificatePrompted

public boolean isSSLCertificatePrompted()
See Session.isSSLCertificatePrompted()

setSymmetricSwapEnabled

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

isSymmetricSwapEnabled

public boolean isSymmetricSwapEnabled()
See Session.isSymmetricSwapEnabled()

setNumericSwapEnabled

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

isNumericSwapEnabled

public boolean isNumericSwapEnabled()
See Session.isNumericSwapEnabled()

setNumeralShape

public void setNumeralShape(java.lang.String ns)
                     throws java.beans.PropertyVetoException
See Session.setNumeralShape()

getNumeralShape

public java.lang.String getNumeralShape()
See Session.getNumeralShape()

listNumeralShapes

public java.util.Enumeration listNumeralShapes()
See Session.listNumeralShapes()

setTextOrientation

public void setTextOrientation(java.lang.String to)
                        throws java.beans.PropertyVetoException
See Session.setTextOrientation()

getTextOrientation

public java.lang.String getTextOrientation()
See Session.getTextOrientation()

listTextOrientations

public java.util.Enumeration listTextOrientations()
See Session.listTextOrientations()

setTextType

public void setTextType(java.lang.String tt)
                 throws java.beans.PropertyVetoException
See Session.setTextType()

getTextType

public java.lang.String getTextType()
See Session.getTextType()

listTextTypes

public java.util.Enumeration listTextTypes()
See Session.listTextTypes()

getThaiDisplayMode

public int getThaiDisplayMode()
See Session.getThaiDisplayMode()

setThaiDisplayMode

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

listThaiDisplayModes

public java.util.Enumeration listThaiDisplayModes()
See Session.listThaiDisplayModes()

isSLPEnabled

public boolean isSLPEnabled()
See Session.isSLPEnabled()

setSLPEnabled

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

setSLPAS400Name

public void setSLPAS400Name(java.lang.String as400name)
                     throws java.beans.PropertyVetoException
See Session.setSLPAS400Name()

getSLPAS400Name

public java.lang.String getSLPAS400Name()
See Session.getSLPAS400Name()

setSLPScope

public void setSLPScope(java.lang.String scope)
                 throws java.beans.PropertyVetoException
See Session.setSLPScope()

getSLPScope

public java.lang.String getSLPScope()
See Session.getSLPScope()

isSLPThisScopeOnly

public boolean isSLPThisScopeOnly()
See Session.isSLPThisScopeOnly()

setSLPThisScopeOnly

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

getSLPMaxWaitTime

public int getSLPMaxWaitTime()
See Session.getSLPMaxWaitTime()

setSLPMaxWaitTime

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

setOIAVisible

public void setOIAVisible(boolean showOIA)
                   throws java.beans.PropertyVetoException
Sets the OIAVisible property. When true CustomTerminal displays the Operator Information Area (OIA).
Parameters:
showOIA - Whether the CustomTerminal shows OIA or not.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isOIAVisible()

isOIAVisible

public boolean isOIAVisible()
Returns the value of the OIAVisible property.
See Also:
setOIAVisible(boolean)

setDBCSInputVisible

public void setDBCSInputVisible(boolean showDBCSInput)
                         throws java.beans.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:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isDBCSInputVisible()

isDBCSInputVisible

public boolean isDBCSInputVisible()
Returns the value of the DBCSInputVisible property.
See Also:
setDBCSInputVisible(boolean)

setSOSIVisible

public void setSOSIVisible(boolean showSOSI)
                    throws java.beans.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:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isSOSIVisible()

isSOSIVisible

public boolean isSOSIVisible()
Returns the value of the SOSIVisible property.
See Also:
setSOSIVisible(boolean)

doValidValues

public void doValidValues()
Show the valid values for the current text field.

doWhatIsIt

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

doValidValuesMenu

public void doValidValuesMenu()

setLightPenMode

public void setLightPenMode(boolean enable)
                     throws java.beans.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:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
isLightPenMode()

isLightPenMode

public boolean isLightPenMode()
Returns the value of the lightPenMode property.
See Also:
setLightPenMode(boolean)

setTemplate

public void setTemplate(java.lang.String template)
                 throws java.beans.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:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
getTemplate()

getTemplate

public java.lang.String getTemplate()
Returns the template property set by setTemplate().
See Also:
setTemplate(java.lang.String)

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(java.lang.String)

setCustomURL

public void setCustomURL(java.lang.String customURL)
                  throws java.beans.PropertyVetoException
Sets the customURL property. Setting this property will override any customURL defined in the HTML parameters.
Parameters:
CustomURL - Custom URL.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
getCustomURL()

getCustomURL

public java.lang.String getCustomURL()
Returns the customURL property set by setCustomURL().
See Also:
setCustomURL(java.lang.String)

setCustomDir

public void setCustomDir(java.lang.String dir)
                  throws java.beans.PropertyVetoException
Sets the customDir property. Setting this property will override any customDir defined in the HTML parameters.
Parameters:
customDir - Custom Directory name.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.
See Also:
getCustomDir()

getCustomDir

public java.lang.String getCustomDir()
Returns the customDir property set by setCustomDir().
See Also:
setCustomDir(java.lang.String)

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.

printScreen

public void printScreen()
Prints the current screen contents to the default printer.

printPreview

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

printSetupPage

public void printSetupPage()

printSetupPage

public void printSetupPage(java.util.Properties p)

printSetupPrint

public void printSetupPrint()

printSetupPrint

public void printSetupPrint(java.util.Properties p)

getFont

public java.awt.Font getFont()
Returns the current CustomTerminal font.
See Also:
setFont(java.awt.Font)

setFont

public void setFont(java.awt.Font f)
Sets the CustomTerminal font.
Parameters:
f - The new font for CustomTerminal.
See Also:
getFont()

setFontName

public void setFontName(java.lang.String fontName)
                 throws java.beans.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:
java.beans.PropertyVetoException - Thrown if the specified font name is not a monospaced font.
See Also:
getFontName()

getFontName

public java.lang.String getFontName()
Returns the value of the fontName property.
See Also:
setFontName(java.lang.String)

setFontSize

public void setFontSize(int fontSize)
                 throws java.beans.PropertyVetoException
Sets the fontSize property. Valid sizes are 6 to 30 points.
Parameters:
fontSize - The new font size.
Throws:
java.beans.PropertyVetoException - Thrown if the specified font size is too large.
See Also:
getFontSize()

getFontSize

public int getFontSize()
Returns the value of the fontSize property. Valid sizes are 6 to 30 points.
See Also:
setFontSize(int)

setFontStyle

public void setFontStyle(int fontStyle)
                  throws java.beans.PropertyVetoException
Sets the fontStyle property.

Valid values:

The styles can be combined for mixed styles.

Parameters:
fontStyle - The new font style.
Throws:
java.beans.PropertyVetoException - Thrown if the specified font style is not valid.
See Also:
Terminal.listFontStyles(), getFontStyle()

getFontStyle

public int getFontStyle()
Returns the value of the fontStyle property.
See Also:
setFontStyle(int)

getColumns

public int getColumns()
Returns the number of columns represented on the screen.

getRows

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

getCustomComponents

public com.ibm.hi.customizer.beans.SCCustomComponent[] getCustomComponents()
Returns an array of all Custom Components on the current screen.

See Also:
SCCustomComponent

getBalls

public com.ibm.hi.customizer.beans.SCBall[] getBalls()
Returns an array of all SCBall objects on the current screen.

See Also:
SCBall

getButtons

public com.ibm.hi.customizer.beans.SCButton[] getButtons()
Returns an array of all SCButton objects on the current screen.

See Also:
SCButton

getButtonVVs

public com.ibm.hi.customizer.beans.SCButtonVV[] getButtonVVs()
Returns an array of all SCButtonVV objects on the current screen.

See Also:
SCButtonVV

getCheckboxes

public com.ibm.hi.customizer.beans.SCCheckbox[] getCheckboxes()
Returns an array of all SCCheckbox objects on the current screen.

See Also:
SCCheckbox

getChoices

public com.ibm.hi.customizer.beans.SCChoice[] getChoices()
Returns an array of all SCChoice objects on the current screen.

See Also:
SCChoice

getFrames

public com.ibm.hi.customizer.beans.SCFrame[] getFrames()
Returns an array of all SCFrame objects on the current screen.

See Also:
SCFrame

getHostLists

public com.ibm.hi.customizer.beans.SCHostList[] getHostLists()
Returns an array of all SCHostList objects on the current screen.

See Also:
SCHostList

getImages

public com.ibm.hi.customizer.beans.SCImage[] getImages()
Returns an array of all SCImage objects on the current screen.

See Also:
SCImage

getImageButtons

public com.ibm.hi.customizer.beans.SCImageButton[] getImageButtons()
Returns an array of all SCImageButton objects on the current screen.

See Also:
SCImageButton

getLabels

public com.ibm.hi.customizer.beans.SCLabel[] getLabels()
Returns an array of all SCLabel objects on the current screen.

See Also:
SCLabel

getLists

public com.ibm.hi.customizer.beans.SCList[] getLists()
Returns an array of all SCList objects on the current screen.

See Also:
SCList

getTextfields

public com.ibm.hi.customizer.beans.SCTextfield[] getTextfields()
Returns an array of all SCTextfield objects on the current screen.

See Also:
SCTextfield

getRadioButtons

public com.ibm.hi.customizer.beans.SCRadioButton[] getRadioButtons()
Returns an array of all SCRadioButton objects on the current screen.

See Also:
SCRadioButton

getWebLinks

public com.ibm.hi.customizer.beans.SCWebLink[] getWebLinks()
Returns an array of all SCWebLink objects on the current screen.

See Also:
SCWebLink

selectAll

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

copyToClipboard

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

copyAllToClipboard

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

cutToClipboard

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

pasteFromClipboard

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

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.

addSendKeyListener

public void addSendKeyListener(SendKeyListener l)
Adds a SendKeyListener. SendKeyListeners are notified when Screen fires a SendKeyEvent.
See Also:
removeSendKeyListener(com.ibm.eNetwork.beans.HOD.event.SendKeyListener), SendKeyEvent

removeSendKeyListener

public void removeSendKeyListener(SendKeyListener l)
Removes a SendKeyListener.
See Also:
addSendKeyListener(com.ibm.eNetwork.beans.HOD.event.SendKeyListener), SendKeyEvent

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(com.ibm.hi.customizer.beans.event.CustomListener), com.ibm.hi.customizer.beans.HOD.event.CustomEvent

removeCustomListener

public void removeCustomListener(CustomListener l)
Removes a CustomListener.
Parameters:
l - CustomListener that is removed
See Also:
addCustomListener(com.ibm.hi.customizer.beans.event.CustomListener), com.ibm.eNetwork.beans.HOD.event.CustomEvent

addKeyListener

public void addKeyListener(java.awt.event.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(java.awt.event.KeyListener)

removeKeyListener

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

requestFocus

public void requestFocus()
Request focus on CustomTerminal.

getTraceName

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

getECLSession

public com.ibm.eNetwork.ECL.ECLSession getECLSession()
See Session.getECLSession()

getSession

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

setLUMPort

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

getLUMPort

public int getLUMPort()
See Session.getLUMPort()

setServiceMgrHost

public void setServiceMgrHost(java.lang.String ServerMgrHost)
                       throws java.beans.PropertyVetoException
See Session.setServiceMgrHost(String)

getServiceMgrHost

public java.lang.String getServiceMgrHost()
See Session.getServiceMgrHost()

setLUMLicensing

public void setLUMLicensing(java.lang.String servertype)
                     throws java.beans.PropertyVetoException
See Session.setLUMLicensing(String)

getLUMLicensing

public java.lang.String getLUMLicensing()
See Session.getLUMLicensing()

setLUMServer

public void setLUMServer(java.lang.String LumServer)
                  throws java.beans.PropertyVetoException
See Session.setLUMServer(String)

getLUMServer

public java.lang.String getLUMServer()
See Session.getLUMServer()

getLookupFile

public java.lang.String getLookupFile()
Returns the lookup table name.
See Also:
getLookupFile()

setLookupFile

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

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()

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()

isFontIncreaseEnabled

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

isFontDecreaseEnabled

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

focusLost

public void focusLost(java.awt.event.FocusEvent e)
Specified by:
focusLost in interface java.awt.event.FocusListener

showColorRemapDialog

public void showColorRemapDialog()
Show the color remap dialog.

processCustomEvent

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

getGlobalVariable

public java.lang.String getGlobalVariable(java.lang.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(java.lang.String, java.lang.String), removeGlobalVariable(java.lang.String), setAllGlobalVariables(java.util.Properties)

setGlobalVariable

public void setGlobalVariable(java.lang.String gvName,
                              java.lang.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(java.lang.String), removeGlobalVariable(java.lang.String), setAllGlobalVariables(java.util.Properties), getAllGlobalVariables()

removeGlobalVariable

public void removeGlobalVariable(java.lang.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(java.lang.String, java.lang.String), getGlobalVariable(java.lang.String), setAllGlobalVariables(java.util.Properties), getAllGlobalVariables()

getAllGlobalVariables

public java.util.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(java.util.Properties), setGlobalVariable(java.lang.String, java.lang.String), getGlobalVariable(java.lang.String), removeGlobalVariable(java.lang.String)

setAllGlobalVariables

public void setAllGlobalVariables(java.util.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(java.lang.String, java.lang.String), getGlobalVariable(java.lang.String), removeGlobalVariable(java.lang.String)

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(), SCCustomComponent#writeGlobalVariable, SCCustomComponent#readGlobalVariable

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(), SCCustomComponent#writeGlobalVariable, SCCustomComponent#readGlobalVariable

saveSessionInfoBeforeIPMon

public void saveSessionInfoBeforeIPMon()

getHostBeforeIPMon

public java.lang.String getHostBeforeIPMon()

getPortBeforeIPMon

public int getPortBeforeIPMon()

setHODKeyRemap

public void setHODKeyRemap(KeyRemap hodKeyRemap)

setIsMacroKey

public void setIsMacroKey(boolean isMacro)

getIsMacroKey

public boolean getIsMacroKey()

setIsFileMacroKey

public void setIsFileMacroKey(boolean isFileMacro)

getIsFileMacroKey

public boolean getIsFileMacroKey()