se.entra.phantom.server

Class VirtualRuntime

java.lang.Object

se.entra.phantom.server.PhantomRuntime

se.entra.phantom.server.VirtualRuntime

All Implemented Interfaces:

Cloneable, NetPhantomConstants

Direct Known Subclasses:

GuiOnTheFlyRuntime

public class VirtualRuntime
extends PhantomRuntime

This class is derived from PhantomRuntime and is the one used with any virtual component. The instance of the virtual runtime inherits all members from the PhantomRuntime class and can then change the text file and translation table.

Nested Class Summary

Nested classes/interfaces inherited from class se.entra.phantom.server.PhantomRuntime

PhantomRuntime.FileErrors

Field Summary

Fields inherited from class se.entra.phantom.server.PhantomRuntime

doReplaceProgramText, file, FILE_INI, FILE_JAR, FILE_OTHER, FILE_PHA, FILE_PHE, FILE_PHR, FILE_PHW, FILE_UNDEFINED, fileName, inputFile

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

Constructor Summary

Constructors

Constructor and Description
VirtualRuntime(PhantomRuntime rt, int index) Creates a new instance of the runtime based upon a PhantomRuntime instance.
VirtualRuntime(PhantomRuntime rt, int index, String applicationID) Creates a new instance of the runtime based upon a PhantomRuntime instance.

Method Summary

Modifier and Type	Method and Description
boolean	changeTextFile(ClientSessionInterface clientSession, String fn) Changes the text file.
boolean	changeTranslationTable(String fn) Changes the translation table file.
String	getApplicationFile(String path) Returns a file relative to the location of the application; for NP5, in the application root.
String	getApplicationID() Gets the application ID for the client, null if not defined.
int	getIndex() Gets the index of this runtime application for this particular client.
PhantomRuntime	getPhantomRuntime() Gets the instance of the PhantomRuntime class that originally created this VirtualRuntime instance.
VirtualRuntimePopupMenu	getPopupMenu(PhantomPopupMenu ppm) Gets a pop-up menu from the runtime.
boolean	isInitialized() Initialize the runtime application.
String	mapIDToString(int id) Gets the mapping of the registered string to an ID.
int	mapStringToID(String string) Gets the mapping of the registered string to an ID.
boolean	registerStringID(String string, int id) Registers a string ID and a numbered ID for the application.
void	resetChange() Reset the internal state for runtimes which are switched between.
void	setAsCurrent(ClientSessionInterface clientSession) Sets this application as the current one for the client.
void	setInitialized() Sets the application as initialized.
boolean	setResourceURL(String url) Indicates a resource URL (empty string or null for none).
void	useLanguageTextFile(String language) Tries to load/use a language specific text file.

Methods inherited from class se.entra.phantom.server.PhantomRuntime

addFileError, cleanOutputFolder, clone, compileDistribution_setIniFile, createClassLoader, createRuntime, createRuntime, doIgnoreNonFatalErrors, doValidateUser, getApplicationBaseName, getApplicationData, getApplicationDirectory, getApplicationDirectoryFile, getAutoClientJar, getBackgroundLoader, getBinaryDirectory, getBinaryDirectoryFile, getClassLoader, getClienExternalFileEntries, getClientJarEntries, getCodepageConverter, getComboboxFileName, getComboboxFileName2, getCurrentFile, getEncoding, getErrorsMap, getExistingHelpDocumentForID, getFile, getFile, getFileErrors, getFileTable, getHelpDocument, getHelpIDTable, getHostData, getImageReferencesValidator, getIniFile, getJarFile, getMonitorCount, getPhantomFileFromJar, getProjectDirectoryFile, getProjectName, getReloadedApplicationData, getSourceDirectory, getSourceDirectoryFile, getTargetServerVersion, getTextfileTable, getTextID, getTooltipFileName, getTooltipTextTable, getTranslationTable, hasClientExternalFiles, hasFileErrors, hasRuntimeFileChanged, isApplicationContainingJavaSources, isBusyLoading, isEnabled, isExternalComboboxFilesAllowed, isLoadedForEditor, isLoadedFromINI, isLoadedFromJAR, isSeeminglyValid, isVersion6, listUnresolvedFileErrors, loadClass, loadHelpIDFile, loadTextFile, loadTextFile, loadTextFile, loadTooltipTextFile, maybeThrowIOException, maybeThrowIOException, needsReload, reload, reportPotentialErroredFiles, setComboboxFileName, setDoIgnoreNonFatalErrors, setEclipseWorkspace, setEnabled, setExternalComboboxFilesAllowed, setLoadedForEditor, setTextFile, setTooltipTextTable, setTranslationTable, translateText

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualRuntime

