com.ibm.eNetwork.HOD.customizable
Interface HODDisplaySession

All Superinterfaces:

HODSession

public interface HODDisplaySession

extends HODSession

Field Summary

Fields inherited from interface com.ibm.eNetwork.HOD.customizable.HODSession

FUNCTION_ALLOWED, FUNCTION_DISABLED, FUNCTION_EXECUTED, FUNCTION_INVALID, FUNCTION_NOT_ALLOWED, STRING_RETURN_CODES

Method Summary

javax.swing.JPanel	getKeyPad() Gets the KeyPad component used by the session.
com.ibm.eNetwork.beans.HOD.MacroManager	getMacroManager() Gets the MacroManager (which is a JPanel) component used by the session.
com.ibm.eNetwork.beans.HOD.Terminal	getTerminal() Gets the Terminal (which is a JPanel) component used by the session.
javax.swing.JPanel	getTextOIA() Gets the Textual OIA
javax.swing.JPanel	getToolbar() Gets the toolbar component used by the session.
boolean	isButtonBarVisible() Returns true if the session is configured to start with button bar visible.
boolean	isKeypadVisible() Returns true if the session is configured to start with keypad visible.
boolean	isMacroManagerVisible() Returns true if the session is configured to start with macro manager visible.
boolean	isTextualOIAVisible() Returns true if the session is configured to start with Textual OIA visible.
java.lang.String[]	listMacros() Returns an array of names of Macros defined for this session.
int	playMacro(java.lang.String name) Causes the Host On-Demand session to play the specified macro if allowed.
int	playMacro(java.lang.String name, java.util.Properties prop) Causes the Host On-Demand session to play the specified macro with specified parameters if allowed.
int	showColorRemap() Brings up the Color Remap dialog for the session if allowed.
int	showCustomizePoppad() Brings up the Customize Poppad dialog for the session if allowed.
int	showDataTransferDefaults() Brings up the Data Transfer Defaults panel for the session.
int	showDisplayAttributes() Brings up the Display attributes dialog for the session if allowed.
int	showEditPanel() Brings up the Edit Panel for the session.
int	showFileTransferDefaults() Brings up the File Transfer Defaults panel for the session.
int	showKeyRemap() Brings up the KeyRemap dialog for the session.
int	showMouseWheel() Brings up the Mouse Wheel dialog for the session if allowed.
int	showPlayMacro() Brings up the Play Macro dialog for the session if allowed.
int	showPoppad() Brings up the Poppad for the session if allowed.
int	showReceiveData() Brings up the panels to Receive Data from a Host.
int	showReceiveFiles() Brings up the panels to Receive Files from a host.
int	showRecordMacro() Brings up the Record Macro dialog for the session if allowed.
int	showRecordMacro(java.lang.String name, java.lang.String desc) Brings up the Record Macro dialog for the session if allowed with name and description fields filled in.
int	showRunApplet() Brings up the Run Applet panel for the session.
int	showSendData() Brings up the panels to Send Data to a host.
int	showSendFiles() Brings up the panels to Send Files to a host.
int	showURLHotspots() Brings up the URL Hotspots panel for the session.

Methods inherited from interface com.ibm.eNetwork.HOD.customizable.HODSession

close, connect, disconnect, getHODMenubar, getStatusBar, isConnected, isStatusBarVisible, showProblemDetermination

Method Detail

getToolbar

public javax.swing.JPanel getToolbar()

Gets the toolbar component used by the session. It is a java.awt.Panel for the JDK 1.1 code.

getTerminal

public com.ibm.eNetwork.beans.HOD.Terminal getTerminal()

Gets the Terminal (which is a JPanel) component used by the session. It is a java.awt.Panel for the JDK 1.1 code. For more information on the capabilities of a Terminal object, you will need to install the Host Access Toolkit.

getMacroManager

public com.ibm.eNetwork.beans.HOD.MacroManager getMacroManager()

Gets the MacroManager (which is a JPanel) component used by the session. It is a java.awt.Panel for the JDK 1.1 code. For more information on the capabilities of a MacroManager object, you will need to install the Host Access Toolkit.

