se.entra.phantom.server

Class TerminalFunctions

java.lang.Object

se.entra.phantom.server.TerminalFunctions

All Implemented Interfaces:

NetPhantomConstants

public class TerminalFunctions
extends Object
implements NetPhantomConstants

This class handles the "advanced" terminal functions. It provides the functions needed to perform the user interaction with the terminal such as clip board operations, current user properties, etc.

Field Summary

Fields inherited from interface se.entra.phantom.common.NetPhantomConstants

ACTION_CLOSEWINDOW, ACTION_CONTROL, ACTION_HOSTKEY, ACTION_MENU, ACTION_NONE, ACTION_NOTEBOOKPAGE, ACTION_POPUPMENU, CC_BACKGROUND, CC_BOTH, CC_FOREGROUND, CC_NONE, CLIPBOARD_GET, CLIPBOARD_SET, DATEF_DMY, DATEF_MDY, DATEF_SYSTEM, DATEF_YMD, DDE_ADVISE, DDE_EXECUTE, DDE_INITIATE, DDE_POKE, DDE_REQUEST, DDE_TERMINATE, DDE_UNADVISE, DDE_UPDATE, DDEVAR_DISABLE, DDEVAR_ENABLE, DDEVAR_REQUEST, DDEVAR_SET, DDEVAR_VALIDATE, EFT_AMOUNT, EFT_DATE, EFT_DATEAMOUNT, EFT_NORMAL, EFT_PASSWORD, EVENT_CHAR, EVENT_CHECK, EVENT_CLICK, EVENT_COMMAND, EVENT_DBLCLICK, EVENT_DDECONNECTION, EVENT_DDEDATA, EVENT_DDEERROR, EVENT_DDEEXECUTE, EVENT_DDEINVALIDATE, EVENT_DDEPOKE, EVENT_DDEREQUEST, EVENT_DEFOCUS, EVENT_FOCUS, EVENT_PAGEDOWN, EVENT_PAGEUP, EVENT_SELECT, EVENT_UNKNOWN, EVENT_USERCHANGE, EXTENDEDINFO_IDS_TO_CLIENT, FOCUSTYPE_CLIENTTARGET, FOCUSTYPE_CONTROL, FOCUSTYPE_NONE, ICON_CRITICAL, ICON_INFORMATION, ICON_NOICON, ICON_QUERY, ICON_WARNING, J_AUTO, J_BOTTOM, J_BOTTOMLEFT, J_BOTTOMRIGHT, J_CENTER, J_LEFT, J_RIGHT, J_TOP, J_TOPLEFT, J_TOPRIGHT, MAX_PANELS_PER_SESSION, MAX_SESSIONS, MB_ABORTRETRYIGNORE, MB_CANCEL, MB_ENTER, MB_ENTERCANCEL, MB_OK, MB_OKCANCEL, MB_RETRYCANCEL, MB_YESNO, MB_YESNOCANCEL, MBID_CANCEL, MBID_DEFAULT, MBID_ENTER, MBID_IGNORE, MBID_NO, MBID_OK, MBID_RETRY, MBID_YES, MS_MOVE, MS_NONE, MS_SIZE, NETPHANTOM_COPYRIGHT, NETPHANTOM_COPYRIGHT2, NETPHANTOM_VERSION, OBJEVENT_CHECK, OBJEVENT_CLICK, OBJEVENT_DBLCLICK, OBJEVENT_DEFOCUS, OBJEVENT_FOCUS, OBJEVENT_SELECT, OBJEVENT_USERCHANGE, PANELCREATE_APPPANEL, PANELCREATE_DANGLINGPANEL, PANELCREATE_DLGFRAME, PANELCREATE_EXTENDEDINFO, PANELCREATE_ICON, PANELCREATE_INDIVIDUALSIZE, PANELCREATE_POPUP, REPLYTYPE_CLIENTEXECUTE, REPLYTYPE_CLIPBOARD, REPLYTYPE_DDE, REPLYTYPE_FFONTLIST, REPLYTYPE_MESSAGEBOX, REPLYTYPE_REPORT, REPLYTYPE_SAVEPROPS, REPLYTYPE_TERMMARK, RPRT_CANCELPRINTJOB, RPRT_CLOSEPRINTJOB, RPRT_CONTPRINTJOB, RPRT_OPENPRINTJOB, RPRT_PRINTJOBCANCLD, RPRT_PRINTJOBCLOSED, RPRT_PRINTJOBCONT, RPRT_PRINTJOBOPENED, RPRT_PRINTJOBSTARTED, RPRT_STARTPRINTJOB, SELMODE_NORMAL, SELMODE_NOTALLOWED, SELMODE_REQUIRED, SELTYPE_MULTIPLE, SELTYPE_SINGLE, SEPARATOR, SEPARATORCHAR, TRANS_APPLICATIONCHANGE, TRANS_CALLOBJECT, TRANS_CANCELEXIT, TRANS_CLEARLOCK, TRANS_CLIENTEXECUTE, TRANS_CLIENTJARS, TRANS_CLIENTTEXTTABLE, TRANS_CLIENTUPDATED, TRANS_CLIENTUPDATEDNOLOCK, TRANS_CLIPBOARD, TRANS_CLIPBOARDCOMPONENT, TRANS_CLOSETERMINALWINDOW, TRANS_CONNECTIONREFUSED, TRANS_COUNTRYINFO, TRANS_CREATEPANEL, TRANS_CREATESESSION, TRANS_DDE, TRANS_DDEEVENT, TRANS_DDEEVENTREPLY, TRANS_DDEVAREVENT, TRANS_DISPLAYHELP, TRANS_DISPLAYTERMINAL, TRANS_DISPLAYTOOLTIPS, TRANS_ENDCONVERSATION, TRANS_EXIT, TRANS_FONTSUBSTITUTION, TRANS_HOSTCOLORTABLE, TRANS_HOSTPRINT, TRANS_HWND, TRANS_INACTIVESESSION, TRANS_INITIATE, TRANS_KEEPALIVE, TRANS_LOCALE, TRANS_LOGEVENT, TRANS_MESSAGEBOX, TRANS_MESSAGEBOXWITHREPLY, TRANS_MODALREPLY, TRANS_MULTTERM, TRANS_PING, TRANS_PRINTCOMPONENT, TRANS_PRINTPANEL, TRANS_PRINTREPORT, TRANS_PRTWINKEY, TRANS_RECONNECT, TRANS_REDIRECTION, TRANS_REMOVEPANELATLEVEL, TRANS_REMOVETERMINAL, TRANS_RENEGOTIATESSL, TRANS_REQUESTHELP, TRANS_RESOURCEURL, TRANS_SELECTSESSION, TRANS_SESSIONACTIVE, TRANS_SESSIONSELECTED, TRANS_SETCOLORS, TRANS_SETFOCUS, TRANS_SETLOCK, TRANS_SETPANELNESTLEVEL, TRANS_SETUPPARAMS, TRANS_SHOWDOCUMENT, TRANS_SOCKET, TRANS_SOUNDALARM, TRANS_STARTUPINFO, TRANS_STOPSESSION, TRANS_TERMINALDATA, TRANS_TERMINALUPDATE, TRANS_TERMINALWINDOW, TRANS_TERMWINTEXT, TRANS_UPDATEAPPLICATION, TRANS_UPDATEPANEL, TRANS_USEREXITPRTKEY, TRANSACTION_VERSION, TS_CLOSE, TS_DATA, TS_ERROR, TS_OPEN, VSIGN_MINUS, VSIGN_NONE, VSIGN_PLUSMINUS, YEARF_6DIG, YEARF_8DIG, YEARF_EXP8