public VirtualRuntime(PhantomRuntime rt,
                      int index)

Creates a new instance of the runtime based upon a PhantomRuntime instance. All members are copied from that instance. After this, the changeTextFile and changeTranslationTable methods can be used to change the respective file.

VirtualRuntime

public VirtualRuntime(PhantomRuntime rt,
                      int index,
                      String applicationID)

Creates a new instance of the runtime based upon a PhantomRuntime instance. All members are copied from that instance. After this, the changeTextFile and changeTranslationTable methods can be used to change the respective file.

Method Detail

getApplicationID

public String getApplicationID()

Gets the application ID for the client, null if not defined.

setResourceURL

public boolean setResourceURL(String url)

Indicates a resource URL (empty string or null for none). This is used for SecureLogin, UserAuth and ServerAdmin.

getIndex

public int getIndex()

Gets the index of this runtime application for this particular client.

changeTextFile

public boolean changeTextFile(ClientSessionInterface clientSession,
                              String fn)

Changes the text file.

Returns:

true = successful, false = failure.

changeTranslationTable

public boolean changeTranslationTable(String fn)

Changes the translation table file.

Returns:

true = successful, false = failure.

getPopupMenu

public VirtualRuntimePopupMenu getPopupMenu(PhantomPopupMenu ppm)

Gets a pop-up menu from the runtime. The menu data has already been sent to the client, why only updates to the pop-up menu is required.

resetChange

public void resetChange()

Reset the internal state for runtimes which are switched between.

setAsCurrent

public void setAsCurrent(ClientSessionInterface clientSession)

Sets this application as the current one for the client. If the client has been informed of the runtime data, no change will be done, unless some runtime data (e.g. the application title has changed.

isInitialized

public boolean isInitialized()

Initialize the runtime application. If the application already has been initialized, nothing more will be done.

setInitialized

public void setInitialized()

Sets the application as initialized.

registerStringID

public boolean registerStringID(String string,
                                int id)

Registers a string ID and a numbered ID for the application. This ID must be unique in combination with the string in question.

Note: The range of the id is 1-32767. The length of the string must be greater than zero. Normally, the strings are in upper case and has a maximum length of eight, but this is not checked (as the ID value).

Returns:

true for success
false for failure (when failed, an error message is displayed on System.out).

mapStringToID

public int mapStringToID(String string)

Gets the mapping of the registered string to an ID.

Returns:

-1 for string not found, otherwise the registered ID.

See Also:

registerStringID(java.lang.String, int)

mapIDToString

public String mapIDToString(int id)

Gets the mapping of the registered string to an ID.

Returns:

null for string not found, otherwise the registered string.

See Also:

registerStringID(java.lang.String, int)

useLanguageTextFile

public void useLanguageTextFile(String language)

Tries to load/use a language specific text file. If successful, it is added as possible candidate to be used for a client session. The file name of the text file should be e.g. TERMINAL_de.PHM for Germany.

The parameter "language" should be e.g. "de" for Germany.

If the language file has been loaded or failed previously, nothing will be done.

getPhantomRuntime

public PhantomRuntime getPhantomRuntime()

Gets the instance of the PhantomRuntime class that originally created this VirtualRuntime instance.

getApplicationFile

public String getApplicationFile(String path)

Returns a file relative to the location of the application; for NP5, in the application root. For NP6, in the dedicated "app" directory.

Parameters:

path - File path.

Returns:

String for the application-relative path that may be absolute.