VirtualCListBox (NetPhantom® 7.7 Java API Specification)

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

All Implemented Interfaces:

NetPhantomConstants, PhantomControlType, VirtualChangeEvent, VirtualClientMessages, VirtualInterface, VirtualTooltipInterface
```
public class VirtualCListBox
extends VirtualControl
```
A Virtual ListBox.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class VirtualCListBox.CellData
A subclass that implements a record in the listboxs update que.

Nested Classes
Modifier and Type	Class and Description
`class`	`VirtualCListBox.CellData` A subclass that implements a record in the listboxs update que.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CHANGE_HEADER_TXT` The constant for change header text.
`static int`	`CHANGE_LINE` The constant for existing line changed.
`static int`	`DELETE_LINE` The constant for single line deleted.
`static int`	`HOST_CELL_HIDDEN` The constant for a hidden cell flag.
`static int`	`HOST_CELL_ISUNCREATED` The constant for a uncreated cell in an expandable list.
`static int`	`HOST_CELL_PROTECTED` The constant for a protected cell flag.
`static int`	`INSERT_LINE` The constant for single line inserted.
`static int`	`RESET_SELECTION` The constant for reset selection.
`static int`	`SET_SELECTION` The constant for set selection.
`static int`	`UPDATE_ALL` The constant for whole list box updated.
`static int`	`UPDATE_ALL_WITH_FOCUS`
`static int`	`UPDATE_ALL_WITH_RESET` The constant for a reseted list.
`static int`	`UPDATE_CELLS` Constant for updated cells.
`static int`	`UPDATE_FOCUS_CELL` Constant for update of cell focus.

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

VirtualCListBox(VirtualPanel panel, PhantomCListBox data)
Creates a new virtual listbox.

Constructors
Constructor and Description
`VirtualCListBox(VirtualPanel panel, PhantomCListBox data)` Creates a new virtual listbox.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`areTextPromptsAlwaysRefreshed()` Determines if the listbox has a need to refresh the text prompt at all host changed.
`void`	`clientUpdated(Transaction trans)` The client has sent an update transaction to the server.
`boolean`	`deleteAll()` Deletes the whole listbox.
`boolean`	`deleteLine(int line)` Deletes a single line.
`void`	`fireCreate(Transaction trans)` Appends the fire create data for the listbox to the fire create transaction to the client.
`void`	`fireUpdate(Transaction trans)` Fires the update transaction to the client.
`String`	`getCell(int col, int line)` Gets a single cell from the list.
`VirtualCListBox.CellData`	`getCellData(int col, int line, VirtualCListBox.CellData cd)` Gets a single cell data from the list.
`String`	`getCellText(int col, int line)` Gets the text from a single cell in the list.
`VirtualControl`	`getControlConnectedToHost(PhantomHostScreen screen, PhantomHostField hostField, int flags)` Check if control is connected to host field.
`PhantomCListBox`	`getData()`
`int`	`getFirstLine()` Gets the line number for the first line.
`int`	`getLastLine()` Gets the line number for the last line.
`String`	`getLine(int line)` Get a single row from listbox.
`String[]`	`getLineCells(int line)` Gets the line data into an array of strings rather than a tab delimited format.
`int`	`getLineCount()` Gets the number of lines in the listbox.
`PhantomCListBox`	`getListBoxData()` Gets the data object for the list box.
`int`	`getNewTotLines()` Gets the new total number of lines in the list.
`int`	`getNextSelection(int line)` Gets the next selected line after the specified line.
`int`	`getPageDownIndex()` Get page down control index.
`int`	`getPageUpIndex()` Get page up control index.
`VirtualControl`	`getSelectableControl(int flags)` Check if this control can receive focus (is selectable).
`int`	`getTotLines()` Gets the total number of lines in the list.
`void`	`hostScreenChanged(PhantomHostScreen screen)` The connected host screen has changed.
`boolean`	`insertLine(String text, int line)` Inserts a line in the listbox.
`boolean`	`isListEmpty()` Is list empty.
`boolean`	`isSelectionFieldEnable(int line)` Check if listbox selection host field is enable for a certain row.
`void`	`issueAction(int actionEvent, Transaction trans)` Processes client or internal events.
`void`	`issueAction(Transaction trans)` Processes action events from the client to the listbox.
`void`	`refresh()` This method is used to refresh the contents of the virtual classes.
`void`	`refreshTextPrompts(boolean alwaysRefresh)` Text prompts has to be refreshed because of a host change.
`boolean`	`setCell(int col, int line, String data)` Sets a single cell in a list.
`boolean`	`setCellFocus(int col, int line)` Sets the cell focus or cursor position to col/line.
`boolean`	`setFileFromList(PhantomOutputFile pFile)` Writes the list to 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.
`void`	`setInitialFocus()` Sets the initial focus in a single select list with at least one row.
`boolean`	`setLine(String text, int line)` Sets the data in a existing line in the listbox.
`boolean`	`setLineSelectionString(String text)` Sets the selection field on a selected line.
`void`	`setListCursor(int row, int col)` Set host cursor to listbox cell (if move-cursor option is set).
`boolean`	`setListFromFile(String fileName)` Sets the contents of a list capable control from a file.
`boolean`	`setSelection(int line, boolean isSelect)` Changes the selection state on a line.
`boolean`	`setSelectionFlags(int lines, boolean isHostUpdate)` Sets the flags for selected lines.
`void`	`textFileChanged()` Text file is changed.
`boolean`	`updateHostCell(int col, int line, String newText)` Update cell data in editable cell.
`void`	`updateHostSelectionField()` Update host selection string from listbox selection.

Methods inherited from class se.entra.phantom.server.VirtualControl
appendCreateTransaction, appendFieldCheckTransaction, appendFontTransaction, appendUpdateTransaction, callControl, callObject, callObject, dispose, getBackgroundColor, getBasicData, getClientSession, getColor, getComponentLockObject, getControlID, getControlIDHostFieldID, getControlType, getCurrentHostSession, getExtraUpdateFlags, getFont, getForegroundColor, getHostField, getID, getIndex, getLength, getObject, getPanel, getPreviousConnectedControl, getProperty, getText, getTextData, getTooltipText, getVirtualSessionManager, hasChanged, isChecked, isConnectToNextControlPropertySet, isDirectChecked, isEnabled, isNewGroup, issueControlAction, isTabSkipped, isVisible, parseRuntimeFont, refreshTextPrompts, requestFocus, selectField, setBackgroundColor, setChanged, setChecked, setColor, setEnabled, setFont, setForegroundColor, setLength, setProperty, setText, setTooltipText, setupControlIDObject, setVirtualText, setVisible

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

- Field Detail
  - UPDATE_ALL
```
public static final int UPDATE_ALL
```
    The constant for whole list box updated.
    
    See Also:
    
    Constant Field Values
  - CHANGE_LINE
```
public static final int CHANGE_LINE
```
    The constant for existing line changed.
    
    See Also:
    
    Constant Field Values
  - INSERT_LINE
```
public static final int INSERT_LINE
```
    The constant for single line inserted.
    
    See Also:
    
    Constant Field Values
  - DELETE_LINE
```
public static final int DELETE_LINE
```
    The constant for single line deleted.
    
    See Also:
    
    Constant Field Values
  - SET_SELECTION
```
public static final int SET_SELECTION
```
    The constant for set selection.
    
    See Also:
    
    Constant Field Values
  - RESET_SELECTION
```
public static final int RESET_SELECTION
```
    The constant for reset selection.
    
    See Also:
    
    Constant Field Values
  - CHANGE_HEADER_TXT
```
public static final int CHANGE_HEADER_TXT
```
    The constant for change header text.
    
    See Also:
    
    Constant Field Values
  - UPDATE_ALL_WITH_RESET
```
public static final int UPDATE_ALL_WITH_RESET
```
    The constant for a reseted list.
    
    See Also:
    
    Constant Field Values
  - UPDATE_ALL_WITH_FOCUS
```
public static final int UPDATE_ALL_WITH_FOCUS
```
    See Also:
    
    Constant Field Values
  - UPDATE_CELLS
```
public static final int UPDATE_CELLS
```
    Constant for updated cells.
    
    See Also:
    
    Constant Field Values
  - UPDATE_FOCUS_CELL
```
public static final int UPDATE_FOCUS_CELL
```
    Constant for update of cell focus.
    
    See Also:
    
    Constant Field Values
  - HOST_CELL_HIDDEN
```
public static final int HOST_CELL_HIDDEN
```
    The constant for a hidden cell flag.
    
    See Also:
    
    Constant Field Values
  - HOST_CELL_PROTECTED
```
public static final int HOST_CELL_PROTECTED
```
    The constant for a protected cell flag.
    
    See Also:
    
    Constant Field Values
  - HOST_CELL_ISUNCREATED
```
public static final int HOST_CELL_ISUNCREATED
```
    The constant for a uncreated cell in an expandable list.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - VirtualCListBox
```
public VirtualCListBox(VirtualPanel panel,
                       PhantomCListBox data)