getTextOIA

public javax.swing.JPanel getTextOIA()

Gets the Textual OIA

getKeyPad

public javax.swing.JPanel getKeyPad()

Gets the KeyPad component used by the session. It is a java.awt.Panel for the JDK 1.1 code.

playMacro

public int playMacro(java.lang.String name)
              throws com.ibm.eNetwork.beans.HOD.MacroException

Causes the Host On-Demand session to play the specified macro if allowed.

Parameters:

name - Name of the macro to play (case-sensitive)

Throws:

com.ibm.eNetwork.beans.HOD.MacroException - Thrown by session if there is an error.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

playMacro

public int playMacro(java.lang.String name,
                     java.util.Properties prop)
              throws com.ibm.eNetwork.beans.HOD.MacroException

Causes the Host On-Demand session to play the specified macro with specified parameters if allowed. The current session, personal library and server library will be searched, if allowed.

Parameters:

name - Name of the macro to play

prop - Properties object containing macro parameters

Each entry in the Properties object should consist of a primitive macro variable name (without the leading and trailing '$') and its initial value.

Throws:

com.ibm.eNetwork.beans.HOD.MacroException - Thrown by session if there is an error.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showPlayMacro

public int showPlayMacro()

Brings up the Play Macro dialog for the session if allowed.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showRecordMacro

public int showRecordMacro()

Brings up the Record Macro dialog for the session if allowed.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

listMacros

public java.lang.String[] listMacros()

Returns an array of names of Macros defined for this session. Macros in the personal library, server library, or user libraries are not included.

showColorRemap

public int showColorRemap()

Brings up the Color Remap dialog for the session if allowed.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showMouseWheel

public int showMouseWheel()

Brings up the Mouse Wheel dialog for the session if allowed.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showPoppad

public int showPoppad()

Brings up the Poppad for the session if allowed.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showCustomizePoppad

public int showCustomizePoppad()

Brings up the Customize Poppad dialog for the session if allowed.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showDisplayAttributes

public int showDisplayAttributes()

Brings up the Display attributes dialog for the session if allowed.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showKeyRemap

public int showKeyRemap()

Brings up the KeyRemap dialog for the session.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showFileTransferDefaults

public int showFileTransferDefaults()

Brings up the File Transfer Defaults panel for the session.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showSendFiles

public int showSendFiles()

Brings up the panels to Send Files to a host.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showReceiveFiles

public int showReceiveFiles()

Brings up the panels to Receive Files from a host.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showDataTransferDefaults

public int showDataTransferDefaults()

Brings up the Data Transfer Defaults panel for the session.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showSendData

public int showSendData()

Brings up the panels to Send Data to a host.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showReceiveData

public int showReceiveData()

Brings up the panels to Receive Data from a Host.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showEditPanel

public int showEditPanel()

Brings up the Edit Panel for the session.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showRunApplet

public int showRunApplet()

Brings up the Run Applet panel for the session.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showURLHotspots

public int showURLHotspots()

Brings up the URL Hotspots panel for the session.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showRecordMacro

public int showRecordMacro(java.lang.String name,
                           java.lang.String desc)

Brings up the Record Macro dialog for the session if allowed with name and description fields filled in.

Parameters:

name - Name of the macro

desc - Description of the macro

isButtonBarVisible

public boolean isButtonBarVisible()

Returns true if the session is configured to start with button bar visible.

Returns:

true if the session is configured to start with button bar visible.

isKeypadVisible

public boolean isKeypadVisible()

Returns true if the session is configured to start with keypad visible.

Returns:

true if the session is configured to start with keypad visible.

isMacroManagerVisible

public boolean isMacroManagerVisible()

Returns true if the session is configured to start with macro manager visible.

Returns:

true if the session is configured to start with macro manager visible.

isTextualOIAVisible

public boolean isTextualOIAVisible()

Returns true if the session is configured to start with Textual OIA visible.

Returns:

true if the session is configured to start with textual OIA visible.