Method Summary

Modifier and Type	Method and Description
boolean	displayEditProperties() Displays the TerminalApplication "Edit properties" dialog box in a modal fashion.
void	enableCutCopyAppend(boolean on) Enables or disables the menu items Cut/Copy/Append.
Vector<String>	getClientFixedFontList() Gets available fixed fonts available on the client that can be used in the terminal window.
Hashtable<String,String>	getClientProperties() Gets the current properties for the client.
Rectangle	getClientTerminalMark() Gets the current mark rectangle in the client terminal window.
String	getHostScreenLine(int x, int y, int cx) Get a line from the terminal screen.
String	performPaste(String data) Performs a paste operation.
void	performPrintWindow() Performs a print window of the terminal screen.
boolean	performTerminalClear(int x, int y, int cx, int cy) Performs a clear operation in the terminal screen.
String	performTerminalCopy(int x, int y, int cx, int cy) Performs a copy operation to a clip board string for terminal screen.
void	removeClientTerminalMark() Removes the rectangle mark on the client terminal.
String	saveClientProperties() Call this method to save the properties on the client.
void	setClientTerminalMarkSelectAll() Selects all screen on the client terminal screen.
static String	stripCR(String data) Strips a clip board string from any CR characters when using the clip board for Paste operations (Paste and Continue Paste).
void	updateClientTerminalSettings() Updates the terminal session on the client side with new settings and colors.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

