VirtualControl (NetPhantom® 7.7 Java API Specification)

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

All Implemented Interfaces:

NetPhantomConstants, PhantomControlType, VirtualChangeEvent, VirtualClientMessages, VirtualInterface, VirtualTooltipInterface

Direct Known Subclasses:

VirtualCBusGraph, VirtualCCheckBox, VirtualCEntryField, VirtualCGroupBox, VirtualCListBox, VirtualCListCapableControl, VirtualCMLE, VirtualCNoteBook, VirtualCOutputText, VirtualCPushButton, VirtualCRadioButton, VirtualCRectangle, VirtualCStaticText, VirtualCSubWindow, VirtualCTree, VirtualCUnknown, VirtualCUserWindow
```
public abstract class VirtualControl
extends Object
implements PhantomControlType, VirtualInterface, VirtualTooltipInterface, VirtualClientMessages, VirtualChangeEvent, NetPhantomConstants
```
This class is the base class for all controls in a Phantom Panel. It handles the basic control data and states. It can also handle text data string for a control, such as a text prompt or a host field. This data will be sent automatically to the client when a panel creation or panel update transaction is to be sent.
It also supports the basic methods in the VirtualInterface, such as setting and getting the text (if the extending control supports text), font, enabled and visible states, etc.

Field Summary
- 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.VirtualInterface
  TOOLTIP_TEXT
