se.entra.phantom.server

Class GuiOnTheFlyRuntime

java.lang.Object

se.entra.phantom.server.PhantomRuntime

se.entra.phantom.server.VirtualRuntime

se.entra.phantom.server.GuiOnTheFlyRuntime

All Implemented Interfaces:

Cloneable, NetPhantomConstants, PhantomControlType

public class GuiOnTheFlyRuntime
extends VirtualRuntime
implements PhantomControlType

The Gui-on-the-fly runtime class extends the VirtualRuntime class because it is already an instance of the set of runtime applications that the client session(s) can use. It doesn't contain any client specific data, rather information on how GUI controls, panel and color conversion should be done.

See Also:

VirtualRuntime, PhantomRuntime, ClientSessionManager.getGuiOnTheFlyRuntime()

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.server.PhantomControlType

CTRLTYPE_BUTTON, CTRLTYPE_CHECK, CTRLTYPE_COMBO, CTRLTYPE_FRAME, CTRLTYPE_GRAPH, CTRLTYPE_GROUP, CTRLTYPE_INOUT, CTRLTYPE_LIST, CTRLTYPE_MLE, CTRLTYPE_NOTE, CTRLTYPE_OUT, CTRLTYPE_RADIO, CTRLTYPE_RECT, CTRLTYPE_SPIN, CTRLTYPE_SUB, CTRLTYPE_TEXT, CTRLTYPE_TREE, CTRLTYPE_UNKNOWN, CTRLTYPE_USER, CTRLTYPES_COUNT, names

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
GuiOnTheFlyRuntime(PhantomRuntime rt) Creates a new instance of the runtime based upon a PhantomRuntime instance.

Method Summary

Modifier and Type	Method and Description
PhantomPanelData	createPanel(HostScreen hostScreen, PhantomPanelData oldPanel, VirtualSessionManager virtualSessionManager) Creates a new panel from the current host screen.
void	doIdentifyPartialFields(boolean flag) Sets the flag indicating if host fields that are partly inside the area to identify should be included or not.
Object	getAttribute(String name) Gets an attribute.
PhantomPanelData	getTemplatePanel(String panelID) Gets a template panel from the Gui-on-the-Fly template application.
VirtualSessionManager	getVirtualSessionManager() Gets a reference to the VirtualSessionManager.
boolean	isCursorInside(HostPopupWindow.Rect popupRect, Point point) Checks if the cursor is placed inside the popup window.
void	loadAreaIdentifier(String id, String name, IniFile confFile, String subsection) Loads a class for identifying a host area.
void	loadControlIdentifier(String control, String name, IniFile confFile, String subsection) Loads a class for identifying a control.
void	setAreaIdentOrder(String order) Sets the processing order for identification of areas.
void	setAttribute(String name, Object attribute) Set an attribute.
void	setHostFieldIdentifier(String name) Sets the class to use as the hostFieldIdentifier.
void	setHostScreenArea(String area) Sets the area to be identified.
void	setProcessingOrder(Vector<GofProcessingOrder> processingOrder) Sets the processing order for identification of controls.

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

changeTextFile, changeTranslationTable, getApplicationFile, getApplicationID, getIndex, getPhantomRuntime, getPopupMenu, isInitialized, mapIDToString, mapStringToID, registerStringID, resetChange, setAsCurrent, setInitialized, setResourceURL, useLanguageTextFile

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

GuiOnTheFlyRuntime

public GuiOnTheFlyRuntime(PhantomRuntime rt)

Creates a new instance of the runtime based upon a PhantomRuntime instance. All members are copied from that instance.

Parameters:

rt -

Method Detail

getTemplatePanel

public PhantomPanelData getTemplatePanel(String panelID)
                                  throws IOException

Gets a template panel from the Gui-on-the-Fly template application. The Panel ID for the panel must be specified in the gof.ini configuration file, because these panels will be preloaded during the server startup to speed up processing at runtime.

Parameters:

panelID - The name of the panel, as specified as Panel ID in the Phantom Editor.

Returns:

The PhantomPanelData for the specified panel, or null if no such panel has been identified.

Throws:

IOException

setHostFieldIdentifier

public void setHostFieldIdentifier(String name)
                            throws IOException

Sets the class to use as the hostFieldIdentifier. This class must implement the GofHostFieldIdentifier interface.

Parameters:

name - The class name for the hostFieldIdentifier.

Throws:

IOException

setHostScreenArea

public void setHostScreenArea(String area)

Sets the area to be identified.

Parameters:

area - A string containing x, y, width, height values separated by comma.

doIdentifyPartialFields

public void doIdentifyPartialFields(boolean flag)

Sets the flag indicating if host fields that are partly inside the area to identify should be included or not.

loadAreaIdentifier

public void loadAreaIdentifier(String id,
                               String name,
                               IniFile confFile,
                               String subsection)
                        throws IOException

Loads a class for identifying a host area.

Parameters:

id - The id for the area for which an identification class should be loaded.

name - The name of the class to load.

confFile - The server configuration file.

subsection - The name of the subsection for the current Gui-on-the-fly settings.

Throws:

IOException

setAreaIdentOrder

public void setAreaIdentOrder(String order)

Sets the processing order for identification of areas.

Parameters:

order - A string containing the processing order.

loadControlIdentifier

public void loadControlIdentifier(String control,
                                  String name,
                                  IniFile confFile,
                                  String subsection)
                           throws IOException

Loads a class for identifying a control.

Parameters:

control - The control for which a class should be loaded.

name - The name of the class to load.

confFile - The server configuration file.

subsection - The name of the subsection for the current Gui-on-the-fly settings.

Throws:

IOException - The class is not found, the class can't be instantiated, an illegal access exception occurs or a class cast exception occurs.

setProcessingOrder

public void setProcessingOrder(Vector<GofProcessingOrder> processingOrder)

Sets the processing order for identification of controls.

Parameters:

processingOrder - A Vector containing the processing order.

createPanel

public PhantomPanelData createPanel(HostScreen hostScreen,
                                    PhantomPanelData oldPanel,
                                    VirtualSessionManager virtualSessionManager)
                             throws IOException

Creates a new panel from the current host screen.

Parameters:

hostScreen - The current host screen.

oldPanel - The old panel created by Gui-on-the-fly (or null if no previous one exist).

Returns:

The new panel, or the oldPanel if the panel is the same as the previous one (apart from contents), or null if this is impossible, due to e.g. that the host presentation space is unformatted (no fields).

Throws:

IOException

isCursorInside

public boolean isCursorInside(HostPopupWindow.Rect popupRect,
                              Point point)

Checks if the cursor is placed inside the popup window.

Parameters:

popupRect - The rectangle representing the popup window.

point - The cursors position.

Returns:

true if the cursor is inside the popup window, false otherwise.

setAttribute

public void setAttribute(String name,
                         Object attribute)

Set an attribute. This method can be used to store global variables from one of the Gui-on-the-Fly classes, and then retreive it from another, without the need for this class to know the variables name.

Parameters:

name - The name of the attribute.

attribute - Tha attribute.

getAttribute

public Object getAttribute(String name)

Gets an attribute. This attribute must previously have been stored from one of the Gui-on-the-Fly classes.

Returns:

The saved attribute, or null if no such attribute is stored.

getVirtualSessionManager

public VirtualSessionManager getVirtualSessionManager()

Gets a reference to the VirtualSessionManager.

Returns:

The VirtualSessionManager.