stripCR

public static String stripCR(String data)

Strips a clip board string from any CR characters when using the clip board for Paste operations (Paste and Continue Paste).

displayEditProperties

public boolean displayEditProperties()

Displays the TerminalApplication "Edit properties" dialog box in a modal fashion. This dialog box is not displayed if the option is not enabled.

Returns:

true to continue the operation or false to abort.

performTerminalCopy

public String performTerminalCopy(int x,
                                  int y,
                                  int cx,
                                  int cy)

Performs a copy operation to a clip board string for terminal screen.

Returns:

null if the operation could not be completed due to invalid host session or parameters.

getHostScreenLine

public String getHostScreenLine(int x,
                                int y,
                                int cx)

Get a line from the terminal screen.

Returns:

null if the operation could not be completed due to invalid host session or parameters.

performTerminalClear

public boolean performTerminalClear(int x,
                                    int y,
                                    int cx,
                                    int cy)

Performs a clear operation in the terminal screen.

Returns:

false if the operation could not be completed due to invalid host session or parameters, true otherwise.

performPaste

public String performPaste(String data)

Performs a paste operation. The dataOffset

Returns:

the rest of the clip board data that couldn't be pasted (in order to perform another Continue paste operation), or null for failure.

getClientTerminalMark

public Rectangle getClientTerminalMark()

Gets the current mark rectangle in the client terminal window. This is a modal processing and does not return until client has sent a result.

Returns:

null if result could not be retrieved, i.e. client goes down or not of Java client type.

removeClientTerminalMark

public void removeClientTerminalMark()

Removes the rectangle mark on the client terminal.

setClientTerminalMarkSelectAll

public void setClientTerminalMarkSelectAll()

Selects all screen on the client terminal screen.

getClientProperties

public Hashtable<String,String> getClientProperties()

Gets the current properties for the client.

Returns:

Hashtable of String keys and elements.

saveClientProperties

public String saveClientProperties()

Call this method to save the properties on the client. The client will display the error message before returning the error to the server, so the returned string can be used for e.g. logging the failure.

Returns:

an error message as a string for failures or null for OK.

getClientFixedFontList

public Vector<String> getClientFixedFontList()

Gets available fixed fonts available on the client that can be used in the terminal window.

Returns:

null for failure, otherwise a Vector of Strings.

updateClientTerminalSettings

public void updateClientTerminalSettings()

Updates the terminal session on the client side with new settings and colors.

enableCutCopyAppend

public void enableCutCopyAppend(boolean on)

Enables or disables the menu items Cut/Copy/Append.

performPrintWindow

public void performPrintWindow()

Performs a print window of the terminal screen. This printout results in a bitmap print of the entire terminal window. If the terminal screen is not displayed, no printing will occur.