- Fields inherited from interface se.entra.phantom.common.NetPhantomConstants
  ACTION_CLOSEWINDOW, ACTION_CONTROL, ACTION_HOSTKEY, ACTION_MENU, ACTION_NONE, ACTION_NOTEBOOKPAGE, ACTION_POPUPMENU, CC_BACKGROUND, CC_BOTH, CC_FOREGROUND, CC_NONE, CLIPBOARD_GET, CLIPBOARD_SET, DATEF_DMY, DATEF_MDY, DATEF_SYSTEM, DATEF_YMD, DDE_ADVISE, DDE_EXECUTE, DDE_INITIATE, DDE_POKE, DDE_REQUEST, DDE_TERMINATE, DDE_UNADVISE, DDE_UPDATE, DDEVAR_DISABLE, DDEVAR_ENABLE, DDEVAR_REQUEST, DDEVAR_SET, DDEVAR_VALIDATE, EFT_AMOUNT, EFT_DATE, EFT_DATEAMOUNT, EFT_NORMAL, EFT_PASSWORD, EVENT_CHAR, EVENT_CHECK, EVENT_CLICK, EVENT_COMMAND, EVENT_DBLCLICK, EVENT_DDECONNECTION, EVENT_DDEDATA, EVENT_DDEERROR, EVENT_DDEEXECUTE, EVENT_DDEINVALIDATE, EVENT_DDEPOKE, EVENT_DDEREQUEST, EVENT_DEFOCUS, EVENT_FOCUS, EVENT_PAGEDOWN, EVENT_PAGEUP, EVENT_SELECT, EVENT_UNKNOWN, EVENT_USERCHANGE, EXTENDEDINFO_IDS_TO_CLIENT, FOCUSTYPE_CLIENTTARGET, FOCUSTYPE_CONTROL, FOCUSTYPE_NONE, ICON_CRITICAL, ICON_INFORMATION, ICON_NOICON, ICON_QUERY, ICON_WARNING, J_AUTO, J_BOTTOM, J_BOTTOMLEFT, J_BOTTOMRIGHT, J_CENTER, J_LEFT, J_RIGHT, J_TOP, J_TOPLEFT, J_TOPRIGHT, MAX_PANELS_PER_SESSION, MAX_SESSIONS, MB_ABORTRETRYIGNORE, MB_CANCEL, MB_ENTER, MB_ENTERCANCEL, MB_OK, MB_OKCANCEL, MB_RETRYCANCEL, MB_YESNO, MB_YESNOCANCEL, MBID_CANCEL, MBID_DEFAULT, MBID_ENTER, MBID_IGNORE, MBID_NO, MBID_OK, MBID_RETRY, MBID_YES, MS_MOVE, MS_NONE, MS_SIZE, NETPHANTOM_COPYRIGHT, NETPHANTOM_COPYRIGHT2, NETPHANTOM_VERSION, OBJEVENT_CHECK, OBJEVENT_CLICK, OBJEVENT_DBLCLICK, OBJEVENT_DEFOCUS, OBJEVENT_FOCUS, OBJEVENT_SELECT, OBJEVENT_USERCHANGE, PANELCREATE_APPPANEL, PANELCREATE_DANGLINGPANEL, PANELCREATE_DLGFRAME, PANELCREATE_EXTENDEDINFO, PANELCREATE_ICON, PANELCREATE_INDIVIDUALSIZE, PANELCREATE_POPUP, REPLYTYPE_CLIENTEXECUTE, REPLYTYPE_CLIPBOARD, REPLYTYPE_DDE, REPLYTYPE_FFONTLIST, REPLYTYPE_MESSAGEBOX, REPLYTYPE_REPORT, REPLYTYPE_SAVEPROPS, REPLYTYPE_TERMMARK, RPRT_CANCELPRINTJOB, RPRT_CLOSEPRINTJOB, RPRT_CONTPRINTJOB, RPRT_OPENPRINTJOB, RPRT_PRINTJOBCANCLD, RPRT_PRINTJOBCLOSED, RPRT_PRINTJOBCONT, RPRT_PRINTJOBOPENED, RPRT_PRINTJOBSTARTED, RPRT_STARTPRINTJOB, SELMODE_NORMAL, SELMODE_NOTALLOWED, SELMODE_REQUIRED, SELTYPE_MULTIPLE, SELTYPE_SINGLE, SEPARATOR, SEPARATORCHAR, TRANS_APPLICATIONCHANGE, TRANS_CALLOBJECT, TRANS_CANCELEXIT, TRANS_CLEARLOCK, TRANS_CLIENTEXECUTE, TRANS_CLIENTJARS, TRANS_CLIENTTEXTTABLE, TRANS_CLIENTUPDATED, TRANS_CLIENTUPDATEDNOLOCK, TRANS_CLIPBOARD, TRANS_CLIPBOARDCOMPONENT, TRANS_CLOSETERMINALWINDOW, TRANS_CONNECTIONREFUSED, TRANS_COUNTRYINFO, TRANS_CREATEPANEL, TRANS_CREATESESSION, TRANS_DDE, TRANS_DDEEVENT, TRANS_DDEEVENTREPLY, TRANS_DDEVAREVENT, TRANS_DISPLAYHELP, TRANS_DISPLAYTERMINAL, TRANS_DISPLAYTOOLTIPS, TRANS_ENDCONVERSATION, TRANS_EXIT, TRANS_FONTSUBSTITUTION, TRANS_HOSTCOLORTABLE, TRANS_HOSTPRINT, TRANS_HWND, TRANS_INACTIVESESSION, TRANS_INITIATE, TRANS_KEEPALIVE, TRANS_LOCALE, TRANS_LOGEVENT, TRANS_MESSAGEBOX, TRANS_MESSAGEBOXWITHREPLY, TRANS_MODALREPLY, TRANS_MULTTERM, TRANS_PING, TRANS_PRINTCOMPONENT, TRANS_PRINTPANEL, TRANS_PRINTREPORT, TRANS_PRTWINKEY, TRANS_RECONNECT, TRANS_REDIRECTION, TRANS_REMOVEPANELATLEVEL, TRANS_REMOVETERMINAL, TRANS_RENEGOTIATESSL, TRANS_REQUESTHELP, TRANS_RESOURCEURL, TRANS_SELECTSESSION, TRANS_SESSIONACTIVE, TRANS_SESSIONSELECTED, TRANS_SETCOLORS, TRANS_SETFOCUS, TRANS_SETLOCK, TRANS_SETPANELNESTLEVEL, TRANS_SETUPPARAMS, TRANS_SHOWDOCUMENT, TRANS_SOCKET, TRANS_SOUNDALARM, TRANS_STARTUPINFO, TRANS_STOPSESSION, TRANS_TERMINALDATA, TRANS_TERMINALUPDATE, TRANS_TERMINALWINDOW, TRANS_TERMWINTEXT, TRANS_UPDATEAPPLICATION, TRANS_UPDATEPANEL, TRANS_USEREXITPRTKEY, TRANSACTION_VERSION, TS_CLOSE, TS_DATA, TS_ERROR, TS_OPEN, VSIGN_MINUS, VSIGN_NONE, VSIGN_PLUSMINUS, YEARF_6DIG, YEARF_8DIG, YEARF_EXP8

Constructor Summary

Constructors
Constructor and Description

VirtualControl(VirtualPanel panel, PhantomControl pc)
This constructor must be called from any derived classes.

