se.entra.phantom.server

Class VirtualPanelSession

java.lang.Object

se.entra.phantom.server.VirtualPanelSession

All Implemented Interfaces:

NetPhantomConstants, ObjectMessages, PhantomControlType

public class VirtualPanelSession
extends Object
implements NetPhantomConstants, PhantomControlType, ObjectMessages

Each client session has at least on panel session. If the runtime application has an MDI interface (an application panel), there will be several VirtualPanelSession instances.

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

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

OBJACT_CHAR, OBJACT_CHECK, OBJACT_CLICK, OBJACT_CLOSE, OBJACT_COMMAND, OBJACT_CREATE, OBJACT_DBLCLICK, OBJACT_DDECONNECTION, OBJACT_DDEDATA, OBJACT_DDEERROR, OBJACT_DDEEXECUTE, OBJACT_DDEPOKE, OBJACT_DDEREQUEST, OBJACT_DDEVALIDATE, OBJACT_DEFOCUS, OBJACT_DESTROY, OBJACT_FOCUS, OBJACT_HIDDEN, OBJACT_HOSTCHANGE, OBJACT_LAST_MESSAGE_HANDLED, OBJACT_QUERYMSG, OBJACT_RECREATE, OBJACT_SELECT, OBJACT_SHOW, OBJACT_START, OBJACT_TRANSLATE, OBJACT_USERCHANGE, PHA_ICO_INFO, PHA_ICO_NOICON, PHA_ICO_QUESTION, PHA_ICO_STOP, PHA_ICO_WARNING, PHA_MSG_CANCEL, PHA_MSG_ENTER, PHA_MSG_ENTERCANCEL, PHA_MSG_OK, PHA_MSG_OKCANCEL, PHA_MSG_RETIGNCANCEL, PHA_MSG_RETRYCANCEL, PHA_MSG_YESNO, PHA_MSG_YESNOCANCEL

Method Summary

Modifier and Type	Method and Description
boolean	appendFocusTransaction(Transaction trans) Appends the required data focus a focus transaction.
boolean	cancelNotebookPaging() Cancel notebook paging.
VirtualPanel	createPanel(String panel) Creates the specified panel.
VirtualPanel	createPanel(String panel, PhantomHostScreen screen) Creates the specified panel.
VirtualPanel	createPanel(String panel, PhantomHostScreen screen, VirtualPanelListener listener) Creates the specified panel.
VirtualPanel	createPanel(String panel, PhantomHostScreen screen, VirtualPanelListener listener, Transaction extraPanelTransaction) Creates the specified panel.
VirtualPanel	createPanel(String panel, PhantomHostScreen screen, VirtualPanelListener listener, Transaction extraPanelTransaction, boolean doCallCreate) Creates the specified panel.
boolean	destroyPanelAtIndex(int ii) Destroys a panel at a certain index.
boolean	destroyTopmostPanel() Destroy the topmost popup panel.
Object	getComponentLockObject() Gets the lock object for synchronization for Control Components.
VirtualPanel	getCreatingPanel() Gets the creating panel if it is in progress.
PhantomHostScreen	getCurrentHostScreen() Gets the current matching host screen.
VirtualPanel	getDanglingPanel(int index) Gets a dangling panel.
VirtualCNoteBook	getFirstNotebook() Search for the first occurrence of a notebook in all panels.
VirtualControl	getFocusControl() Get the control that has focus or null if none.
VirtualPanel	getFocusPanel() Gets the focus panel (null for none).
int	getHostSessionIndex() Gets the host session index for this panel session.
String	getID() Gets the ID of the session.
int	getIndex() Gets the session index.
VirtualPanel	getPanel(int ii) Gets a panel at a specified index.
int	getPanelCount() Gets the current panel count of the session.
GlobalVariable	getSessionVariables() Get session variable object.
VirtualPanel	getTopmostPanel() Get topmost panel.
VirtualInterface	getVirtualComponentFromID(String panelID, String ctrlMenuID) Get control, menu item or special information.
VirtualSessionManager	getVirtualSessionManager() Gets the virtual session manager.
void	inhibitHostProcessing(boolean inhibit) Inhibits or releases the host processing of panels.
boolean	isHostMessageBoxRefreshRequired() Sets the host message box refresh required flag.
boolean	isHostProcessingInhibited() Indicates that the host connection is inhibited.
boolean	isMacroPlaying() Access the flag for macro is playing.
boolean	preloadPanel(String panel, VirtualPanel vp) Preloads a panel in the current session.
void	select() Selects this session to foreground.
boolean	sessVarDelete(String name) Deletes a session variable.
String	sessVarGet(String name) Gets the contents of a session variable.
boolean	sessVarSet(String name, String data) Sets a session variable.
void	setChanged() The panel session passes on the change state to the client session.
boolean	setCursorFromHost(int flags) Places the cursor in the panel in the same position it has in the terminal session.
void	setHostCursorPositioningRequired() Sets the host cursor position flag required.
void	setHostMessageBoxRefreshRequired() Sets the host message box refresh required flag.
boolean	setPanelFromHostField(String[] panelNames) Places the cursor in the panel in the same position it has in the terminal session.
void	stop() Stops this session.

Methods inherited from class java.lang.Object

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

Method Detail

getHostSessionIndex

public int getHostSessionIndex()

Gets the host session index for this panel session.

Returns:

-1 if no special session is assigned, always -1 when session is in foreground.

