VirtualPanel (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.VirtualPanel

All Implemented Interfaces:

NetPhantomConstants, ObjectMessages, PhantomControlFlags, PhantomControlType, VirtualChangeEvent, VirtualInterface
```
public class VirtualPanel
extends Object
implements NetPhantomConstants, ObjectMessages, PhantomControlType, PhantomControlFlags, VirtualInterface, VirtualChangeEvent
```
Virtual panels are associated with PhantomPanelData that defines the virtual objects to create. Each virtual object is a mirror of the client and the Server guarantees that they are synchronized upon host changes, API calls and Client updates.

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.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
- 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.PhantomControlFlags
  CTRLFLAG_MOVEX, CTRLFLAG_MOVEY, CTRLFLAG_NEWGROUP, CTRLFLAG_SIZEX, CTRLFLAG_SIZEY, CTRLFLAG_SUBWIN, CTRLFLAG_TABSTOP, CTRLFLAG_TRANSPARENT
- Fields inherited from interface se.entra.phantom.server.VirtualInterface
  TOOLTIP_TEXT

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPanelEventListener(VirtualPanelEventListener listener)` Adds a panel event listener.
`void`	`addPanelListener(VirtualPanelListener listener)` Adds a listener for this panel.
`void`	`appendFocusTransaction(Transaction trans)` Appends the required data focus a focus transaction.
`void`	`callAllControlObjects(int action)` Calls all virtual control objects.
`void`	`callAllControlObjects(int action, boolean callNbObjs)` Calls all virtual control objects.
`void`	`callAllControlObjects(int action, boolean callNonNbObjs, boolean callNbObjs)` Calls all virtual control objects.
`boolean`	`callControl()` "Calls" the control in question.
`boolean`	`callControl(int id)` "Calls" the control in question.
`boolean`	`callControl(String id)` "Calls" the control in question.
`void`	`callCreate()` Call all objects with create and hidden events.
`void`	`callCreateAfterHostCursor()` Call all objects in notebook panel pages with create and hidden events.
`void`	`callCreateBeforeHostCursor()` Call all objects with create and hidden events.
`void`	`callNBPanelAndControls(VirtualCNoteBook nb, int action)` Call NB panel object and all underlaying control objects.
`void`	`callObject(int action)` Calls the Phantom panel Object.
`void`	`callObject(int action, String text)` Calls the Phantom panel Object.
`void`	`clientUpdated(Transaction trans)` This method is called from the VirtualSessionManager to cause a client transaction to update the panels.
`void`	`clipboardComponent(int ii, int action)` Copies(0)/cut(1)/pastes(2)/clears(3) the component content to clipboard.
`void`	`create()` Call this method after the virtual panel instance has been created.
`static VirtualPanel`	`createApplicationPanel(VirtualRuntime runtime, PhantomPanelData panel, VirtualSessionManager vsm)` Creates an application panel.
`static VirtualPanel`	`createNormalPanel(VirtualRuntime runtime, PhantomPanelData panel, VirtualPanelSession vs, PhantomHostScreen screen, int index)` Creates a normal panel.
`static VirtualPanel`	`createNormalPanel(VirtualRuntime runtime, PhantomPanelData panel, VirtualPanelSession vs, PhantomHostScreen screen, int index, VirtualPanelListener listener)` Creates a normal panel.
`static VirtualPanel`	`createNormalPanel(VirtualRuntime runtime, PhantomPanelData panel, VirtualPanelSession vs, PhantomHostScreen screen, int index, VirtualPanelListener listener, Transaction extraPanelTransaction)` Creates a normal panel.
`static VirtualPanel`	`createNoteBookPagePanel(VirtualRuntime runtime, PhantomPanelData panel, VirtualCNoteBookPage noteBookPage, PhantomHostScreen screen)` Creates a notebook page panel.
`boolean`	`deleteAll()` Deletes all lines in a list capable control.
`boolean`	`deleteAll(int id)` Deletes all lines in a list capable control.
`boolean`	`deleteAll(String id)` Deletes all lines in a list capable control.
`boolean`	`deleteLine(int line)` Deletes a line in a list capable control.
`boolean`	`deleteLine(int id, int line)` Deletes a line in a list capable control.
`boolean`	`deleteLine(String id, int line)` Deletes a line in a list capable control.
`void`	`destroy()` Destroys this panel.
`boolean`	`dismissPanel(int rc)` Dismisses this modal panel.
`void`	`enablePopupMenuItem(String id, boolean set)` Enable/disable the identified pop-up menu item for this panel.
`void`	`fireCreate(Transaction trans)` Fires the create transaction to the client.
`void`	`fireHostMessageBoxes()` Fires host message boxes to the client.
`void`	`fireUpdatesToClient()` Causes pending updates of the panels in the session to be sent to the client.
`PhantomApplicationData`	`getApplication()` Gets the phantom application.
`int`	`getBackgroundColor()` Gets the background color of an item.
`int`	`getBackgroundColor(int id)` Gets the background color of an item.
`int`	`getBackgroundColor(String id)` Gets the background color of an item.
`String`	`getCell(int col, int line)` Gets a single cell in a list capable control.
`String`	`getCell(int id, int col, int line)` Gets a single cell in a list capable control.
`String`	`getCell(String id, int col, int line)` Gets a single cell in a list capable control.
`ClientSessionInterface`	`getClientSession()` Gets the reference to the client session.
`se.entra.phantom.geditor.NPPColor`	`getColor()` Get color of an item.
`se.entra.phantom.geditor.NPPColor`	`getColor(int id)` Gets the color of an item.
`se.entra.phantom.geditor.NPPColor`	`getColor(String id)` Gets the color of an item.
`Object`	`getComponentLockObject()` Gets the lock object for synchronization for Control Components.
`VirtualControl`	`getControl(int index)` Gets a control from an index.
`VirtualControl`	`getControlConnectedToHost(PhantomHostScreen screen, PhantomHostField hostField, int flags)` Get the VirtualControl that is connected to a specified host field.
`int`	`getControlCount()` Gets the count of Phantom controls.
`VirtualControl`	`getControlFromID(String id)` Search for VirtualControl using Control ID.
`HostSession`	`getCurrentHostSession()` Gets the current host session.
`VirtualCNoteBook`	`getFirstNoteBook()` Gets the first notebook in this panel.
`VirtualPanel`	`getFirstNoteBookPagePanel(int index)` Gets the VirtualPanel associated with the notebook page index of the first notebook in this panel.
`VirtualPanel`	`getFirstNoteBookPagePanel(String pageID)` Gets the VirtualPanel associated with the notebook page ID of the first notebook in this panel.
`VirtualControl`	`getFirstSelectableControl(int flags)` Find the first control in panel that can receive focus.
`int`	`getFont()` Gets the font index of an item.
`int`	`getFont(int id)` Gets the font index of an item.
`int`	`getFont(String id)` Gets the font index of an item.
`int`	`getForegroundColor()` Gets the foreground color of an item.
`int`	`getForegroundColor(int id)` Gets the foreground color of an item.
`int`	`getForegroundColor(String id)` Gets the foreground color of an item.
`HostScreen`	`getHostScreen()` Gets the single host screen instance per client session.
`String`	`getHostScreenName()` Gets the name of the connected host screen.
`int`	`getIndex()` Gets the index of this panel in the panel session.
`int`	`getLength()` Gets the control length.
`int`	`getLength(int id)` Gets the control length.
`int`	`getLength(String id)` Gets the control length.
`String`	`getLine(int line)` Sets a line in a list capable control.
`String`	`getLine(int id, int line)` Sets a line in a list capable control.
`String`	`getLine(String id, int line)` Sets a line in a list capable control.
`int`	`getLineCount()` Gets the line count for a list capable control.
`int`	`getLineCount(int id)` Gets the line count for a list capable control.
`int`	`getLineCount(String id)` Gets the line count for a list capable control.
`VirtualPanelListener`	`getListener()` Gets the listener of this panel.
`VirtualMenu`	`getMenu()` Gets the menu bar.
`VirtualInterface`	`getMenuFromID(String id)` Search for menu using menu ID.
`VirtualInterface`	`getMenuFromIndex(int index)` Gets a menu item VirtualInterface from an index (>=1000).
`VirtualInterface`	`getMenuOrControlFromID(int id)` Search panel for a control or a menu item.
`VirtualInterface`	`getMenuOrControlFromID(String id)` Search panel for a control or a menu item.
`VirtualInterface`	`getNbCtlInfo(String panelID, String ctrlID)` Get control/menu item info in a notebook in a panel.
`VirtualCNoteBook`	`getNextNoteBook(int fromIndex)` Gets the first notebook in this panel.
`int`	`getNextSelection(int line)` Gets the next selected line in a list capable control.
`int`	`getNextSelection(int id, int line)` Gets the next selected line in a list capable control.
`int`	`getNextSelection(String id, int line)` Gets the next selected line in a list capable control.
`VirtualCNoteBook`	`getNoteBook(int id)` Gets the notebook of specified Numbered ID in this panel.
`VirtualCNoteBook`	`getNoteBook(String id)` Gets the notebook of specified String ID in this panel.
`VirtualPanel`	`getNoteBookPagePanel(String id, int index)` Gets the VirtualPanel associated with the notebook page index of the notebook with a String ID in this panel.
`VirtualPanel`	`getNoteBookPagePanel(String id, String pageID)` Gets the VirtualPanel associated with the notebook page ID of the notebook with a String ID in this panel.
`PhantomPanelData`	`getPanelData()` Gets the PhantomPanelData for this panel.
`String`	`getPanelID()` Gets the ID of this panel.
`VirtualPanelSession`	`getPanelSession()` Gets the panel session for this panel.
`VirtualPanel`	`getParentPanel()` Gets the parent panel if this page is a notebook page.
`VirtualPopupMenu`	`getPopupMenu(String id)` Gets the identified pop-up menus for this panel.
`VirtualMenuItem`	`getPopupMenuItem(String id)` Gets the identified pop-up menu item for this panel.
`VirtualPopupMenu[]`	`getPopupMenus()` Gets the pop-up menus for this panel.
`Object`	`getProperty(int id, String propertyName)` Gets a property of a virtual component.
`Object`	`getProperty(String propertyName)` Gets a property of a virtual component.
`Object`	`getProperty(String id, String propertyName)` Gets a property of a virtual component.
`VirtualRuntime`	`getRuntime()` Gets the runtime from which this panel is created.
`PhantomHostScreen`	`getScreen()` Gets the single host screen.
`VirtualHostMessageBox`	`getSystemMessageBox()` Gets the 5250 system message box, or null if none.
`String`	`getText()` Gets the text of an item.
`String`	`getText(int id)` Gets the text of an item.
`String`	`getText(String id)` Gets the text of an item.
`String`	`getTextID(String id)` Gets a text ID from the text file of the panel.
`String`	`getTooltipText(String id)` Gets the tool tip text of this component.
`VirtualSessionManager`	`getVirtualSessionManager()` Gets the VirtualSessionManager instance.
`boolean`	`hasChanged()` Checks if an update transaction to the client is required.
`boolean`	`hasListener()` Checks if a panel has a listener.
`boolean`	`insertLine(int id, String data, int line)` Inserts a line in a list capable control.
`boolean`	`insertLine(String data, int line)` Inserts a line in a list capable control.
`boolean`	`insertLine(String id, String data, int line)` Inserts a line in a list capable control.
`boolean`	`isApplicationPanel()` Checks if this is an application panel.
`int`	`isChecked()` Gets the check state of a control (e.g.
`int`	`isChecked(int id)` Gets the check state of a control (e.g.
`int`	`isChecked(String id)` Gets the check state of a control (e.g.
`boolean`	`isChecked2(String id)` Gets the check state of a control (e.g.
`boolean`	`isCreateRequired()` Checks if create transaction is required to update the client.
`boolean`	`isCursorPositionedAtHostUnlock()` Checks if the cursor position should be set when the panel is unlocked.
`boolean`	`isDestroyed()` Checks if a panel is destroyed.
`boolean`	`isEnabled()` Gets the enabled state of an item.
`boolean`	`isEnabled(int id)` Gets the enabled state of an item.
`boolean`	`isEnabled(String id)` Gets the enabled state of an item.
`boolean`	`isGuiOnTheFlyPanel()` Checks if this virtual panel is created by the Gui-on-the-fly algorithm.
`boolean`	`isHostConnectedToCurrentScreen()` Checks if this panel is connected to the current host screen.
`boolean`	`isModal()` Checks the panel modality flag.
`boolean`	`isNoteBookPage()` Checks if this panel is a notebook page.
`boolean`	`isPanelHostConnected()` Checks if this panel has a direct host connection or not.
`boolean`	`isReCreateRequired()` Checks if the panel has been recreated, and therefore needs to refresh all text prompts.
`void`	`issueAction(Transaction trans)` Called after all virtual components are updated with the data from the client.
`boolean`	`isVisible()` Gets the visibility state of an item.
`boolean`	`isVisible(int id)` Gets the visibility state of an item.
`boolean`	`isVisible(String id)` Gets the visibility state of an item.
`int`	`messageBox(int type, int icon, String message)` Same as "messageBox(int type,int icon,String message,String title)", but without the title: it is taken from the panel title.
`int`	`messageBox(int type, int icon, String message, String title)` Requests and displays a message to the user.
`void`	`onCheckedChange(VirtualControl control, int state)` Check boxes and radio buttons generates this event when state is changed on the client side.
`void`	`onContentChanged(VirtualControl control, String text)` Entry fields and multiple line entry fields generates this message.
`void`	`onContentChanged(VirtualControl control, String text, int line)` Combination boxes and spin buttons generates this message.
`void`	`onControlEvent(VirtualControl control, int event)` The general notification event for "normal" controls.
`void`	`onFocusGained(VirtualControl control)` Controls that can receive input focus generates this event when they gain focus.
`void`	`onFocusLost(VirtualControl control)` Controls that can receive input focus generates this event when they lose focus.
`void`	`onModalPanelCreated(JDialog dialog)` Called when the modal dialog is created.
`void`	`onPropertyChange(VirtualControl control, String propertyName, Object property)` A control notifies the listener using this event when custom properties needs to be handled.
`void`	`onSelectionChanged(VirtualCListBox list, int line, int column)` List boxes generates this message.
`boolean`	`performAction(VirtualInterface vi, PhantomHostField hostField, String sendString, int phantomSendKey, PhantomObject object, String objArgStr, String nextPanel, String controlID, boolean doLockPanel, int connectedControlIndex)` Performs actions for action items such as menu items, pop-up menu items, and push buttons.
`boolean`	`performNextPanel(String nextPanel, int connectedControlIndex)` Perform next panel connection from pushbutton or menu item.
`void`	`printComponent(int ii)` Prints the component at index on the client side.
`void`	`printPanel()` Prints the current panel on the client as a bitmap.
`void`	`processHelpRequestTransaction(Transaction trans)` The user has pressed the F1 key in a control (or menu item).
`int`	`processPanel()` Processes this panel modally until a call to `dismissPanel(rc)` is called.
`void`	`removePanelEventListener(VirtualPanelEventListener listener)` Removes a panel event listener.
`void`	`removePanelListener(VirtualPanelListener listener)` Removes a listener for this panel.
`void`	`requestFocus(int controlIndex, int focusType)` A control wants focus.
`boolean`	`requestFocus(String controlID)` A control wants focus.
`void`	`requestFocus(VirtualControl vc, int focusType)` A control wants focus.
`void`	`resetHostMessageBoxes()` This method calls the reset method in the VirtualHostMessageBox classes of this panel because new message boxes needs to be displayed.
`boolean`	`selectField()` Performs a visual selection of the field.
`boolean`	`selectField(int id)` Performs a visual selection of the field.
`boolean`	`selectField(String id)` Performs a visual selection of the field.
`boolean`	`setBackgroundColor(int colorIndex)` Sets the background color of an item.
`boolean`	`setBackgroundColor(int id, int colorIndex)` Sets the background color of an item.
`boolean`	`setBackgroundColor(String id, int index)` Sets the background color of an item.
`boolean`	`setCell(int id, int col, int line, String data)` Sets a single cell in a list capable control.
`boolean`	`setCell(int col, int line, String data)` Sets a single cell in a list capable control.
`boolean`	`setCell(String id, int col, int line, String data)` Sets a single cell in a list capable control.
`void`	`setChanged()` Sets this virtual panel or one of its virtual components as changed.
`boolean`	`setChecked(int state)` Sets the check state of a control (e.g.
`boolean`	`setChecked(int id, int state)` Sets the check state of a control (e.g.
`boolean`	`setChecked(String id, boolean state)` Sets the check state of a control (e.g.
`boolean`	`setChecked(String id, int state)` Sets the check state of a control (e.g.
`boolean`	`setColor(int id, se.entra.phantom.geditor.NPPColor color)` Sets the color of an item.
`boolean`	`setColor(se.entra.phantom.geditor.NPPColor color)` Set the color of an item.
`boolean`	`setColor(String id, se.entra.phantom.geditor.NPPColor color)` Sets the color of an item.
`boolean`	`setEnabled(boolean state)` Sets the enabled state of an item.
`boolean`	`setEnabled(int id, boolean state)` Sets the enabled state of an item.
`boolean`	`setEnabled(String id, boolean state)` Sets the enabled state of an item.
`boolean`	`setFileFromList(int id, PhantomOutputFile pFile)` Insert the contents of a list into a file.
`boolean`	`setFileFromList(PhantomOutputFile pFile)` Insert the contents of a list into a file.
`boolean`	`setFileFromList(String id, PhantomOutputFile pFile)` Insert the contents of a list into a file.
`boolean`	`setFocus()` Sets focus in the panel to this item.
`boolean`	`setFocus(int id)` Sets focus in the panel to this item.
`boolean`	`setFocus(int id, PhantomHostFieldLocation hostFieldLocation)` Sets focus in the panel to this item according to a host field location.
`boolean`	`setFocus(PhantomHostFieldLocation hostFieldLocation)` Sets focus in the panel to this item according to a host field location.
`boolean`	`setFocus(String id)` Sets focus in the panel to this item.
`boolean`	`setFocus(String id, PhantomHostFieldLocation hostFieldLocation)` Sets focus in the panel to this item according to a host field location.
`boolean`	`setFont(int font)` Sets the font index of an item.
`boolean`	`setFont(int id, int font)` Sets the font index of an item.
`boolean`	`setFont(String id, int font)` Sets the font index of an item.
`boolean`	`setForegroundColor(int colorIndex)` Sets the foreground color of an item from index.
`boolean`	`setForegroundColor(int id, int colorIndex)` Sets the foreground color of an item.
`boolean`	`setForegroundColor(String id, int index)` Sets the foreground color of an item.
`boolean`	`setLength(int length)` Sets the control length.
`boolean`	`setLength(int id, int length)` Sets the control length.
`boolean`	`setLength(String id, int length)` Sets the control length.
`boolean`	`setLine(int id, String data, int line)` Sets a line in a list capable control.
`boolean`	`setLine(String data, int line)` Sets a line in a list capable control.
`boolean`	`setLine(String id, String data, int line)` Sets a line in a list capable control.
`void`	`setListener(VirtualPanelListener listener)` Sets the listener of this panel.
`boolean`	`setListFromFile(int id, String fileName)` Sets the contents of a list capable control from a file.
`boolean`	`setListFromFile(String fileName)` Sets the contents of a list capable control from a file.
`boolean`	`setListFromFile(String id, String fileName)` Sets the contents of a list capable control from a file.
`void`	`setLockState(boolean lock)` Changes the lock state for the client session.
`boolean`	`setProperty(int id, String propertyName, Object property)` Sets a property of a virtual component.
`boolean`	`setProperty(String propertyName, Object property)` Sets a property of a virtual component.
`boolean`	`setProperty(String id, String propertyName, Object property)` Sets a property of a virtual component.
`boolean`	`setScreen(PhantomHostScreen screen)` Set connected host screen.
`boolean`	`setSelection(int line, boolean select)` Sets a line as selected (or not) in a list capable control.
`boolean`	`setSelection(int id, int line, boolean select)` Sets a line as selected (or not) in a list capable control.
`boolean`	`setSelection(String id, int line, boolean select)` Sets a line as selected (or not) in a list capable control.
`boolean`	`setText(int id, String text)` Sets the text of an item.
`boolean`	`setText(String text)` Sets the text of an item.
`boolean`	`setText(String id, String text)` Sets the text of an item.
`boolean`	`setTooltipText(String id, String text)` Sets the tool tip text to a value for a component or menu item.
`void`	`setUpdateTextPromptRequired()` Sets update of text prompts required for the panel.
`boolean`	`setVisible(boolean state)` Sets the visibility state of an item.
`boolean`	`setVisible(int id, boolean state)` Sets the visibility state of an item.
`boolean`	`setVisible(String id, boolean state)` Sets the visibility state of an item.
`void`	`textFileChanged()` Text file is changed, format title and notify all controls.
`void`	`update()` Refreshes the contents of this virtual panel with all its virtual components.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createApplicationPanel
```
public static VirtualPanel createApplicationPanel(VirtualRuntime runtime,
                                                  PhantomPanelData panel,
                                                  VirtualSessionManager vsm)
```
    Creates an application panel.
  - createNormalPanel
```
public static VirtualPanel createNormalPanel(VirtualRuntime runtime,
                                             PhantomPanelData panel,
                                             VirtualPanelSession vs,
                                             PhantomHostScreen screen,
                                             int index)
```
    Creates a normal panel.
  - createNormalPanel
```
public static VirtualPanel createNormalPanel(VirtualRuntime runtime,
                                             PhantomPanelData panel,
                                             VirtualPanelSession vs,
                                             PhantomHostScreen screen,
                                             int index,
                                             VirtualPanelListener listener)
```
    Creates a normal panel.
  - createNormalPanel
```
public static VirtualPanel createNormalPanel(VirtualRuntime runtime,
                                             PhantomPanelData panel,
                                             VirtualPanelSession vs,
                                             PhantomHostScreen screen,
                                             int index,
                                             VirtualPanelListener listener,
                                             Transaction extraPanelTransaction)
```
    Creates a normal panel.
  - createNoteBookPagePanel
```
public static VirtualPanel createNoteBookPagePanel(VirtualRuntime runtime,
                                                   PhantomPanelData panel,
                                                   VirtualCNoteBookPage noteBookPage,
                                                   PhantomHostScreen screen)
```
    Creates a notebook page panel.
  - getComponentLockObject
```
public Object getComponentLockObject()
```
    Gets the lock object for synchronization for Control Components.
  - isCreateRequired
```
public boolean isCreateRequired()
```
    Checks if create transaction is required to update the client.
  - isReCreateRequired
```
public boolean isReCreateRequired()
```
    Checks if the panel has been recreated, and therefore needs to refresh all text prompts.
  - setUpdateTextPromptRequired
```
public void setUpdateTextPromptRequired()
```
    Sets update of text prompts required for the panel.
  - isNoteBookPage
```
public boolean isNoteBookPage()
```
    Checks if this panel is a notebook page.
  - getControlCount
```
public int getControlCount()
```
    Gets the count of Phantom controls.
  - getScreen
```
public PhantomHostScreen getScreen()
```
    Gets the single host screen.
  - getPanelID
```
public String getPanelID()
```
    Gets the ID of this panel.
  - isGuiOnTheFlyPanel
```
public boolean isGuiOnTheFlyPanel()
```
    Checks if this virtual panel is created by the Gui-on-the-fly algorithm.
  - isPanelHostConnected
```
public boolean isPanelHostConnected()
```
    Checks if this panel has a direct host connection or not. This will determine if host events will cause the panel to be updated or not.
  - getClientSession
```
public ClientSessionInterface getClientSession()
```
    Gets the reference to the client session.
  - getVirtualSessionManager
```
public VirtualSessionManager getVirtualSessionManager()
```
    Gets the VirtualSessionManager instance.
  - getRuntime
```
public VirtualRuntime getRuntime()
```
    Gets the runtime from which this panel is created.
  - getApplication
```
public PhantomApplicationData getApplication()
```
    Gets the phantom application.
  - getPanelData
```
public PhantomPanelData getPanelData()
```
    Gets the PhantomPanelData for this panel.
  - getSystemMessageBox
```
public VirtualHostMessageBox getSystemMessageBox()
```
    Gets the 5250 system message box, or null if none.
  - getTextID
```
public String getTextID(String id)
```
    Gets a text ID from the text file of the panel.
  - getHostScreen
```
public HostScreen getHostScreen()
```
    Gets the single host screen instance per client session.
  - getHostScreenName
```
public String getHostScreenName()
```
    Gets the name of the connected host screen.
  - setScreen
```
public boolean setScreen(PhantomHostScreen screen)
```
    Set connected host screen. This is only possible when the panel has no screen connected.
    
    Returns:
    
    true for OK, false for error (not possible to set screen).
  - getPanelSession
```
public VirtualPanelSession getPanelSession()
```
    Gets the panel session for this panel. If this is an application panel, null is returned.
    
    Returns:
    
    null if this is an application panel
  - getControl
```
public VirtualControl getControl(int index)
```
    Gets a control from an index.
    
    Returns:
    
    null if index is out of range.
  - isCursorPositionedAtHostUnlock
```
public boolean isCursorPositionedAtHostUnlock()
```
    Checks if the cursor position should be set when the panel is unlocked.
  - getControlFromID
```
public VirtualControl getControlFromID(String id)
```
    Search for VirtualControl using Control ID. Use PhantomPanelData to get a control index. Use VirtualPanel (this) to get VirtualControl from index.
    
    Returns:
    
    null if Control ID is not found.
  - getMenu
```
public VirtualMenu getMenu()
```
    Gets the menu bar.
  - getMenuFromID
```
public VirtualInterface getMenuFromID(String id)
```
    Search for menu using menu ID.
    
    Returns:
    
    null if menu ID is not found.
  - getMenuFromIndex
```
public VirtualInterface getMenuFromIndex(int index)
```
    Gets a menu item VirtualInterface from an index (>=1000).
    
    Returns:
    
    null if menu index is invalid.
  - getMenuOrControlFromID
```
public VirtualInterface getMenuOrControlFromID(String id)
```
    Search panel for a control or a menu item.
    
    Returns:
    
    VirtualInterface of the control or menu item or null if not found.
  - getMenuOrControlFromID
```
public VirtualInterface getMenuOrControlFromID(int id)
```
    Search panel for a control or a menu item.
    Note: The ID must be registered with VirtualRuntime.registerStringID.
    
    Returns:
    
    VirtualInterface of the control or menu item or null if not found.
  - getControlConnectedToHost
```
public VirtualControl getControlConnectedToHost(PhantomHostScreen screen,
                                                PhantomHostField hostField,
                                                int flags)
```
    Get the VirtualControl that is connected to a specified host field.
    
    Returns:
    
    null if not found.
  - getFirstSelectableControl
```
public VirtualControl getFirstSelectableControl(int flags)
```
    Find the first control in panel that can receive focus.
    
    Returns:
    
    null is no control is selectable.
  - hasChanged
```
public boolean hasChanged()
```
    Checks if an update transaction to the client is required.
    
    Specified by:
    
    hasChanged in interface VirtualChangeEvent
  - setProperty
```
public boolean setProperty(String propertyName,
                           Object property)
```
    Sets a property of a virtual component.
    
    Specified by:
    
    setProperty in interface VirtualInterface
    
    Returns:
    
    true for successful operation.
    false for failure.
  - getProperty
```
public Object getProperty(String propertyName)
```
    Gets a property of a virtual component.
    
    Specified by:
    
    getProperty in interface VirtualInterface
    
    Returns:
    
    Object The object containing the property.
    null for failure.
  - setTooltipText
```
public boolean setTooltipText(String id,
                              String text)
```
    Sets the tool tip text to a value for a component or menu item.
    
    Parameters:
    
    id - The component ID (menu item or control).
    
    text - The text to set, or null to clear tool tip.
    
    Returns:
    
    true for successful operation. false if the component doesn't support tool tips or component id not found.
  - getTooltipText
```
public String getTooltipText(String id)
```
    Gets the tool tip text of this component.
    
    Parameters:
    
    id - The component ID (menu item or control).
    
    Returns:
    
    Empty string for no tool tip (or empty), otherwise the string. If the component does not support tool tips, null is returned. null is also returned if the component idis not found.
  - setText
```
public boolean setText(String text)
```
    Sets the text of an item.
    
    Specified by:
    
    setText in interface VirtualInterface
    
    Returns:
    
    true for successful operation.
    false for failure.
  - getText
```
public String getText()
```
    Gets the text of an item.
    
    Specified by:
    
    getText in interface VirtualInterface
    
    Returns:
    
    null for no text support.
  - getIndex
```
public int getIndex()
```
    Gets the index of this panel in the panel session.
    
    Returns:
    
    the index of the panel (-1 for application or notebook panels).
  - create
```
public void create()
```
    Call this method after the virtual panel instance has been created. This will refresh the contents of the panel.
  - callCreateBeforeHostCursor
```
public void callCreateBeforeHostCursor()
```
    Call all objects with create and hidden events. Notebooks panel pages are not processed in this call.
  - callCreateAfterHostCursor
```
public void callCreateAfterHostCursor()
```
    Call all objects in notebook panel pages with create and hidden events.
  - callCreate
```
public void callCreate()
```
    Call all objects with create and hidden events.
  - isHostConnectedToCurrentScreen
```
public boolean isHostConnectedToCurrentScreen()
```
    Checks if this panel is connected to the current host screen.
  - update
```
public void update()
```
    Refreshes the contents of this virtual panel with all its virtual components. This is called as a result of a panel being created, recreated or a host change.
    The routine will update the following items:
    - title bar (if any),
    - menu bar,
    - pop-up menus,
    - controls.
    If the panel is created or recreated, or if a component returns true to the method call areTextPromptsAlwaysRefreshed(), then the components refreshTextPrompt method is called.
  - fireUpdatesToClient
```
public void fireUpdatesToClient()
```
    Causes pending updates of the panels in the session to be sent to the client.
  - fireHostMessageBoxes
```
public void fireHostMessageBoxes()
```
    Fires host message boxes to the client. All notebook controls in the panel will receive this message also.
  - fireCreate
```
public void fireCreate(Transaction trans)
```
    Fires the create transaction to the client.
  - clientUpdated
```
public void clientUpdated(Transaction trans)
```
    This method is called from the VirtualSessionManager to cause a client transaction to update the panels. The panels responds to this by sending sub-messages as clientUpdated to its controls.
    
    Throws:
    
    Error - when panel hashCode doesn't match.
  - issueAction
```
public void issueAction(Transaction trans)
```
    Called after all virtual components are updated with the data from the client. The issueAction is called in order to perform an action, e.g. the push button host send key. This method will direct the transaction to the appropriate component (menu item, control or pop-up menu item). If the panel used the host option "Pass through function keys to host", then that particular send key is sent to host rather than invoking a panel component.
  - callObject
```
public void callObject(int action)
```
    Calls the Phantom panel Object.
  - callObject
```
public void callObject(int action,
                       String text)
```
    Calls the Phantom panel Object.
  - callAllControlObjects
```
public void callAllControlObjects(int action)
```
    Calls all virtual control objects.
  - callAllControlObjects
```
public void callAllControlObjects(int action,
                                  boolean callNbObjs)
```
    Calls all virtual control objects.
  - callAllControlObjects
```
public void callAllControlObjects(int action,
                                  boolean callNonNbObjs,
                                  boolean callNbObjs)
```
    Calls all virtual control objects.
  - callNBPanelAndControls
```
public void callNBPanelAndControls(VirtualCNoteBook nb,
                                   int action)
```
    Call NB panel object and all underlaying control objects.
  - resetHostMessageBoxes
```
public void resetHostMessageBoxes()
```
    This method calls the reset method in the VirtualHostMessageBox classes of this panel because new message boxes needs to be displayed.
  - setChanged
```
public void setChanged()
```
    Sets this virtual panel or one of its virtual components as changed. The virtual panel will inform the virtual panel session of this, until it reaches the client session. At a later stage, the client transaction sender thread will issue a fire* event.
    
    Specified by:
    
    setChanged in interface VirtualChangeEvent
  - setEnabled
```
public boolean setEnabled(boolean state)
```
    Sets the enabled state of an item.
    
    Specified by:
    
    setEnabled in interface VirtualInterface
    
    Returns:
    
    true for success.
  - isEnabled
```
public boolean isEnabled()
```
    Gets the enabled state of an item.
    
    Specified by:
    
    isEnabled in interface VirtualInterface
    
    Returns:
    
    true if the panel is enabled, false for disabled.
  - setVisible
```
public boolean setVisible(boolean state)
```
    Sets the visibility state of an item.
    
    Specified by:
    
    setVisible in interface VirtualInterface
    
    Returns:
    
    false for failure.
  - isVisible
```
public boolean isVisible()
```
    Gets the visibility state of an item.
    
    Specified by:
    
    isVisible in interface VirtualInterface
    
    Returns:
    
    true item is visible.
  - setColor
```
public boolean setColor(se.entra.phantom.geditor.NPPColor color)
```
    Set the color of an item.
    
    Specified by:
    
    setColor in interface VirtualInterface
    
    Returns:
    
    false for failure.
  - getColor
```
public se.entra.phantom.geditor.NPPColor getColor()
```
    Get color of an item.
    
    Specified by:
    
    getColor in interface VirtualInterface
    
    Returns:
    
    NPPColor foreground and background color of the item. null Failure.
  - setForegroundColor
```
public boolean setForegroundColor(int colorIndex)
```
    Sets the foreground color of an item from index. See NPPColorItemManager for indexes.
    
    Specified by:
    
    setForegroundColor in interface VirtualInterface
    
    Returns:
    
    false for failure.
  - getForegroundColor
```
public int getForegroundColor()
```
    Gets the foreground color of an item. See NPPColorItemManager for indexes.
    
    Specified by:
    
    getForegroundColor in interface VirtualInterface
    
    Returns:
    
    -1 for failure.
  - setBackgroundColor
```
public boolean setBackgroundColor(int colorIndex)
```
    Sets the background color of an item. See NPPColorItemManager for indexes.
    
    Specified by:
    
    setBackgroundColor in interface VirtualInterface
    
    Returns:
    
    false for failure.
  - getBackgroundColor
```
public int getBackgroundColor()
```
    Gets the background color of an item. See NPPColorItemManager for indexes.
    
    Specified by:
    
    getBackgroundColor in interface VirtualInterface
    
    Returns:
    
    -1 for failure.
  - setFont
```
public boolean setFont(int font)
```
    Sets the font index of an item.
    
    Specified by:
    
    setFont in interface VirtualInterface
    
    Returns:
    
    false for failure.
  - getFont
```
public int getFont()
```
    Gets the font index of an item.
    
    Specified by:
    
    getFont in interface VirtualInterface
    
    Returns:
    
    -1 for failure.
  - setFocus
```
public boolean setFocus()
```
    Sets focus in the panel to this item.
    
    Specified by:
    
    setFocus in interface VirtualInterface
    
    Returns:
    
    false for failure.
  - setFocus
```
public boolean setFocus(PhantomHostFieldLocation hostFieldLocation)
```
    Sets focus in the panel to this item according to a host field location.
    
    Specified by:
    
    setFocus in interface VirtualInterface
    
    Returns:
    
    false for failure.
  - selectField
```
public boolean selectField()
```
    Performs a visual selection of the field. It is mainly used for entry capable controls.
    
    Specified by:
    
    selectField in interface VirtualInterface
    
    Returns:
    
    false for failure.
  - getLength
```
public int getLength()
```
    Gets the control length. It is mainly used for entry capable controls.
    
    Specified by:
    
    getLength in interface VirtualInterface
    
    Returns:
    
    -1 for error (getLength not implemented for control)
    0-nn control length.
  - setLength
```
public boolean setLength(int length)
```
    Sets the control length. It is mainly used for entry capable controls that is not host connected.
    
    Specified by:
    
    setLength in interface VirtualInterface
    
    Returns:
    
    true for successful operation.
    false for failure.
  - setChecked
```
public boolean setChecked(int state)
```
    Sets the check state of a control (e.g. check box) or a menu item.
    
    Specified by:
    
    setChecked in interface VirtualInterface
    
    Returns:
    
    false for failure.
  - isChecked
```
public int isChecked()
```
    Gets the check state of a control (e.g. check box) or a menu item.
    
    Specified by:
    
    isChecked in interface VirtualInterface
    
    Returns:
    
    -1 for failure.
  - getLineCount
```
public int getLineCount()
```
    Gets the line count for a list capable control.
    
    Specified by:
    
    getLineCount in interface VirtualInterface
    
    Returns:
    
    -1 failure.
  - insertLine
```
public boolean insertLine(String data,
                          int line)
```
    Inserts a line in a list capable control.
    
    Specified by:
    
    insertLine in interface VirtualInterface
    
    Returns:
    
    false for failure.
  - setLine
```
public boolean setLine(String data,
                       int line)
```
    Sets a line in a list capable control.
    
    Specified by:
    
    setLine in interface VirtualInterface
    
    Returns:
    
    false for failure.
  - getLine
```
public String getLine(int line)
```
    Sets a line in a list capable control.
    
    Specified by:
    
    getLine in interface VirtualInterface
    
    Returns:
    
    null for failure.
  - deleteLine
```
public boolean deleteLine(int line)
```
    Deletes a line in a list capable control.
    
    Specified by:
    
    deleteLine in interface VirtualInterface
    
    Returns:
    
    false for failure.
  - deleteAll
```
public boolean deleteAll()
```
    Deletes all lines in a list capable control.
    
    Specified by:
    
    deleteAll in interface VirtualInterface
    
    Returns:
    
    false for failure.
  - setCell
```
public boolean setCell(int col,
                       int line,
                       String data)
```
    Sets a single cell in a list capable control.
    
    Specified by:
    
    setCell in interface VirtualInterface
    
    Parameters:
    
    col - The column for the cell.
    
    line - The line for the column.
    
    data - The data for the cell.
    
    Returns:
    
    True for successful operation
    false for failure.
  - getCell
```
public String getCell(int col,
                      int line)
```
    Gets a single cell in a list capable control.
    
    Specified by:
    
    getCell in interface VirtualInterface
    
    Parameters:
    
    col - The column for the cell.
    
    line - The line for the column.
    
    Returns:
    
    The contents of the cell.
  - setSelection
```
public boolean setSelection(int line,
                            boolean select)
```
    Sets a line as selected (or not) in a list capable control.
    
    Specified by:
    
    setSelection in interface VirtualInterface
    
    Returns:
    
    false for failure.
  - getNextSelection
```
public int getNextSelection(int line)
```
    Gets the next selected line in a list capable control.
    
    Specified by:
    
    getNextSelection in interface VirtualInterface
    
    Returns:
    
    -1 no more selected lines or failure.
  - setFileFromList
```
public boolean setFileFromList(PhantomOutputFile pFile)
```
    Insert the contents of a list into a file. true for successful operation.
    false for failure.
    
    Specified by:
    
    setFileFromList in interface VirtualInterface
    
    Returns:
    
    true for successful operation.
    false for failure.
  - setListFromFile
```
public boolean setListFromFile(String fileName)
```
    Sets the contents of a list capable control from a file.
    
    Specified by:
    
    setListFromFile in interface VirtualInterface
    
    Parameters:
    
    fileName - the file name.
    
    Returns:
    
    false for failure.
  - callControl
```
public boolean callControl()
```
    "Calls" the control in question. It is used by push buttons and menu items. When called, it generates a transaction to the client that causes it to update the server immediately. When this transaction is received, the control is "called", much like if the user had pressed and released the push button or selected the menu item.
    If a control supports being called, it must override this method and return true.
    
    Specified by:
    
    callControl in interface VirtualInterface
    
    Returns:
    
    false the control doesn't support being "called".
  - getCurrentHostSession
```
public HostSession getCurrentHostSession()
```
    Gets the current host session.
    
    Returns:
    
    null if no current host session exists.
  - textFileChanged
```
public void textFileChanged()
```
    Text file is changed, format title and notify all controls.
  - getNbCtlInfo
```
public VirtualInterface getNbCtlInfo(String panelID,
                                     String ctrlID)
```
    Get control/menu item info in a notebook in a panel.
  - performAction
```
public boolean performAction(VirtualInterface vi,
                             PhantomHostField hostField,
                             String sendString,
                             int phantomSendKey,
                             PhantomObject object,
                             String objArgStr,
                             String nextPanel,
                             String controlID,
                             boolean doLockPanel,
                             int connectedControlIndex)
```
    Performs actions for action items such as menu items, pop-up menu items, and push buttons.
    
    Returns:
    
    true for OK, false.
  - performNextPanel
```
public boolean performNextPanel(String nextPanel,
                                int connectedControlIndex)
```
    Perform next panel connection from pushbutton or menu item.
  - printPanel
```
public void printPanel()
```
    Prints the current panel on the client as a bitmap.
  - printComponent
```
public void printComponent(int ii)
```
    Prints the component at index on the client side.
  - clipboardComponent
```
public void clipboardComponent(int ii,
                               int action)
```
    Copies(0)/cut(1)/pastes(2)/clears(3) the component content to clipboard.
  - requestFocus
```
public boolean requestFocus(String controlID)
```
    A control wants focus. Set it as the focused control and requests the panel to be focused in the panel session.
    
    Returns:
    
    true if the control has been focused, false if it is not found.
  - requestFocus
```
public void requestFocus(int controlIndex,
                         int focusType)
```
    A control wants focus. Set it as the focused control and requests the panel to be focused in the panel session.
  - requestFocus
```
public void requestFocus(VirtualControl vc,
                         int focusType)
```
    A control wants focus. Set it as the focused control and requests the panel to be focused in the panel session.
  - appendFocusTransaction
```
public void appendFocusTransaction(Transaction trans)
```
    Appends the required data focus a focus transaction.
  - processHelpRequestTransaction
```
public void processHelpRequestTransaction(Transaction trans)
```
    The user has pressed the F1 key in a control (or menu item). Display the appropriate help document using a DisplayHelp transaction to the client.
  - getParentPanel
```
public VirtualPanel getParentPanel()
```
    Gets the parent panel if this page is a notebook page.
    
    Returns:
    
    this VirtualPanel if this panel is not a notebook page.
  - getPopupMenus
```
public VirtualPopupMenu[] getPopupMenus()
```
    Gets the pop-up menus for this panel.
  - getPopupMenu
```
public VirtualPopupMenu getPopupMenu(String id)
```
    Gets the identified pop-up menus for this panel.
  - getPopupMenuItem
```
public VirtualMenuItem getPopupMenuItem(String id)
```
    Gets the identified pop-up menu item for this panel.
  - enablePopupMenuItem
```
public void enablePopupMenuItem(String id,
                                boolean set)
```
    Enable/disable the identified pop-up menu item for this panel.
  - setProperty
```
public boolean setProperty(String id,
                           String propertyName,
                           Object property)
```
    Sets a property of a virtual component.
    
    Returns:
    
    true for successful operation.
    false for failure.
  - getProperty
```
public Object getProperty(String id,
                          String propertyName)
```
    Gets a property of a virtual component.
    
    Returns:
    
    Object The object containing the property.
    null for failure.
  - setText
```
public boolean setText(String id,
                       String text)
```
    Sets the text of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - getText
```
public String getText(String id)
```
    Gets the text of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    text the control text
    null for no text support or control menu item not found.
  - setEnabled
```
public boolean setEnabled(String id,
                          boolean state)
```
    Sets the enabled state of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - isEnabled
```
public boolean isEnabled(String id)
```
    Gets the enabled state of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true item is enabled.
    false item is disabled or failure or control menu item not found.
  - setVisible
```
public boolean setVisible(String id,
                          boolean state)
```
    Sets the visibility state of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - isVisible
```
public boolean isVisible(String id)
```
    Gets the visibility state of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true item is visible.
    false item is hidden or failure or control menu item not found
  - setColor
```
public boolean setColor(String id,
                        se.entra.phantom.geditor.NPPColor color)
```
    Sets the color of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - setForegroundColor
```
public boolean setForegroundColor(String id,
                                  int index)
```
    Sets the foreground color of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - setBackgroundColor
```
public boolean setBackgroundColor(String id,
                                  int index)
```
    Sets the background color of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - getColor
```
public se.entra.phantom.geditor.NPPColor getColor(String id)
```
    Gets the color of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    NPPColor the color object.
    null for failure or control menu item not found.
  - getForegroundColor
```
public int getForegroundColor(String id)
```
    Gets the foreground color of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    integer foreground color index.
    -1 for failure or control menu item not found.
  - getBackgroundColor
```
public int getBackgroundColor(String id)
```
    Gets the background color of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    integer background color index.
    -1 for failure or control menu item not found.
  - setFont
```
public boolean setFont(String id,
                       int font)
```
    Sets the font index of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - getFont
```
public int getFont(String id)
```
    Gets the font index of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    0-nn font index.
    -1 for failure or control menu item not found.
  - setFocus
```
public boolean setFocus(String id)
```
    Sets focus in the panel to this item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - setFocus
```
public boolean setFocus(String id,
                        PhantomHostFieldLocation hostFieldLocation)
```
    Sets focus in the panel to this item according to a host field location.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - selectField
```
public boolean selectField(String id)
```
    Performs a visual selection of the field. It is mainly used for entry capable controls.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - getLength
```
public int getLength(String id)
```
    Gets the control length. It is mainly used for entry capable controls.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    -1 for error or control menu item not found.
    0-nn control length.
  - setLength
```
public boolean setLength(String id,
                         int length)
```
    Sets the control length. It is mainly used for entry capable controls that is not host connected.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - setChecked
```
public boolean setChecked(String id,
                          int state)
```
    Sets the check state of a control (e.g. check box) or a menu item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - setChecked
```
public boolean setChecked(String id,
                          boolean state)
```
    Sets the check state of a control (e.g. check box) or a menu item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - isChecked
```
public int isChecked(String id)
```
    Gets the check state of a control (e.g. check box) or a menu item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    0 item is unchecked.
    1 item is checked.
    2 item is in third state.
    -1 for failure or control menu item not found.
  - isChecked2
```
public boolean isChecked2(String id)
```
    Gets the check state of a control (e.g. check box) or a menu item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    false item is unchecked or error.
    true item is checked.
  - getLineCount
```
public int getLineCount(String id)
```
    Gets the line count for a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    0-nn the count of lines.
    -1 failure or control menu item not found.
  - insertLine
```
public boolean insertLine(String id,
                          String data,
                          int line)
```
    Inserts a line in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - setLine
```
public boolean setLine(String id,
                       String data,
                       int line)
```
    Sets a line in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - getLine
```
public String getLine(String id,
                      int line)
```
    Sets a line in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    null for failure or control menu item not found, otherwise the string.
  - deleteLine
```
public boolean deleteLine(String id,
                          int line)
```
    Deletes a line in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - deleteAll
```
public boolean deleteAll(String id)
```
    Deletes all lines in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - setCell
```
public boolean setCell(String id,
                       int col,
                       int line,
                       String data)
```
    Sets a single cell in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Parameters:
    
    col - The column for the cell.
    
    line - The line for the column.
    
    data - The data for the cell.
    
    Returns:
    
    true for successful operation
    false for failure or control menu item not found.
  - getCell
```
public String getCell(String id,
                      int col,
                      int line)
```
    Gets a single cell in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Parameters:
    
    col - The column for the cell.
    
    line - The line for the column.
    
    Returns:
    
    The contents of the cell or null for failure or control menu item not found.
  - setSelection
```
public boolean setSelection(String id,
                            int line,
                            boolean select)
```
    Sets a line as selected (or not) in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - getNextSelection
```
public int getNextSelection(String id,
                            int line)
```
    Gets the next selected line in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    0-nn the next selected line.
    -1 no more selected lines or failure or control menu item not found.
  - setFileFromList
```
public boolean setFileFromList(String id,
                               PhantomOutputFile pFile)
```
    Insert the contents of a list into a file.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel). true for successful operation.
    false for failure or control menu item not found.
  - setListFromFile
```
public boolean setListFromFile(String id,
                               String fileName)
                        throws IOException
```
    Sets the contents of a list capable control from a file.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel). true for successful operation.
    false for failure or control menu item not found.
    
    Throws:
    
    IOException - for file failures.
  - callControl
```
public boolean callControl(String id)
```
    "Calls" the control in question. It is used by push buttons and menu items. When called, it generates a transaction to the client that causes it to update the server immediately. When this transaction is received, the control is "called", much like if the user had pressed and released the push button or selected the menu item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    true for successful operation.
    false the control doesn't support being "called" or control menu item not found.
  - setProperty
```
public boolean setProperty(int id,
                           String propertyName,
                           Object property)
```
    Sets a property of a virtual component.
    
    Returns:
    
    true for successful operation.
    false for failure.
  - getProperty
```
public Object getProperty(int id,
                          String propertyName)
```
    Gets a property of a virtual component.
    
    Returns:
    
    Object The object containing the property.
    null for failure.
  - setText
```
public boolean setText(int id,
                       String text)
```
    Sets the text of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - getText
```
public String getText(int id)
```
    Gets the text of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    text the control text
    null for no text support or control menu item not found.
  - setEnabled
```
public boolean setEnabled(int id,
                          boolean state)
```
    Sets the enabled state of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - isEnabled
```
public boolean isEnabled(int id)
```
    Gets the enabled state of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true item is enabled.
    false item is disabled or failure or control menu item not found.
  - setVisible
```
public boolean setVisible(int id,
                          boolean state)
```
    Sets the visibility state of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - isVisible
```
public boolean isVisible(int id)
```
    Gets the visibility state of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true item is visible.
    false item is hidden or failure or control menu item not found
  - setColor
```
public boolean setColor(int id,
                        se.entra.phantom.geditor.NPPColor color)
```
    Sets the color of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - getColor
```
public se.entra.phantom.geditor.NPPColor getColor(int id)
```
    Gets the color of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    
    Returns:
    
    NPPColor the color object.
    null for failure or control menu item not found.
  - setForegroundColor
```
public boolean setForegroundColor(int id,
                                  int colorIndex)
```
    Sets the foreground color of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - getForegroundColor
```
public int getForegroundColor(int id)
```
    Gets the foreground color of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    0-nn foreground color index.
    -1 for failure or control menu item not found.
  - setBackgroundColor
```
public boolean setBackgroundColor(int id,
                                  int colorIndex)
```
    Sets the background color of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - getBackgroundColor
```
public int getBackgroundColor(int id)
```
    Gets the background color of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    0-nn background color.
    -1 for failure or control menu item not found.
  - setFont
```
public boolean setFont(int id,
                       int font)
```
    Sets the font index of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - getFont
```
public int getFont(int id)
```
    Gets the font index of an item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    0-nn font index.
    -1 for failure or control menu item not found.
  - setFocus
```
public boolean setFocus(int id)
```
    Sets focus in the panel to this item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - setFocus
```
public boolean setFocus(int id,
                        PhantomHostFieldLocation hostFieldLocation)
```
    Sets focus in the panel to this item according to a host field location.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - selectField
```
public boolean selectField(int id)
```
    Performs a visual selection of the field. It is mainly used for entry capable controls.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - getLength
```
public int getLength(int id)
```
    Gets the control length. It is mainly used for entry capable controls.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    -1 for error or control menu item not found.
    0-nn control length.
  - setLength
```
public boolean setLength(int id,
                         int length)
```
    Sets the control length. It is mainly used for entry capable controls that is not host connected.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - setChecked
```
public boolean setChecked(int id,
                          int state)
```
    Sets the check state of a control (e.g. check box) or a menu item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - isChecked
```
public int isChecked(int id)
```
    Gets the check state of a control (e.g. check box) or a menu item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    0 item is unchecked.
    1 item is checked.
    2 item is in third state.
    -1 for failure or control menu item not found.
  - getLineCount
```
public int getLineCount(int id)
```
    Gets the line count for a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    0-nn the count of lines.
    -1 failure or control menu item not found.
  - insertLine
```
public boolean insertLine(int id,
                          String data,
                          int line)
```
    Inserts a line in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - setLine
```
public boolean setLine(int id,
                       String data,
                       int line)
```
    Sets a line in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - getLine
```
public String getLine(int id,
                      int line)
```
    Sets a line in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    null for failure or control menu item not found, otherwise the string.
  - deleteLine
```
public boolean deleteLine(int id,
                          int line)
```
    Deletes a line in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - deleteAll
```
public boolean deleteAll(int id)
```
    Deletes all lines in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - setCell
```
public boolean setCell(int id,
                       int col,
                       int line,
                       String data)
```
    Sets a single cell in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Parameters:
    
    col - The column for the cell.
    
    line - The line for the column.
    
    data - The data for the cell.
    
    Returns:
    
    True for successful operation
    false for failure or control menu item not found.
  - getCell
```
public String getCell(int id,
                      int col,
                      int line)
```
    Gets a single cell in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Parameters:
    
    col - The column for the cell.
    
    line - The line for the column.
    
    Returns:
    
    The contents of the cell or null for failure or control menu item not found.
  - setSelection
```
public boolean setSelection(int id,
                            int line,
                            boolean select)
```
    Sets a line as selected (or not) in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false for failure or control menu item not found.
  - getNextSelection
```
public int getNextSelection(int id,
                            int line)
```
    Gets the next selected line in a list capable control.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    0-nn the next selected line.
    -1 no more selected lines or failure or control menu item not found.
  - setFileFromList
```
public boolean setFileFromList(int id,
                               PhantomOutputFile pFile)
```
    Insert the contents of a list into a file.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance. true for successful operation.
    false for failure or control menu item not found.
  - setListFromFile
```
public boolean setListFromFile(int id,
                               String fileName)
                        throws IOException
```
    Sets the contents of a list capable control from a file.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance. true for successful operation.
    false for failure or control menu item not found.
    
    Throws:
    
    IOException - for file failures.
  - callControl
```
public boolean callControl(int id)
```
    "Calls" the control in question. It is used by push buttons and menu items. When called, it generates a transaction to the client that causes it to update the server immediately. When this transaction is received, the control is "called", much like if the user had pressed and released the push button or selected the menu item.
    This item must exist in the panel with the specified control ID (and not in a notebook inside the panel).
    The id must be a registered string with an ID in the VirtualRuntime class instance.
    
    Returns:
    
    true for successful operation.
    false the control doesn't support being "called" or control menu item not found.
  - onModalPanelCreated
```
public void onModalPanelCreated(JDialog dialog)
```
    Called when the modal dialog is created.
  - processPanel
```
public int processPanel()
```
    Processes this panel modally until a call to dismissPanel(rc) is called.
    
    Returns:
    
    -1 for failure (error message is printed to System.out),
    or the return code from dismissPanel().
    
    See Also:
    
    dismissPanel(int)
  - dismissPanel
```
public boolean dismissPanel(int rc)
```
    Dismisses this modal panel.
    
    Returns:
    
    false if the panel is already dismissed (and error output to System.out),
    true for success.
    
    See Also:
    
    processPanel()
  - destroy
```
public void destroy()
```
    Destroys this panel. The panel must have been created using VirtualSessionManager.create[Modal]Panel.
  - getListener
```
public VirtualPanelListener getListener()
```
    Gets the listener of this panel. This method should not be used as it may return the instance of a class implementing a VirtualPanelListener or VirtualComponentListener as well as VirtualComponentListenerMulticast in case of multiple panel listeners.
    
    Returns:
    
    null if no listener exists.
  - setListener
```
public void setListener(VirtualPanelListener listener)
```
    Sets the listener of this panel. This method should not be used anymore. The method addPanelListener should be used instead.
  - addPanelListener
```
public void addPanelListener(VirtualPanelListener listener)
```
    Adds a listener for this panel. The listener might be implementing the interface VirtualPanelListener (VirtualPanelAdapter) or VirtualComponentListener (VirtualComponentAdapter).
  - removePanelListener
```
public void removePanelListener(VirtualPanelListener listener)
```
    Removes a listener for this panel. The listener might be implementing the interface VirtualPanelListener (VirtualPanelAdapter) or VirtualComponentListener (VirtualComponentAdapter).
  - hasListener
```
public boolean hasListener()
```
    Checks if a panel has a listener.
  - getFirstNoteBook
```
public VirtualCNoteBook getFirstNoteBook()
```
    Gets the first notebook in this panel.
    
    Returns:
    
    null if not found.
  - getNextNoteBook
```
public VirtualCNoteBook getNextNoteBook(int fromIndex)
```
    Gets the first notebook in this panel.
    
    Returns:
    
    null if not found.
  - getNoteBook
```
public VirtualCNoteBook getNoteBook(String id)
```
    Gets the notebook of specified String ID in this panel.
    
    Returns:
    
    null if not found.
  - getNoteBook
```
public VirtualCNoteBook getNoteBook(int id)
```
    Gets the notebook of specified Numbered ID in this panel.
    
    Returns:
    
    null if not found.
  - getFirstNoteBookPagePanel
```
public VirtualPanel getFirstNoteBookPagePanel(int index)
```
    Gets the VirtualPanel associated with the notebook page index of the first notebook in this panel.
  - getFirstNoteBookPagePanel
```
public VirtualPanel getFirstNoteBookPagePanel(String pageID)
```
    Gets the VirtualPanel associated with the notebook page ID of the first notebook in this panel.
  - getNoteBookPagePanel
```
public VirtualPanel getNoteBookPagePanel(String id,
                                         int index)
```
    Gets the VirtualPanel associated with the notebook page index of the notebook with a String ID in this panel.
  - getNoteBookPagePanel
```
public VirtualPanel getNoteBookPagePanel(String id,
                                         String pageID)
```
    Gets the VirtualPanel associated with the notebook page ID of the notebook with a String ID in this panel.
  - messageBox
```
public int messageBox(int type,
                      int icon,
                      String message,
                      String title)
```
    Requests and displays a message to the user.
    A message box will be displayed to the user containing the message. This function can also be used to ask the user simple questions. Type and Icon above refer to the desired message type and message icon, respectively (see below).
    Note: At this time, only a Java application (i.e. running in a separate thread can be used to retrieve the return value. This is due to the fact that the client can respond to the message at a later time. This limitation may be removed in the future.
    Type: VirtualPanelListener.MB_* values
```
   MB_CANCEL            Message with Cancel button.
   MB_OK                Message with OK button.
   MB_OKCANCEL          Message with OK/Cancel question.
   MB_ENTER             Message with Enter button.
   MB_ENTERCANCEL       Message with Enter/Cancel question.
   MB_YESNO             Message with Yes/No question.
   MB_YESNOCANCEL       Message with Yes/No/Cancel question.
   MB_RETRYCANCEL       Message with Retry/Cancel question.
   MB_ABORTRETRYIGNORE  Message with Retry/Ignore/Cancel question.
 
```
    Icon: VirtualPanelListener.ICON_* values
```
   ICON_NOICON       No icon
   ICON_INFORMATION  Information code
   ICON_QUERY        Question mark
   ICON_WARNING      Warning code
   ICON_CRITICAL     Stop code, or critical
 
```
    Return value: VirtualPanelListener.MBID_* values
```
   MBID_DEFAULT  Incorrect parameters (cancel in general).
   MBID_CANCEL   Response: Cancel.
   MBID_OK       Response: OK.
   MBID_ENTER    Response: Enter.
   MBID_YES      Response: Yes.
   MBID_NO       Response: No.
   MBID_RETRY    Response: Retry.
   MBID_IGNORE   Response: Ignore.
 
```
  - messageBox
```
public int messageBox(int type,
                      int icon,
                      String message)
```
    Same as "messageBox(int type,int icon,String message,String title)", but without the title: it is taken from the panel title.
  - onSelectionChanged
```
public void onSelectionChanged(VirtualCListBox list,
                               int line,
                               int column)
```
    List boxes generates this message. The line and column parameter are individually set to -1 if no line or column is selected respectively.
  - onCheckedChange
```
public void onCheckedChange(VirtualControl control,
                            int state)
```
    Check boxes and radio buttons generates this event when state is changed on the client side.
    The state is 0=unchecked, 1=checked and 2=third state (only for check boxes, or PhantomCCheckBox.STATE_UNDETERMINED).
  - onContentChanged
```
public void onContentChanged(VirtualControl control,
                             String text)
```
    Entry fields and multiple line entry fields generates this message.
  - onContentChanged
```
public void onContentChanged(VirtualControl control,
                             String text,
                             int line)
```
    Combination boxes and spin buttons generates this message. The line parameter is set to -1 if no line is selected.
  - onPropertyChange
```
public void onPropertyChange(VirtualControl control,
                             String propertyName,
                             Object property)
```
    A control notifies the listener using this event when custom properties needs to be handled.
    The object is in general dependent of the property change event string.
  - onFocusGained
```
public void onFocusGained(VirtualControl control)
```
    Controls that can receive input focus generates this event when they gain focus.
  - onFocusLost
```
public void onFocusLost(VirtualControl control)
```
    Controls that can receive input focus generates this event when they lose focus.
  - onControlEvent
```
public void onControlEvent(VirtualControl control,
                           int event)
```
    The general notification event for "normal" controls. The panel will notify it's listener with this event.
  - isApplicationPanel
```
public boolean isApplicationPanel()
```
    Checks if this is an application panel.
  - addPanelEventListener
```
public void addPanelEventListener(VirtualPanelEventListener listener)
```
    Adds a panel event listener.
  - removePanelEventListener
```
public void removePanelEventListener(VirtualPanelEventListener listener)
```
    Removes a panel event listener.
  - isModal
```
public boolean isModal()
```
    Checks the panel modality flag.
  - setLockState
```
public void setLockState(boolean lock)
```
    Changes the lock state for the client session.
  - isDestroyed
```
public boolean isDestroyed()
```
    Checks if a panel is destroyed.

Class VirtualPanel

Field Summary

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

Fields inherited from interface se.entra.phantom.server.ObjectMessages

Fields inherited from interface se.entra.phantom.server.PhantomControlType

Fields inherited from interface se.entra.phantom.server.PhantomControlFlags

Fields inherited from interface se.entra.phantom.server.VirtualInterface

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createApplicationPanel

createNormalPanel

createNormalPanel

createNormalPanel

createNoteBookPagePanel

getComponentLockObject

isCreateRequired

isReCreateRequired

setUpdateTextPromptRequired

isNoteBookPage

getControlCount

getScreen

getPanelID

isGuiOnTheFlyPanel

isPanelHostConnected

getClientSession

getVirtualSessionManager

getRuntime

getApplication

getPanelData

getSystemMessageBox

getTextID

getHostScreen

getHostScreenName

setScreen

getPanelSession

getControl

isCursorPositionedAtHostUnlock

getControlFromID

getMenu

getMenuFromID

getMenuFromIndex

getMenuOrControlFromID

getMenuOrControlFromID

getControlConnectedToHost

getFirstSelectableControl

hasChanged

setProperty

getProperty

setTooltipText

getTooltipText

setText

getText

getIndex

create

callCreateBeforeHostCursor

callCreateAfterHostCursor

callCreate

isHostConnectedToCurrentScreen

update

fireUpdatesToClient

fireHostMessageBoxes

fireCreate

clientUpdated

issueAction

callObject

callObject

callAllControlObjects

callAllControlObjects

callAllControlObjects

callNBPanelAndControls

resetHostMessageBoxes

setChanged

setEnabled

isEnabled

setVisible

isVisible

setColor

getColor

setForegroundColor