```
    Creates a new virtual listbox. This class handles all the data and settings for the listbox.
    
    Parameters:
    
    panel - The virtual panel to which this control belong.
    
    data - The data for the listbox.
- Method Detail
  - getData
```
public PhantomCListBox getData()
```
  - 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.
    
    Overrides:
    
    hostScreenChanged in class VirtualControl
  - getControlConnectedToHost
```
public VirtualControl getControlConnectedToHost(PhantomHostScreen screen,
                                                PhantomHostField hostField,
                                                int flags)
```
    Check if control is connected to host field. This method is overwritten from VirtualControl.
    
    Overrides:
    
    getControlConnectedToHost in class VirtualControl
    
    Parameters:
    
    screen - The Phantom host screen.
    
    hostField - The Phantom host field.
    
    flags -
    
    Returns:
    
    true if connected, otherwise false if not connected.
  - getSelectableControl
```
public VirtualControl getSelectableControl(int flags)
```
    Check if this control can receive focus (is selectable). This method is overwritten from VirtualControl.
    
    Overrides:
    
    getSelectableControl in class VirtualControl
    
    Returns:
    
    VirtualControl if selectable, otherwise null.
  - areTextPromptsAlwaysRefreshed
```
public boolean areTextPromptsAlwaysRefreshed()
```
    Determines if the listbox has a need to refresh the text prompt at all host changed.
    
    Specified by:
    
    areTextPromptsAlwaysRefreshed in interface VirtualClientMessages
    
    Overrides:
    
    areTextPromptsAlwaysRefreshed in class VirtualControl
    
    Returns:
    
    true if the listbox needs to refresh text prompts, false otherwise.
  - refreshTextPrompts
```
public void refreshTextPrompts(boolean alwaysRefresh)
```
    Text prompts has to be refreshed because of a host change.
    
    Overrides:
    
    refreshTextPrompts in class VirtualControl
    
    Parameters:
    
    alwaysRefresh - Tells if the text prompts should always be refreshed.
  - textFileChanged
```
public void textFileChanged()
```
    Text file is changed.
    
    Specified by:
    
    textFileChanged in interface VirtualClientMessages
    
    Overrides:
    
    textFileChanged in class VirtualControl
  - refresh
```
public void refresh()
```
    This method is used to refresh the contents of the virtual classes.
    
    Specified by:
    
    refresh in interface VirtualClientMessages
    
    Overrides:
    
    refresh in class VirtualControl
  - setSelectionFlags
```
public boolean setSelectionFlags(int lines,
                                 boolean isHostUpdate)
