se.entra.phantom.server

Class VirtualMenu

java.lang.Object

se.entra.phantom.server.VirtualMenu

All Implemented Interfaces:

NetPhantomConstants, VirtualChangeEvent

public class VirtualMenu
extends Object
implements NetPhantomConstants, VirtualChangeEvent

Handles all pull-down menus in a panel. The method calls refresh, fireCreate, fireUpdate and issueAction are passed on to the VirtualPullDownMenu instance. A menu bar may be displayed on the client as a pop-up menu rather than as a menu bar, but the processing logic remains the same.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	hasChanged The change flag.
protected VirtualPullDownMenu[]	menus The virtual menus.
protected VirtualPanel	panel The virtual panel.

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
VirtualMenu(VirtualPanel vp, PhantomMenu[] phantomMenus) Creates the menu bar of a panel.

Method Summary

Modifier and Type	Method and Description
boolean	areTextPromptsAlwaysRefreshed() If the class has a need to refresh the text prompt at all host changed, it must reply true to this method call.
void	fireCreate(Transaction trans) Fires the create transaction to the client.
void	fireUpdate(Transaction trans) Fires the update transaction to the client.
VirtualInterface	getMenuItemFromIndex(int index) Gets a menu item VirtualInterface from a menu index.
VirtualPullDownMenu	getPullDownMenu(int index) Gets the pull-down menu from index.
int	getPullDownMenuCount() Gets the count of pull-down menus.
boolean	hasChanged() This method is used to check if a virtual class has changed and that it needs to update the client.
void	hostScreenChanged(PhantomHostScreen screen) The connected host screen has changed.
void	issueAction(Transaction trans, int menuID) This method is invoked by the server kernel whenever a menu item has been pressed on the client side.
void	refresh() This method is used to refresh all virtual controls when e.g.
void	refreshTextPrompts(boolean alwaysRefresh) This method is used to refresh all virtual classes that have text prompt data in them.
void	setChanged() This method is used to indicate that a virtual class has changed and that it needs to update the client.
void	textFileChanged() Text file is changed, format text prompt.

Methods inherited from class java.lang.Object

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

Field Detail

menus

protected VirtualPullDownMenu[] menus

The virtual menus.

panel

protected VirtualPanel panel

The virtual panel.

hasChanged

protected boolean hasChanged

The change flag.

Constructor Detail

VirtualMenu

public VirtualMenu(VirtualPanel vp,
                   PhantomMenu[] phantomMenus)

Creates the menu bar of a panel.

Method Detail

setChanged

public void setChanged()

This method is used to indicate that a virtual class has changed and that it needs to update the client.

Specified by:

setChanged in interface VirtualChangeEvent

hasChanged

public boolean hasChanged()

This method is used to check if a virtual class has changed and that it needs to update the client.

Specified by:

hasChanged in interface VirtualChangeEvent

textFileChanged

public void textFileChanged()

Text file is changed, format text prompt.

refresh

public void refresh()

This method is used to refresh all virtual controls when e.g. a new panel is created or when any host change occurs.

refreshTextPrompts

public void refreshTextPrompts(boolean alwaysRefresh)

This method is used to refresh all virtual classes that have text prompt data in them. The parameter mustRefresh is set when the panel is created or recreated. If the class has a need to refresh the text prompt at all host changed, it must reply true to the method call areTextPromptsAlwaysRefreshed.

areTextPromptsAlwaysRefreshed

public boolean areTextPromptsAlwaysRefreshed()

If the class has a need to refresh the text prompt at all host changed, it must reply true to this method call. Otherwise return false.

fireCreate

public void fireCreate(Transaction trans)

Fires the create transaction to the client.

fireUpdate

public void fireUpdate(Transaction trans)

Fires the update transaction to the client.

Prior to calling this method, the parent component or class should use the method hasChanged() in order to call this method only when required.

issueAction

public void issueAction(Transaction trans,
                        int menuID)

This method is invoked by the server kernel whenever a menu item has been pressed on the client side. Every updateable control (in the VirtualNnnn classes) are set to reflect the changes made on the client side. The menu is responsible to direct the action to the appropriate pull-down menu.

getPullDownMenuCount

public int getPullDownMenuCount()

Gets the count of pull-down menus.

getPullDownMenu

public VirtualPullDownMenu getPullDownMenu(int index)

Gets the pull-down menu from index.

getMenuItemFromIndex

public VirtualInterface getMenuItemFromIndex(int index)

Gets a menu item VirtualInterface from a menu index.

Returns:

null for invalid menu index.

hostScreenChanged

public void hostScreenChanged(PhantomHostScreen screen)

The connected host screen has changed. This can cause a need to change the host screen for host fields.