com.ibm.eNetwork.HOD.customizable
Interface HODDisplaySession

All Superinterfaces:
HODSession

public interface HODDisplaySession
extends HODSession


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.
 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 showColorRemap()
          Brings up the Color Remap dialog for the session if allowed.
 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 showPlayMacro()
          Brings up the Play Macro dialog for the session if allowed.
 int showReceiveFiles()
          Brings up the panels to Receive Files from a Host for the session.
 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 showSendFiles()
          Brings up the panels to Send Files to Host for the session.
 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, 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
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

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


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 Host 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


showReceiveFiles

public int showReceiveFiles()
Brings up the panels to Receive Files from a Host 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


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
author - Author of the macro

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