```
    Sets the flags for selected lines.
    
    Parameters:
    
    lines - The number of data lines in the list.
  - getFirstLine
```
public int getFirstLine()
```
    Gets the line number for the first line.
    
    Returns:
    
    The first lines line number.
  - getLastLine
```
public int getLastLine()
```
    Gets the line number for the last line.
    
    Returns:
    
    The last lines line number.
  - getTotLines
```
public int getTotLines()
```
    Gets the total number of lines in the list.
    
    Returns:
    
    The total number of lines in the list.
  - getNewTotLines
```
public int getNewTotLines()
```
    Gets the new total number of lines in the list.
    
    Returns:
    
    The new total number of lines in the list.
  - isListEmpty
```
public boolean isListEmpty()
```
    Is list empty.
  - getPageUpIndex
```
public int getPageUpIndex()
```
    Get page up control index.
  - getPageDownIndex
```
public int getPageDownIndex()
```
    Get page down control index.
  - setInitialFocus
```
public void setInitialFocus()
```
    Sets the initial focus in a single select list with at least one row. The initial focus will be set to row 0, col 0.
  - fireCreate
```
public void fireCreate(Transaction trans)
```
    Appends the fire create data for the listbox to the fire create transaction to the client.
    Specified by:
    
    fireCreate in interface VirtualClientMessages
    
    Overrides:
    
    fireCreate in class VirtualControl
    
    Parameters:
    trans - The create transaction to which we want to append listbox data.
    It appends the following data to he create transaction:
    + STRING id + SHORT double-click field index + SHORT page up field index + SHORT page down field index + BYTE number of columns + SHORT the header height + BYTE the headers background color (for all headers) + BYTE the lists background color (for all columns) + USHORT the listbox font + USHORT the header font + USHORT the serial number for the listboxs data + USHORT listbox flags nnnn nnnn nnnn nnn1 = no selection allowed nnnn nnnn nnnn nn1n = multiselection allowed nnnn nnnn nnnn n1nn = has vertical scrollbar nnnn nnnn nnnn 1nnn = has horizontal scrollbar nnnn nnnn nnn1 nnnn = has individual scrollbars on each column nnnn nnnn nn1n nnnn = has line between rows nnnn nnnn n1nn nnnn = has page up/down buttons nnnn nnnn 1nnn nnnn = vertical scrollbar as heigh as list nnnn nnn1 nnnn nnnn = right to left nnnn nn1n nnnn nnnn = border around listbox nnnn n1nn nnnn nnnn = divider between headers are single line nnnn 1nnn nnnn nnnn = divider between headers are double line nn01 nnnn nnnn nnnn = divider between header and column is single line nn10 nnnn nnnn nnnn = divider between header and culumn is double line 01nn nnnn nnnn nnnn = divider between columns are single lines 10nn nnnn nnnn nnnn = divider between columns are double lines + BYTE common column and extra listboxs flags nnnn nnn1 = columns are moveable nnnn nn1n = columns are sortable nnnn n1nn = expand last column to the right nnnn 1nnn = send page up/down directly to host nnn1 nnnn = enter performs new line nn1n nnnn = list is expandable + USHORT number of lines in the listbox + ... the individual columns data (as defined in fireCreateColumn)
    Finally it sets the flag hasBeenCreated to true.
  - fireUpdate
```
public void fireUpdate(Transaction trans)
```
    Fires the update transaction to the client.
    The update transaction can be of several different types. The update types are:
```
   UPDATE_ALL         Updates the whole list.
   CHANGE_LINE        Changes a single existing line.
   INSERT_LINE        Inserts a new line.
   DELETE_LINE        Deletes a existing line.
   SET_SELECTION      Selects a line.
   RESET_SELECTION    Deselects a line.
   CHANGE_HEADER_TXT  Changes the header texts.
 