Constructors
Constructor and Description
`VirtualControl(VirtualPanel panel, PhantomControl pc)` This constructor must be called from any derived classes.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendCreateTransaction(Transaction trans)` Appends the create transaction data that all controls must do.
`static void`	`appendFieldCheckTransaction(Transaction trans, int fieldType, boolean isDirectChecked, boolean isProtected)` Appends the field check transaction.
`static void`	`appendFontTransaction(Transaction trans, int font)` This static method can be used to add the font transaction to the client.
`void`	`appendUpdateTransaction(Transaction trans)` Appends the update transaction data that all controls must do.
`boolean`	`areTextPromptsAlwaysRefreshed()` If the class has a need to refresh the text prompt at all host changed, it must reply `true` to this method call.
`boolean`	`callControl()` "Calls" the control in question.
`String`	`callObject(int action, String argString)` Calls the control's object (if defined).
`String`	`callObject(String controlID, int action, String argString)` Calls the control's object (if defined).
`abstract void`	`clientUpdated(Transaction trans)` This method is called from the VirtualPanel to cause a client transaction to update the panels.
`boolean`	`deleteAll()` Deletes all lines in a list capable control.
`boolean`	`deleteLine(int line)` Deletes a line in a list capable control.
`void`	`dispose()` This method is called whenever a panel has been disposed of, in order to remove listeners, etc, in order to free up memory.
`void`	`fireCreate(Transaction trans)` This method is used to fire a create message to the client by a virtual class.
`void`	`fireUpdate(Transaction trans)` This method is used to fire an update message to the client by a virtual class.
`int`	`getBackgroundColor()` Gets the background color of an item.
`PhantomControl`	`getBasicData()` Get the basic Phantom-data for this control.
`String`	`getCell(int col, int line)` Gets a single cell in a list capable control.
`ClientSessionInterface`	`getClientSession()` Gets the client session.
`se.entra.phantom.geditor.NPPColor`	`getColor()` Get color of an item.
`Object`	`getComponentLockObject()` Gets the lock object for synchronization for Control Components.
`VirtualControl`	`getControlConnectedToHost(PhantomHostScreen screen, PhantomHostField hostField, int flags)` Check if control is connected to host field.
`String`	`getControlID()` Get the controls ID or null if none.
`ControlIDHostFieldID`	`getControlIDHostFieldID()` Gets the control ID and a possible host field ID.
`int`	`getControlType()` Gets the control type (PhantomControlType.CTRLTYPE_*).
`HostSession`	`getCurrentHostSession()` Gets the current host session.
`protected int`	`getExtraUpdateFlags()` Gets the extra flags used for the update transaction.
`int`	`getFont()` Gets the font index of an item.
`int`	`getForegroundColor()` Gets the foreground color of an item.
`PhantomHostField`	`getHostField(PhantomHostField hostField, String hostFieldName)` Resolves the reference to a host field.
`String`	`getID()` Gets the ID of this control.
`int`	`getIndex()` Gets the index of this control.
`int`	`getLength()` Gets the control length.
`String`	`getLine(int line)` Sets a line in a list capable control.
`int`	`getLineCount()` Gets the line count for a list capable control.
`int`	`getNextSelection(int line)` Gets the next selected line in a list capable control.
`PhantomObject`	`getObject()` Gets the object of the control.
`VirtualPanel`	`getPanel()` Gets the virtual panel where the control is a child.
`VirtualControl`	`getPreviousConnectedControl()` Gets the previous connected control.
`Object`	`getProperty(String propertyName)` Gets a property of a virtual component.
`VirtualControl`	`getSelectableControl(int flags)` Check if this control can receive focus (is selectable).
`String`	`getText()` Gets the text of an item.
`VirtualTextData`	`getTextData()` Gets the text data instance.
`String`	`getTooltipText()` Gets the tool tip text of this component.
`VirtualSessionManager`	`getVirtualSessionManager()` Gets the VirtualSessionManager instance.
`boolean`	`hasChanged()` Checks if the base control data with possible text data has changed.
`void`	`hostScreenChanged(PhantomHostScreen screen)` The connected host screen has changed.
`boolean`	`insertLine(String data, int line)` Inserts a line in a list capable control.
`int`	`isChecked()` Gets the check state of a control (e.g.
`boolean`	`isConnectToNextControlPropertySet()` Override this method and return true if you're a static text or a group box.
`boolean`	`isDirectChecked()` Is characters direct checked.
`boolean`	`isEnabled()` Gets the enabled state of an item.
`boolean`	`isNewGroup()` Checks if this control is the start of a new group of controls.
`abstract void`	`issueAction(Transaction trans)` Every virtual control could be updated with data from the client.
`void`	`issueControlAction(int actionEvent, Transaction trans, VirtualHostField hostField)` This method is invoked by the server kernel when an event has occurred on the client side (such as a push button has been pressed).
`boolean`	`isTabSkipped()` Checks if tab stop should be skipped for this control.
`boolean`	`isVisible()` Gets the visibility state of an item.
`static int`	`parseRuntimeFont(int font)` Get/parse font from old style runtime file into multi functional integer.
`void`	`refresh()` This method is used to refresh all virtual controls when e.g.
`void`	`refreshTextPrompts()` This method is used to refresh all virtual classes that have text prompt data in them.
`void`	`refreshTextPrompts(boolean alwaysRefresh)` Refreshes the text prompts, but with a flag indicating the text prompts always needs to be updated, due to a panel that is created or recreated.
`void`	`requestFocus()` Requests focus for the control.
`boolean`	`selectField()` Performs a visual selection of the field.
`boolean`	`setBackgroundColor(int colorIndex)` Sets the background color of an item.
`boolean`	`setCell(int col, int line, String data)` Sets a single cell in a list capable control.
`void`	`setChanged()` This method is used to indicate that a virtual class has changed and that it needs to update the client.
`boolean`	`setChecked(int state)` Sets the check state of a control (e.g.
`boolean`	`setColor(se.entra.phantom.geditor.NPPColor newcolor)` Set the color of an item.
`boolean`	`setEnabled(boolean state)` Sets the enabled state of an item.
`boolean`	`setFileFromList(PhantomOutputFile pFile)` Insert the contents of a list into a file.
`boolean`	`setFocus()` Sets focus in the panel to this item.
`boolean`	`setFocus(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`	`setForegroundColor(int colorIndex)` Sets the foreground color of an item.
`boolean`	`setLength(int length)` Sets the control length.
`boolean`	`setLine(String data, int line)` Sets a line in a list capable control.
`boolean`	`setListFromFile(String fileName)` Sets the contents of a list capable control from a file.
`boolean`	`setProperty(String propertyName, Object property)` Sets a property of a virtual component.
`boolean`	`setSelection(int line, boolean select)` Sets a line as selected (or not) in a list capable control.
`boolean`	`setText(String text)` Sets the text of an item.
`boolean`	`setTooltipText(String text)` Sets the tool tip text to a value for this component.
`void`	`setupControlIDObject(String controlID, PhantomObject object)` Sets up a control ID and the object reference.
`void`	`setVirtualText(VirtualTextData td)` Assigns a class that handles text data, e.g.
`boolean`	`setVisible(boolean state)` Sets the visibility state of an item.
`void`	`textFileChanged()` Text file is changed.

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

- Constructor Detail
  - VirtualControl
```
public VirtualControl(VirtualPanel panel,
                      PhantomControl pc)
```
    This constructor must be called from any derived classes.
- Method Detail
  - getComponentLockObject
```
public Object getComponentLockObject()
```
    Gets the lock object for synchronization for Control Components.
  - dispose
```
public void dispose()
```
    This method is called whenever a panel has been disposed of, in order to remove listeners, etc, in order to free up memory. Normal controls doesn't need to do anything here.
  - setupControlIDObject
```
public void setupControlIDObject(String controlID,
                                 PhantomObject object)
```
    Sets up a control ID and the object reference. This call is not required for controls that do not have such members.
  - getTextData
```
public VirtualTextData getTextData()
```
    Gets the text data instance.
    
    Returns:
    
    null if none has been set-up.
  - getPanel
```
public VirtualPanel getPanel()
```
    Gets the virtual panel where the control is a child.
  - getVirtualSessionManager
```
public VirtualSessionManager getVirtualSessionManager()
```
    Gets the VirtualSessionManager instance.
  - setVirtualText
```
public void setVirtualText(VirtualTextData td)
```
    Assigns a class that handles text data, e.g. for static text or entry field. The appendTransaction and appendUpdateTransaction will automatically add the transaction required for the text data.
  - requestFocus
```
public void requestFocus()
```
    Requests focus for the control.
  - setProperty
```
public boolean setProperty(String propertyName,
                           Object property)
```
    Sets a property of a virtual component. Supported property is currently only TOOLTIP_TEXT.
    
    Specified by:
    
    setProperty in interface VirtualInterface
    
    Returns:
    
    true for successful operation.
    false for failure.
  - setTooltipText
```
public boolean setTooltipText(String text)
```
    Sets the tool tip text to a value for this component.
    
    Specified by:
    
    setTooltipText in interface VirtualTooltipInterface
    
    Returns:
    
    true for successful operation.
  - getTooltipText
```
public String getTooltipText()
```
    Gets the tool tip text of this component.
    
    Specified by:
    
    getTooltipText in interface VirtualTooltipInterface
    
    Returns:
    
    Empty string for no tool tip (or empty), otherwise the string.
  - getProperty
```
public Object getProperty(String propertyName)
```
    Gets a property of a virtual component. Supported property is currently only TOOLTIP_TEXT.
    
    Specified by:
    
    getProperty in interface VirtualInterface
    
    Returns:
    
    Object The object containing the property.
    null for failure.
  - 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.
  - setEnabled
```
public boolean setEnabled(boolean state)
```
    Sets the enabled state of an item.
    
    Specified by:
    
    setEnabled in interface VirtualInterface
    
    Returns:
    
    true for successful operation.
  - isEnabled
```
public boolean isEnabled()
```
    Gets the enabled state of an item.
    
    Specified by:
    
    isEnabled in interface VirtualInterface
    
    Returns:
    
    true item is enabled.
    false item is disabled or failure.
  - setVisible
```
public boolean setVisible(boolean state)
```
    Sets the visibility state of an item.
    
    Specified by:
    
    setVisible in interface VirtualInterface
    
    Returns:
    
    true for successful operation.
  - isVisible
```
public boolean isVisible()
```
    Gets the visibility state of an item.
    
    Specified by:
    
    isVisible in interface VirtualInterface
    
    Returns:
    
    true item is visible.
    false item is hidden or failure.
  - setColor
```
public boolean setColor(se.entra.phantom.geditor.NPPColor newcolor)
```
    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. See NPPColorItemManager for indexes.
    
    Specified by:
    
    setForegroundColor in interface VirtualInterface
    
    Returns:
    
    true for successful operation.
    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:
    
    foreground color or -1 if error.
  - setBackgroundColor
```
public boolean setBackgroundColor(int colorIndex)
```
    Sets the background color of an item. See NPPColorItemManager for indexes.
    
    Specified by:
    
    setBackgroundColor in interface VirtualInterface
    
    Returns:
    
    true for successful operation.
    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:
    
    0-nn background color index or -1 if error.
  - setFont
```
public boolean setFont(int font)
```
    Sets the font index of an item.
    
    Specified by:
    
    setFont in interface VirtualInterface
    
    Returns:
    
    true for successful operation.
    false for failure.
  - getFont
```
public int getFont()
```
    Gets the font index of an item.
    
    Specified by:
    
    getFont in interface VirtualInterface
    
    Returns:
    
    0-nn font index.
  - 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. This method will only call setFocus.
    
    Specified by:
    
    setFocus in interface VirtualInterface
    
    Returns:
    
    boolean according to setFocus() method.
    
    See Also:
    
    setFocus()
  - 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 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)
                        throws IOException
```
    Sets the contents of a list capable control from a file.
    
    Specified by:
    
    setListFromFile in interface VirtualInterface
    
    Parameters:
    
    fileName - the file name.
    
    Returns:
    
    true for successful operation.
    false for failure.
    
    Throws:
    
    IOException - for file failures.
  - 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".
  - setChanged
```
public void setChanged()
```
    This method is used to indicate that a virtual class has changed and that it needs to update the client. It is also notified to its parent, the virtual panel.
    
    Specified by:
    
    setChanged in interface VirtualChangeEvent
  - hasChanged
```
public boolean hasChanged()
```
    Checks if the base control data with possible text data has changed. If this has been changed, an update transaction is required. This transaction will occur at a later point in time, by the ClientWorker thread.
    The text change flag is not checked in this method, the control subclassing this class is responsible to call "setChanged()" whenever any child component of the virtual control has changed. This will guarantee that the entire chain of components, even upwards in the tree will synchronize the client panels and components.
    
    Specified by:
    
    hasChanged in interface VirtualChangeEvent
  - refresh
```
public void refresh()
```
    This method is used to refresh all virtual controls when e.g. a new panel is created or when any host change occurs.
    
    Specified by:
    
    refresh in interface VirtualClientMessages
  - refreshTextPrompts
```
public void refreshTextPrompts()
```
    This method is used to refresh all virtual classes that have text prompt data in them. The parameter mustRefresh is set when the panel is created or recreated. If the class has a need to refresh the text prompt at all host changed, it must reply true to the method call areTextPromptsAlwaysRefreshed.
    Override this method if other text prompts than the registered one can change.
    
    Specified by:
    
    refreshTextPrompts in interface VirtualClientMessages
  - refreshTextPrompts
```
public void refreshTextPrompts(boolean alwaysRefresh)
```
    Refreshes the text prompts, but with a flag indicating the text prompts always needs to be updated, due to a panel that is created or recreated.
  - areTextPromptsAlwaysRefreshed
```
public boolean areTextPromptsAlwaysRefreshed()
```
    If the class has a need to refresh the text prompt at all host changed, it must reply true to this method call. Otherwise return false.
    A class extending VirtualControl have to override this method and return true if the text prompts need a constant refresh.
    
    Specified by:
    
    areTextPromptsAlwaysRefreshed in interface VirtualClientMessages
  - hostScreenChanged
```
public void hostScreenChanged(PhantomHostScreen screen)
```
    The connected host screen has changed. This can cause a need to change the host screen for host fields.
    All controls extending from VirtualControl must override this method for it's own host field processing if this is required.
  - fireCreate
```
public void fireCreate(Transaction trans)
```
    This method is used to fire a create message to the client by a virtual class.
    
    Specified by:
    
    fireCreate in interface VirtualClientMessages
  - fireUpdate
```
public void fireUpdate(Transaction trans)
```
    This method is used to fire an update message to the client by a virtual class.
    
    Specified by:
    
    fireUpdate in interface VirtualClientMessages
  - appendCreateTransaction
```
public void appendCreateTransaction(Transaction trans)
```
    Appends the create transaction data that all controls must do.
  - getExtraUpdateFlags
```
protected int getExtraUpdateFlags()
```
    Gets the extra flags used for the update transaction. These flags can be between 0x02 and 0x1F where bit 0 must be zero. This method must be overridden in order to return non-zero (the default).
  - appendUpdateTransaction
```
public void appendUpdateTransaction(Transaction trans)
```
    Appends the update transaction data that all controls must do.
  - appendFontTransaction
```
public static void appendFontTransaction(Transaction trans,
                                         int font)
```
    This static method can be used to add the font transaction to the client. The font index in Phantom is changed, because e.g. the System Monospaced or Phantom System VIO fonts doesn't exist. A good mapping to Courier, Helvetica and Times is done.
  - parseRuntimeFont
```
public static int parseRuntimeFont(int font)
```
    Get/parse font from old style runtime file into multi functional integer.
  - appendFieldCheckTransaction
```
public static void appendFieldCheckTransaction(Transaction trans,
                                               int fieldType,
                                               boolean isDirectChecked,
                                               boolean isProtected)
```
    Appends the field check transaction.
    The following data is sent:
```
  + BYTE   (bit 0-5: field type, bit 6: protected=not editable, bit 7: isDirectChecked).
 
```
  - getPreviousConnectedControl
```
public VirtualControl getPreviousConnectedControl()
```
    Gets the previous connected control. A static text and a group box control can have such a property set.
    
    Returns:
    
    null if none exist.
  - isConnectToNextControlPropertySet
```
public boolean isConnectToNextControlPropertySet()
```
    Override this method and return true if you're a static text or a group box.
  - getIndex
```
public int getIndex()
```
    Gets the index of this control.
  - clientUpdated
```
public abstract void clientUpdated(Transaction trans)
```
    This method is called from the VirtualPanel to cause a client transaction to update the panels. Override this method in order to provide the appropriate control behavior, matching the client request.
    
    Parameters:
    
    trans - A transaction that is already being processed.
  - issueAction
```
public abstract void issueAction(Transaction trans)
```
    Every virtual control could be updated with data from the client. The issueAction is called in order to perform an action, e.g. the push button host send key. This method is directed from the control's panel or notebook page, in order to execute the requested action.
    Override this method in order to process controls that can carry actions from the client.
    
    Parameters:
    
    trans - A transaction that is already being processed.
  - issueControlAction
```
public final void issueControlAction(int actionEvent,
                                     Transaction trans,
                                     VirtualHostField hostField)
```
    This method is invoked by the server kernel when an event has occurred on the client side (such as a push button has been pressed). Every updateable control (in the VirtualNnnn classes) are set to reflect the changes made on the client side.
  - callObject
```
public String callObject(int action,
                         String argString)
```
    Calls the control's object (if defined).
    
    Returns:
    
    null if no object exist.
  - callObject
```
public String callObject(String controlID,
                         int action,
                         String argString)
```
    Calls the control's object (if defined).
    
    Returns:
    
    null if no object exist.
  - getCurrentHostSession
```
public HostSession getCurrentHostSession()
```
    Gets the current host session.
    
    Returns:
    
    null if no current session exist.
  - getClientSession
```
public ClientSessionInterface getClientSession()
```
    Gets the client session.
  - getHostField
```
public PhantomHostField getHostField(PhantomHostField hostField,
                                     String hostFieldName)
```
    Resolves the reference to a host field.
    
    Returns:
    
    null if the host field is either not defined or not found.
  - textFileChanged
```
public void textFileChanged()
```
    Text file is changed. This method should be overloaded by any controls that uses Text ID's.
    
    Specified by:
    
    textFileChanged in interface VirtualClientMessages
  - getControlConnectedToHost
```
public VirtualControl getControlConnectedToHost(PhantomHostScreen screen,
                                                PhantomHostField hostField,
                                                int flags)
```
    Check if control is connected to host field. This method should be overwritten by any control that connects to a host field.
    
    Returns:
    
    VirtualControl if connected, otherwise null if not connected.
  - getSelectableControl
```
public VirtualControl getSelectableControl(int flags)
```
    Check if this control can receive focus (is selectable). This method should be overwritten by any control that connects to a host field.
    
    Returns:
    
    VirtualControl if selectable, otherwise null.
  - getControlID
```
public String getControlID()
```
    Get the controls ID or null if none.
  - getControlType
```
public int getControlType()
```
    Gets the control type (PhantomControlType.CTRLTYPE_*).
  - getControlIDHostFieldID
```
public ControlIDHostFieldID getControlIDHostFieldID()
```
    Gets the control ID and a possible host field ID. The control ID and/or host field ID may be null if the control doesn't support it.
  - isTabSkipped
```
public boolean isTabSkipped()
```
    Checks if tab stop should be skipped for this control.
  - isDirectChecked
```
public boolean isDirectChecked()
```
    Is characters direct checked.
    
    Returns:
    
    Default implementation returns false.
  - isNewGroup
```
public boolean isNewGroup()
```
    Checks if this control is the start of a new group of controls. This is important information for e.g. radio buttons.
    
    Returns:
    
    true if this is a new group, false otherwise.
  - getObject
```
public PhantomObject getObject()
```
    Gets the object of the control.
    
    Returns:
    
    null if no object is assigned, otherwise the assigned PhantomObject.
  - getID
```
public String getID()
```
    Gets the ID of this control.
    
    Returns:
    
    the ID of the control, or empty string or null for none.
  - getBasicData
```
public PhantomControl getBasicData()
```
    Get the basic Phantom-data for this control.

Class VirtualControl

Field Summary

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

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VirtualControl

Method Detail

getComponentLockObject

dispose

setupControlIDObject

getTextData

getPanel

getVirtualSessionManager

setVirtualText

requestFocus

setProperty

setTooltipText

getTooltipText

getProperty

setText

getText

setEnabled

isEnabled

setVisible

isVisible

setColor

getColor

setForegroundColor

getForegroundColor

setBackgroundColor

getBackgroundColor

setFont

getFont

setFocus

setFocus

selectField

getLength

setLength

setChecked

isChecked

getLineCount

insertLine

setLine

getLine

deleteLine

deleteAll

setCell

getCell

setSelection

getNextSelection

setFileFromList

setListFromFile

callControl

setChanged

hasChanged

refresh

refreshTextPrompts

refreshTextPrompts

areTextPromptsAlwaysRefreshed

hostScreenChanged

fireCreate

fireUpdate

appendCreateTransaction

getExtraUpdateFlags

appendUpdateTransaction

appendFontTransaction

parseRuntimeFont

appendFieldCheckTransaction

getPreviousConnectedControl

isConnectToNextControlPropertySet

getIndex

clientUpdated

issueAction

issueControlAction

callObject

callObject