getDanglingPanel

public VirtualPanel getDanglingPanel(int index)

Gets a dangling panel.

Returns:

null if not found.

getCurrentHostScreen

public PhantomHostScreen getCurrentHostScreen()

Gets the current matching host screen.

getVirtualSessionManager

public VirtualSessionManager getVirtualSessionManager()

Gets the virtual session manager.

getID

public String getID()

Gets the ID of the session.

getIndex

public int getIndex()

Gets the session index.

getPanel

public VirtualPanel getPanel(int ii)

Gets a panel at a specified index.

Returns:

null if not created.

getPanelCount

public int getPanelCount()

Gets the current panel count of the session.

getComponentLockObject

public Object getComponentLockObject()

Gets the lock object for synchronization for Control Components.

getTopmostPanel

public VirtualPanel getTopmostPanel()

Get topmost panel.

Returns:

null if no panel.

setHostCursorPositioningRequired

public void setHostCursorPositioningRequired()

Sets the host cursor position flag required.

setHostMessageBoxRefreshRequired

public void setHostMessageBoxRefreshRequired()

Sets the host message box refresh required flag.

isHostMessageBoxRefreshRequired

public boolean isHostMessageBoxRefreshRequired()

Sets the host message box refresh required flag.

getSessionVariables

public GlobalVariable getSessionVariables()

Get session variable object.

sessVarSet

public boolean sessVarSet(String name,
                          String data)

Sets a session variable.

Returns:

true=success, false=failure.

sessVarGet

public String sessVarGet(String name)

Gets the contents of a session variable. If the variable is not found, null is returned.

sessVarDelete

public boolean sessVarDelete(String name)

Deletes a session variable.

Returns:

true=success, false=failure.

setChanged

public void setChanged()

The panel session passes on the change state to the client session.

isMacroPlaying

public boolean isMacroPlaying()

Access the flag for macro is playing.

inhibitHostProcessing

public void inhibitHostProcessing(boolean inhibit)

Inhibits or releases the host processing of panels. The current session is notified of this change.

isHostProcessingInhibited

public boolean isHostProcessingInhibited()

Indicates that the host connection is inhibited.

stop

public void stop()

Stops this session.

select

public void select()

Selects this session to foreground.

createPanel

public VirtualPanel createPanel(String panel)

Creates the specified panel. The panel will be host connected to the currently matching screen.

Returns:

null if the panel could not found.

createPanel

public VirtualPanel createPanel(String panel,
                                PhantomHostScreen screen)

Creates the specified panel. The host screen may be null if the panel has no host connection or no screen associated with it.

Returns:

null if the panel could not found.

createPanel

public VirtualPanel createPanel(String panel,
                                PhantomHostScreen screen,
                                VirtualPanelListener listener)

Creates the specified panel. The host screen may be null if the panel has no host connection or no screen associated with it. The listener of the panel may be null if this is not required.

Returns:

null if the panel could not found.

createPanel

public VirtualPanel createPanel(String panel,
                                PhantomHostScreen screen,
                                VirtualPanelListener listener,
                                Transaction extraPanelTransaction)

Creates the specified panel. The host screen may be null if the panel has no host connection or no screen associated with it. The listener of the panel may be null if this is not required.

Returns:

null if the panel could not found.

createPanel

public VirtualPanel createPanel(String panel,
                                PhantomHostScreen screen,
                                VirtualPanelListener listener,
                                Transaction extraPanelTransaction,
                                boolean doCallCreate)

Creates the specified panel. The host screen may be null if the panel has no host connection or no screen associated with it. The listener of the panel may be null if this is not required.

Returns:

null if the panel could not found.

getCreatingPanel

public VirtualPanel getCreatingPanel()

Gets the creating panel if it is in progress. This is typically used when onPanelDestroy is called when a main panel is removed and replaced with a new one.

preloadPanel

public boolean preloadPanel(String panel,
                            VirtualPanel vp)

Preloads a panel in the current session.

Returns:

true = success.

destroyPanelAtIndex

public boolean destroyPanelAtIndex(int ii)

Destroys a panel at a certain index.

Returns:

false for failure, true for success.

destroyTopmostPanel

public boolean destroyTopmostPanel()

Destroy the topmost popup panel.

Returns:

false for error, true if OK.

getVirtualComponentFromID

public VirtualInterface getVirtualComponentFromID(String panelID,
                                                  String ctrlMenuID)

Get control, menu item or special information. Returns VirtualInterface.

setCursorFromHost

public boolean setCursorFromHost(int flags)

Places the cursor in the panel in the same position it has in the terminal session.

Returns:

true for success and false for error

setPanelFromHostField

public boolean setPanelFromHostField(String[] panelNames)

Places the cursor in the panel in the same position it has in the terminal session. This method is called from REXX.

Returns:

true for success and false for error

getFirstNotebook

public VirtualCNoteBook getFirstNotebook()

Search for the first occurrence of a notebook in all panels.

Returns:

null if not found.

cancelNotebookPaging

public boolean cancelNotebookPaging()

Cancel notebook paging.

Returns:

true for OK, or false for error.

getFocusPanel

public VirtualPanel getFocusPanel()

Gets the focus panel (null for none).

appendFocusTransaction

public boolean appendFocusTransaction(Transaction trans)

Appends the required data focus a focus transaction.

getFocusControl

public VirtualControl getFocusControl()

Get the control that has focus or null if none.