```
    Specified by:
    
    fireUpdate in interface VirtualClientMessages
    
    Overrides:
    
    fireUpdate in class VirtualControl
    
    Parameters:
    
    trans - The update transaction.
    
    See Also:
    
    UPDATE_ALL, CHANGE_LINE, INSERT_LINE, DELETE_LINE, SET_SELECTION, RESET_SELECTION, CHANGE_HEADER_TXT
  - clientUpdated
```
public void clientUpdated(Transaction trans)
```
    The client has sent an update transaction to the server.
    
    Specified by:
    
    clientUpdated in class VirtualControl
    
    Parameters:
    
    trans - The update transaction.
  - updateHostSelectionField
```
public void updateHostSelectionField()
```
    Update host selection string from listbox selection.
  - updateHostCell
```
public boolean updateHostCell(int col,
                              int line,
                              String newText)
```
    Update cell data in editable cell.
    
    Returns:
    
    true for OK or false for error.
  - 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
    
    Overrides:
    
    setListFromFile in class VirtualControl
    
    Parameters:
    
    fileName - the file name.
    
    Returns:
    
    true for successful operation.
    false for failure.
    
    Throws:
    
    IOException - for file failures.
  - insertLine
```
public boolean insertLine(String text,
                          int line)
```
    Inserts a line in the listbox.
    
    Specified by:
    
    insertLine in interface VirtualInterface
    
    Overrides:
    
    insertLine in class VirtualControl
    
    Parameters:
    
    text - The lines data.
    
    line - The line number for the new line. If -1 then append to end of list.
    
    Returns:
    
    true for successful operation, false for failure.
  - setLine
```
public boolean setLine(String text,
                       int line)
```
    Sets the data in a existing line in the listbox.
    
    Specified by:
    
    setLine in interface VirtualInterface
    
    Overrides:
    
    setLine in class VirtualControl
    
    Parameters:
    
    text - The lines data in a tab separated string.
    
    line - The line to update.
    
    Returns:
    
    false for failure.
  - setFileFromList
```
public boolean setFileFromList(PhantomOutputFile pFile)
```
    Writes the list to a file.
    
    Specified by:
    
    setFileFromList in interface VirtualInterface
    
    Overrides:
    
    setFileFromList in class VirtualControl
    
    Parameters:
    
    pFile - The Phantom-file to write to.
    
    Returns:
    
    true for successful operation, false for failure.
  - getLine
```
public String getLine(int line)
```
    Get a single row from listbox.
    
    Specified by:
    
    getLine in interface VirtualInterface
    
    Overrides:
    
    getLine in class VirtualControl
    
    Parameters:
    
    line - The line to retrieve.
    
    Returns:
    
    The line. If more than one column, the columns will be tab-separated. If line is invalid, null is returned.
  - getLineCells
```
public String[] getLineCells(int line)
```
    Gets the line data into an array of strings rather than a tab delimited format.
    
    Parameters:
    
    line - The line to retrieve.
    
    Returns:
    
    The line cells in a string array, or null for error in line number.
  - getLineCount
```
public int getLineCount()
```
    Gets the number of lines in the listbox.
    
    Specified by:
    
    getLineCount in interface VirtualInterface
    
    Overrides:
    
    getLineCount in class VirtualControl
    
    Returns:
    
    The number of lines.
  - getListBoxData
```
public PhantomCListBox getListBoxData()
```
    Gets the data object for the list box.
    
    Returns:
    
    The number of lines.
  - deleteAll
```
public boolean deleteAll()
```
    Deletes the whole listbox.
    
    Specified by:
    
    deleteAll in interface VirtualInterface
    
    Overrides:
    
    deleteAll in class VirtualControl
    
    Returns:
    
    true for successful operation, false for failure.
  - deleteLine
```
public boolean deleteLine(int line)
```
    Deletes a single line.
    
    Specified by:
    
    deleteLine in interface VirtualInterface
    
    Overrides:
    
    deleteLine in class VirtualControl
    
    Parameters:
    
    line - The line to delete.
    
    Returns:
    
    true for successful operation, false for failure.
  - setFocus
```
public boolean setFocus()
```
    Sets focus in the panel to this item.
    
    Specified by:
    
    setFocus in interface VirtualInterface
    
    Overrides:
    
    setFocus in class VirtualControl
    
    Returns:
    
    true for success.
  - setFocus
```
public boolean setFocus(PhantomHostFieldLocation hostFieldLocation)
```
    Sets focus in the panel to this item according to a host field location.
    Set the selection to the appropriate lineOffset in hostFieldLocation and the column according to the hostFieldLocation.hostField.getName(). This does *not* mean that a multiple selection list gets this line selection changed in any way.
    
    Specified by:
    
    setFocus in interface VirtualInterface
    
    Overrides:
    
    setFocus in class VirtualControl
    
    Returns:
    
    true for success.
    
    See Also:
    
    VirtualControl.setFocus()
  - setSelection
```
public boolean setSelection(int line,
                            boolean isSelect)
```
    Changes the selection state on a line.
    
    Specified by:
    
    setSelection in interface VirtualInterface
    
    Overrides:
    
    setSelection in class VirtualControl
    
    Parameters:
    
    line - The line on which to change the selection state.
    
    isSelect - The new selection state.
    
    Returns:
    
    true for successful operation, false for failure.
  - setCellFocus
```
public boolean setCellFocus(int col,
                            int line)
```
    Sets the cell focus or cursor position to col/line. When a cell cannot be selected individually, i.e. when line selection and no editability is used, set col=-1.
  - getNextSelection
```
public int getNextSelection(int line)
```
    Gets the next selected line after the specified line.
    
    Specified by:
    
    getNextSelection in interface VirtualInterface
    
    Overrides:
    
    getNextSelection in class VirtualControl
    
    Parameters:
    
    line - The line from which to start the search.
    
    Returns:
    
    The number of the next selected line, or -1 if no selected line.
  - setCell
```
public boolean setCell(int col,
                       int line,
                       String data)
```
    Sets a single cell in a list.
    
    Specified by:
    
    setCell in interface VirtualInterface
    
    Overrides:
    
    setCell in class VirtualControl
    
    Parameters:
    
    col - The column for the cell.
    
    line - The line for the cell.
    
    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 from the list.
    
    Specified by:
    
    getCell in interface VirtualInterface
    
    Overrides:
    
    getCell in class VirtualControl
    
    Parameters:
    
    col - The column for the cell.
    
    line - The line for the cell.
    
    Returns:
    
    The contents of the cell.
  - getCellText
```
public String getCellText(int col,
                          int line)
```
    Gets the text from a single cell in the list. Any color codes for the cell will be stripped from the result.
    
    Parameters:
    
    col - The column for the cell.
    
    line - The line for the cell.
    
    Returns:
    
    The contents of the cell.
  - getCellData
```
public VirtualCListBox.CellData getCellData(int col,
                                            int line,
                                            VirtualCListBox.CellData cd)
```
    Gets a single cell data from the list.
    
    Parameters:
    
    col - The column for the cell.
    
    line - The line for the cell.
    
    cd - If preallocated.
    
    Returns:
    
    Object CellData containing data for the cell.
  - issueAction
```
public void issueAction(Transaction trans)
```
    Processes action events from the client to the listbox.
    
    Specified by:
    
    issueAction in class VirtualControl
    
    Parameters:
    
    trans - The transaction from which the action event is extracted from.
  - issueAction
```
public void issueAction(int actionEvent,
                        Transaction trans)
```
    Processes client or internal events.
    
    Parameters:
    
    actionEvent - The action event.
    
    trans - The transaction.
  - setListCursor
```
public void setListCursor(int row,
                          int col)
```
    Set host cursor to listbox cell (if move-cursor option is set). This method is used when updating listbox from HTML application.
  - isSelectionFieldEnable
```
public boolean isSelectionFieldEnable(int line)
```
    Check if listbox selection host field is enable for a certain row. The method also return true if there is no selection field.
    
    Returns:
    
    true if selection enable, or false if selection is protected.
  - setLineSelectionString
```
public boolean setLineSelectionString(String text)
```
    Sets the selection field on a selected line. This method is usually called when there is a connected menu-item or pushbutton that wants to set the selection field.
    
    Parameters:
    
    text - The text to write in the selection field.
    
    Returns:
    
    Always return false.

Class VirtualCListBox

Nested Class Summary

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 se.entra.phantom.server.VirtualControl

Methods inherited from class java.lang.Object

Field Detail

UPDATE_ALL

CHANGE_LINE

INSERT_LINE

DELETE_LINE

SET_SELECTION

RESET_SELECTION

CHANGE_HEADER_TXT

UPDATE_ALL_WITH_RESET

UPDATE_ALL_WITH_FOCUS

UPDATE_CELLS

UPDATE_FOCUS_CELL

HOST_CELL_HIDDEN

HOST_CELL_PROTECTED

HOST_CELL_ISUNCREATED

Constructor Detail

VirtualCListBox

Method Detail

getData

hostScreenChanged

getControlConnectedToHost

getSelectableControl

areTextPromptsAlwaysRefreshed

refreshTextPrompts

textFileChanged

refresh

setSelectionFlags

getFirstLine

getLastLine

getTotLines

getNewTotLines

isListEmpty

getPageUpIndex

getPageDownIndex

setInitialFocus

fireCreate

fireUpdate

clientUpdated

updateHostSelectionField

updateHostCell

setListFromFile

insertLine

setLine

setFileFromList

getLine

getLineCells

getLineCount

getListBoxData

deleteAll

deleteLine

setFocus

setFocus

setSelection

setCellFocus

getNextSelection

setCell

getCell

getCellText

getCellData

issueAction

issueAction

setListCursor

isSelectionFieldEnable

setLineSelectionString