PhantomCListBox (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- se.entra.phantom.server.PhantomControl
- - se.entra.phantom.server.PhantomCListBox

All Implemented Interfaces:
Cloneable, NetPhantomConstants, PhantomControlFlags, PhantomControlType
```
public class PhantomCListBox
extends PhantomControl
implements NetPhantomConstants
```
This class loads the control definition from the Phantom Panel file.
Author:
Christopher Mindus, Jean Bergström

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
class PhantomCListBox.PhantomCListBoxColumn
Loads and keeps the definition of a list box column.

Nested Classes
Modifier and Type	Class and Description
`class`	`PhantomCListBox.PhantomCListBoxColumn` Loads and keeps the definition of a list box column.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CFLAGS_COLMOVEABLE` The constant for the columns moveable flag in CFlags.
`static int`	`CFLAGS_COLSORTABLE` The constant for the columns sortable flag in CFlags.
`static int`	`CFLAGS_EXPANDRIGHT` The constant for the expand last column right flag in CFlags.
`static int`	`CFLAGS_NEXTLINE` The constant for the enter performs new line flag in CFlags.
`static int`	`CFLAGS_PAGEUPDOWN` The constant for the page up/down buttons flag in CFlags.
`static int`	`CFLAGS_SELREQ` The constant for selection is requiered.
`static int`	`CFLAGS_XPAND` The constant for list is expandable flag in CFlags.
`PhantomCListBox.PhantomCListBoxColumn[]`	`colContr` The columnControllers.
`int`	`colCount` Number of columns.
`int`	`colFlags` Common flags for all columns.
`static int`	`COLFLAGS_ACTKEYPAD` The constant for the activate keypad flag in ColFlags.
`static int`	`COLFLAGS_AUTOTAB` The constant for the autotab flag in ColFlags.
`static int`	`COLFLAGS_COLCENTJUST` The constant for the column center justified flag in ColFlags.
`static int`	`COLFLAGS_COLLEFTJUST` The constant for the column left justified flag in ColFlags.
`static int`	`COLFLAGS_COLRIGHTJUST` The constant for the column right justified flag in ColFlags.
`static int`	`COLFLAGS_CURSBEG` The constant for the cursor at beginning flag in ColFlags.
`static int`	`COLFLAGS_EDITABLE` The constant for the editable flag in ColFlags.
`static int`	`COLFLAGS_HEADCENTJUST` The constant for the header center justified flag in ColFlags.
`static int`	`COLFLAGS_HEADLEFTJUST` The constant for the header left justified flag in ColFlags.
`static int`	`COLFLAGS_HEADRIGHTJUST` The constant for the header right justified flag in ColFlags.
`static int`	`COLFLAGS_HINDINUM` The constant for the hindi-numeric flag in ColFlags.
`static int`	`COLFLAGS_RTOL` The constant for the right to left text flag in ColFlags.
`static int`	`COLFLAGS_SELENT` The constant for the select entire field flag in ColFlags.
`static int`	`COLMOVEABLE` The constant for movable columns flag.
`int`	`color` Color.
`int`	`colSbar` Column scrollbar flag.
`static int`	`COLSORTABLE` The constant for the sortable columns flag.
`int`	`divBetwCols` Type of divider between columns.
`int`	`divBetwHeadCol` Divider between header and column.
`int`	`divBetwHeaders` Divider between headers.
`String`	`doubleClickID` Double click ID.
`int`	`doubleClickIndex` Double click ID index for fast access.
`int`	`emptyLineEnds` Empty line ends.
`static int`	`ENDPROTSEL` The constant for the list ends at first protected selection line.
`int`	`expand` Expandable list.
`static int`	`EXPANDRIGHT` The constant for the expand last column flag.
`String`	`fieldName` Field Name.
`static int`	`FLAGS_BORDER` The constant for the listbox has border flag in Flags.
`static int`	`FLAGS_COLDIV_DOUBLE` The constant for the double line column divider flag in Flags.
`static int`	`FLAGS_COLDIV_SINGLE` The constant for the single line column divider flag in Flags.
`static int`	`FLAGS_COLSBAR` The constant for the column scrollbars flag in Flags.
`static int`	`FLAGS_HCDIV_DOUBLE` The constant for the double line header-column divider flag in Flags.
`static int`	`FLAGS_HCDIV_SINGLE` The constant for the single line header-column divider flag in Flags.
`static int`	`FLAGS_HEADDIV_DOUBLE` The constant for the double line header divider flag in Flags.
`static int`	`FLAGS_HEADDIV_SINGLE` The constant for the single line header divider flag in Flags.
`static int`	`FLAGS_HORZSBAR` The constant for the horizontal scrollbar flag in Flags.
`static int`	`FLAGS_LINEBROWS` The constant for the line between rows flag in Flags.
`static int`	`FLAGS_LISTHEIGHT` The constant for the vertical scrollbar has list height flag in Flags.
`static int`	`FLAGS_MULSEL` The constant for the multiple selection flag in Flags.
`static int`	`FLAGS_NOSEL` The constant for the no selection flag in Flags.
`static int`	`FLAGS_PAGEUD` The constant for the page up/down buttons flag in Flags.
`static int`	`FLAGS_RTOL` The constant for the right to left flag in Flags.
`static int`	`FLAGS_VERTSBAR` The constant for the vertical scrollbar flag in Flags.
`int`	`font` Font.
`int`	`headColor` Header color.
`int`	`headCY` Header height.
`int`	`headerBgColor` The header background color.
`int`	`headFont` Header font.
`int`	`horSbar` Horizontal scrollbar.
`int`	`lineBetwRows` Line between rows.
`int`	`listBgColor` The background color.
`static int`	`LISTCOL_ALWUPD` The constant for the always update text flag in PHR-file.
`static int`	`LISTCOL_AUTOTAB` The constant for the auto tab flag.
`static int`	`LISTCOL_BACKGROUND` The constant for the background color flag.
`static int`	`LISTCOL_CURFIRST` The constant for the set cursor at first position in field flag.
`static int`	`LISTCOL_FOREGROUND` The constant for the foreground color flag.
`static int`	`LISTCOL_KEYPAD` The constant for the activate keypad flag.
`static int`	`LISTCOL_NOTSELFIELD` The constant for do not select entire field.
`static int`	`LISTCOL_XLATE` The constant for the use translation table flag.
`static int`	`LISTCOLNF_HINDI` The constant for the hindi numeric mask.
`static int`	`LISTCOLNF_RTL` The constant for the right to left mask.
`int`	`listFlags` List flags.
`int`	`listxFlags` ListBox flags.
`int`	`moveCursor` Move cursor.
`int`	`multisel` Multi-select.
`static int`	`NEXTLINE` The constant that indicates that Enter key (otherwise Ctrl+Enter) performs a new line in an editable list box.
`int`	`noBorder` No border.
`int`	`noSelection` No selection allowed flag.
`int`	`noVertSbar` No vertical scrollbar.
`String`	`objectName` Object name.
`int`	`pageButtons` Page buttons flag.
`int`	`pageDownIndex`
`static int`	`PAGEUPDOWN` The constant for the send page up/down directly to host flag.
`int`	`pageUpIndex`
`String`	`pgdnId` Page down ID.
`int`	`pgdnSendKey` Send key for page down.
`String`	`pgupId` Page up ID.
`int`	`pgupSendKey` Send key for page up.
`static int`	`RTOL` The constant for right to left flag.
`PhantomHostField`	`selectionHostField` The PhantomHostField, may be null if no selection host field exist or if the panel is not connected to a host screen.
`String`	`selectString` Select string.
`int`	`selImplied` Selection implied.
`int`	`topbotList` Top bottom.
`PhantomHostField`	`topBottomHostField` The PhantomHostField, may be null if not a top-bottom list or if the panel is not connected to a host screen.
`String`	`unselectString` Unselect string.
`int`	`vertSize` Vertical scrollbar as heigh as list.

Fields inherited from class se.entra.phantom.server.PhantomControl
controlBase, controlColor, id, index, isBackgroundConverted, isForegroundConverted, object, panelData, popupMenu, tooltipText

Fields inherited from interface se.entra.phantom.common.NetPhantomConstants
ACTION_CLOSEWINDOW, ACTION_CONTROL, ACTION_HOSTKEY, ACTION_MENU, ACTION_NONE, ACTION_NOTEBOOKPAGE, ACTION_POPUPMENU, BUILD_NUMBER, BUILD_STRING, 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, TEST_BUILD, 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, VERSION_MAJOR, VERSION_MINOR, VERSION_NUMBER, VERSION_STRING, VSIGN_MINUS, VSIGN_NONE, VSIGN_PLUSMINUS, YEARF_6DIG, YEARF_8DIG, YEARF_EXP8

Fields inherited from interface se.entra.phantom.server.PhantomControlType
CTRLTYPE_BUTTON, CTRLTYPE_CHECK, CTRLTYPE_COMBO, CTRLTYPE_FRAME, CTRLTYPE_GRAPH, CTRLTYPE_GROUP, CTRLTYPE_INOUT, CTRLTYPE_LIST, CTRLTYPE_MLE, CTRLTYPE_NOTE, CTRLTYPE_OUT, CTRLTYPE_RADIO, CTRLTYPE_RECT, CTRLTYPE_SPIN, CTRLTYPE_SUB, CTRLTYPE_TEXT, CTRLTYPE_TREE, CTRLTYPE_UNKNOWN, CTRLTYPE_USER, CTRLTYPES_COUNT, names

Fields inherited from interface se.entra.phantom.server.PhantomControlFlags
CTRLFLAG_MOVEX, CTRLFLAG_MOVEY, CTRLFLAG_NEWGROUP, CTRLFLAG_SIZEX, CTRLFLAG_SIZEY, CTRLFLAG_SUBWIN, CTRLFLAG_TABSTOP, CTRLFLAG_TRANSPARENT

Constructor Summary

Constructors
Constructor and Description
`PhantomCListBox(PhantomFile data)` Constructor for Designer control.
`PhantomCListBox(PhantomFile data, PhantomPanelData panelData, int index, PhantomControlBase controlBase)` Creates an instance of the control class.
`PhantomCListBox(PhantomPanelData panelData, PhantomControlBase bc, int headCy, int[] lineValues, GofListColumnElement[] gofListColumnElements)` Creates a control class for a listbox on Gui-on-the-Fly panel.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addNPObjects(ENPObject obj)` Gets the NPObject for the control.
`boolean`	`doEndListAtProtSel()` Checks if the list ends at first protected selection line.
`protected boolean`	`equalsControl(PhantomControl c)` Checks for control equality.
`String`	`getControlObjectID()` Needs override by the control if the `object` instance if not resolved in this class instance.
`int`	`getDataSize(PhantomOutputFile outputFile)` Get the size when saved to file.
`boolean`	`isActionConnectedEnabled()` Checks if a control is action connected to another.
`void`	`rebind()` Re-bind the panel data.
`void`	`reloadObject()` Reload object reference.
`void`	`resolveComponentReferences()` Resolves double click reference of this control to other panel component, after the panel has been loaded.
`void`	`save(PhantomOutputFile file)` Saves the instance of the control to file.
`void`	`updateGuiOnTheFlyValue(CRC32 crc32)` Updates the CRC32 value of a Gui-on-the-fly value with the control's base data.
`void`	`updateReferences(ApplicationReferences refs)` Updates the Applications References instance.

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

- Field Detail
  - COLMOVEABLE
```
public static final int COLMOVEABLE
```
    The constant for movable columns flag.
    See Also:
    Constant Field Values
  - COLSORTABLE
```
public static final int COLSORTABLE
```
    The constant for the sortable columns flag.
    See Also:
    Constant Field Values
  - ENDPROTSEL
```
public static final int ENDPROTSEL
```
    The constant for the list ends at first protected selection line.
    See Also:
    Constant Field Values
  - EXPANDRIGHT
```
public static final int EXPANDRIGHT
```
    The constant for the expand last column flag.
    See Also:
    Constant Field Values
  - PAGEUPDOWN
```
public static final int PAGEUPDOWN
```
    The constant for the send page up/down directly to host flag.
    See Also:
    Constant Field Values
  - NEXTLINE
```
public static final int NEXTLINE
```
    The constant that indicates that Enter key (otherwise Ctrl+Enter) performs a new line in an editable list box.
    See Also:
    Constant Field Values
  - RTOL
```
public static final int RTOL
```
    The constant for right to left flag.
    See Also:
    Constant Field Values
  - LISTCOL_FOREGROUND
```
public static final int LISTCOL_FOREGROUND
```
    The constant for the foreground color flag.
    See Also:
    Constant Field Values
  - LISTCOL_BACKGROUND
```
public static final int LISTCOL_BACKGROUND
```
    The constant for the background color flag.
    See Also:
    Constant Field Values
  - LISTCOL_XLATE
```
public static final int LISTCOL_XLATE
```
    The constant for the use translation table flag.
    See Also:
    Constant Field Values
  - LISTCOL_ALWUPD
```
public static final int LISTCOL_ALWUPD
```
    The constant for the always update text flag in PHR-file.
    See Also:
    Constant Field Values
  - LISTCOL_AUTOTAB
```
public static final int LISTCOL_AUTOTAB
```
    The constant for the auto tab flag.
    See Also:
    Constant Field Values
  - LISTCOL_KEYPAD
```
public static final int LISTCOL_KEYPAD
```
    The constant for the activate keypad flag.
    See Also:
    Constant Field Values
  - LISTCOL_CURFIRST
```
public static final int LISTCOL_CURFIRST
```
    The constant for the set cursor at first position in field flag.
    See Also:
    Constant Field Values
  - LISTCOL_NOTSELFIELD
```
public static final int LISTCOL_NOTSELFIELD
```
    The constant for do not select entire field.
    See Also:
    Constant Field Values
  - LISTCOLNF_RTL
```
public static final int LISTCOLNF_RTL
```
    The constant for the right to left mask.
    See Also:
    Constant Field Values
  - LISTCOLNF_HINDI
```
public static final int LISTCOLNF_HINDI
```
    The constant for the hindi numeric mask.
    See Also:
    Constant Field Values
  - FLAGS_NOSEL
```
public static final int FLAGS_NOSEL
```
    The constant for the no selection flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_MULSEL
```
public static final int FLAGS_MULSEL
```
    The constant for the multiple selection flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_VERTSBAR
```
public static final int FLAGS_VERTSBAR
```
    The constant for the vertical scrollbar flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_HORZSBAR
```
public static final int FLAGS_HORZSBAR
```
    The constant for the horizontal scrollbar flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_COLSBAR
```
public static final int FLAGS_COLSBAR
```
    The constant for the column scrollbars flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_LINEBROWS
```
public static final int FLAGS_LINEBROWS
```
    The constant for the line between rows flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_PAGEUD
```
public static final int FLAGS_PAGEUD
```
    The constant for the page up/down buttons flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_LISTHEIGHT
```
public static final int FLAGS_LISTHEIGHT
```
    The constant for the vertical scrollbar has list height flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_RTOL
```
public static final int FLAGS_RTOL
```
    The constant for the right to left flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_BORDER
```
public static final int FLAGS_BORDER
```
    The constant for the listbox has border flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_HEADDIV_SINGLE
```
public static final int FLAGS_HEADDIV_SINGLE
```
    The constant for the single line header divider flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_HEADDIV_DOUBLE
```
public static final int FLAGS_HEADDIV_DOUBLE
```
    The constant for the double line header divider flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_HCDIV_SINGLE
```
public static final int FLAGS_HCDIV_SINGLE
```
    The constant for the single line header-column divider flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_HCDIV_DOUBLE
```
public static final int FLAGS_HCDIV_DOUBLE
```
    The constant for the double line header-column divider flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_COLDIV_SINGLE
```
public static final int FLAGS_COLDIV_SINGLE
```
    The constant for the single line column divider flag in Flags.
    See Also:
    Constant Field Values
  - FLAGS_COLDIV_DOUBLE
```
public static final int FLAGS_COLDIV_DOUBLE
```
    The constant for the double line column divider flag in Flags.
    See Also:
    Constant Field Values
  - CFLAGS_COLMOVEABLE
```
public static final int CFLAGS_COLMOVEABLE
```
    The constant for the columns moveable flag in CFlags.
    See Also:
    Constant Field Values
  - CFLAGS_COLSORTABLE
```
public static final int CFLAGS_COLSORTABLE
```
    The constant for the columns sortable flag in CFlags.
    See Also:
    Constant Field Values
  - CFLAGS_EXPANDRIGHT
```
public static final int CFLAGS_EXPANDRIGHT
```
    The constant for the expand last column right flag in CFlags.
    See Also:
    Constant Field Values
  - CFLAGS_PAGEUPDOWN
```
public static final int CFLAGS_PAGEUPDOWN
```
    The constant for the page up/down buttons flag in CFlags.
    See Also:
    Constant Field Values
  - CFLAGS_NEXTLINE
```
public static final int CFLAGS_NEXTLINE
```
    The constant for the enter performs new line flag in CFlags.
    See Also:
    Constant Field Values
  - CFLAGS_XPAND
```
public static final int CFLAGS_XPAND
```
    The constant for list is expandable flag in CFlags.
    See Also:
    Constant Field Values
  - CFLAGS_SELREQ
```
public static final int CFLAGS_SELREQ
```
    The constant for selection is requiered.
    See Also:
    Constant Field Values
  - COLFLAGS_HEADLEFTJUST
```
public static final int COLFLAGS_HEADLEFTJUST
```
    The constant for the header left justified flag in ColFlags.
    See Also:
    Constant Field Values
  - COLFLAGS_HEADRIGHTJUST
```
public static final int COLFLAGS_HEADRIGHTJUST
```
    The constant for the header right justified flag in ColFlags.
    See Also:
    Constant Field Values
  - COLFLAGS_HEADCENTJUST
```
public static final int COLFLAGS_HEADCENTJUST
```
    The constant for the header center justified flag in ColFlags.
    See Also:
    Constant Field Values
  - COLFLAGS_COLLEFTJUST
```
public static final int COLFLAGS_COLLEFTJUST
```
    The constant for the column left justified flag in ColFlags.
    See Also:
    Constant Field Values
  - COLFLAGS_COLRIGHTJUST
```
public static final int COLFLAGS_COLRIGHTJUST
```
    The constant for the column right justified flag in ColFlags.
    See Also:
    Constant Field Values
  - COLFLAGS_COLCENTJUST
```
public static final int COLFLAGS_COLCENTJUST
```
    The constant for the column center justified flag in ColFlags.
    See Also:
    Constant Field Values
  - COLFLAGS_EDITABLE
```
public static final int COLFLAGS_EDITABLE
```
    The constant for the editable flag in ColFlags.
    See Also:
    Constant Field Values
  - COLFLAGS_CURSBEG
```
public static final int COLFLAGS_CURSBEG
```
    The constant for the cursor at beginning flag in ColFlags.
    See Also:
    Constant Field Values
  - COLFLAGS_SELENT
```
public static final int COLFLAGS_SELENT
```
    The constant for the select entire field flag in ColFlags.
    See Also:
    Constant Field Values
  - COLFLAGS_AUTOTAB
```
public static final int COLFLAGS_AUTOTAB
```
    The constant for the autotab flag in ColFlags.
    See Also:
    Constant Field Values
  - COLFLAGS_ACTKEYPAD
```
public static final int COLFLAGS_ACTKEYPAD
```
    The constant for the activate keypad flag in ColFlags.
    See Also:
    Constant Field Values
  - COLFLAGS_RTOL
```
public static final int COLFLAGS_RTOL
```
    The constant for the right to left text flag in ColFlags.
    See Also:
    Constant Field Values
  - COLFLAGS_HINDINUM
```
public static final int COLFLAGS_HINDINUM
```
    The constant for the hindi-numeric flag in ColFlags.
    See Also:
    Constant Field Values
  - horSbar
```
public int horSbar
```
    Horizontal scrollbar.
  - multisel
```
public int multisel
```
    Multi-select.
  - colCount
```
public int colCount
```
    Number of columns.
  - objectName
```
public String objectName
```
    Object name.
  - fieldName
```
public String fieldName
```
    Field Name.
  - font
```
public int font
```
    Font.
  - emptyLineEnds
```
public int emptyLineEnds
```
    Empty line ends.
  - color
```
public int color
```
    Color.
  - selImplied
```
public int selImplied
```
    Selection implied.
  - divBetwCols
```
public int divBetwCols
```
    Type of divider between columns. Can be on of the following values:
```
    0 = no line
    1 = single line
    2 = double line
 
```
  - doubleClickID
```
public String doubleClickID
```
    Double click ID.
  - doubleClickIndex
```
public int doubleClickIndex
```
    Double click ID index for fast access.
  - pgdnId
```
public String pgdnId
```
    Page down ID.
  - pageDownIndex
```
public int pageDownIndex
```
  - pgupId
```
public String pgupId
```
    Page up ID.
  - pageUpIndex
```
public int pageUpIndex
```
  - selectString
```
public String selectString
```
    Select string.
  - unselectString
```
public String unselectString
```
    Unselect string.
  - lineBetwRows
```
public int lineBetwRows
```
    Line between rows.
  - divBetwHeaders
```
public int divBetwHeaders
```
    Divider between headers.
  - divBetwHeadCol
```
public int divBetwHeadCol
```
    Divider between header and column.
  - headColor
```
public int headColor
```
    Header color.
  - headFont
```
public int headFont
```
    Header font.
  - headCY
```
public int headCY
```
    Header height.
  - noBorder
```
public int noBorder
```
    No border.
  - noVertSbar
```
public int noVertSbar
```
    No vertical scrollbar.
  - colSbar
```
public int colSbar
```
    Column scrollbar flag. Can have one of the following two values:
```
    0 = no scrollbar on the columns
    1 = scrollbar on the columns
 
```
  - listFlags
```
public int listFlags
```
    List flags.
  - noSelection
```
public int noSelection
```
    No selection allowed flag. Can have on of the following two values:
```
    0 = selection allowed
    1 = no selection allowed
 
```
  - vertSize
```
public int vertSize
```
    Vertical scrollbar as heigh as list.
  - pageButtons
```
public int pageButtons
```
    Page buttons flag. Can have on of the following two values:
```
    0 = no page-up/page-down buttons
    1 = has page-up/page-down buttons
 
```
  - pgupSendKey
```
public int pgupSendKey
```
    Send key for page up.
  - pgdnSendKey
```
public int pgdnSendKey
```
    Send key for page down.
  - topbotList
```
public int topbotList
```
    Top bottom.
  - expand
```
public int expand
```
    Expandable list.
  - moveCursor
```
public int moveCursor
```
    Move cursor.
  - headerBgColor
```
public int headerBgColor
```
    The header background color.
  - listBgColor
```
public int listBgColor
```
    The background color.
  - listxFlags
```
public int listxFlags
```
    ListBox flags.
  - colFlags
```
public int colFlags
```
    Common flags for all columns.
  - colContr
```
public PhantomCListBox.PhantomCListBoxColumn[] colContr
```
    The columnControllers.
  - selectionHostField
```
public PhantomHostField selectionHostField
```
    The PhantomHostField, may be null if no selection host field exist or if the panel is not connected to a host screen.
  - topBottomHostField
```
public PhantomHostField topBottomHostField
```
    The PhantomHostField, may be null if not a top-bottom list or if the panel is not connected to a host screen.
- Constructor Detail
  - PhantomCListBox
```
public PhantomCListBox(PhantomFile data,
                       PhantomPanelData panelData,
                       int index,
                       PhantomControlBase controlBase)
                throws IOException
```
    Creates an instance of the control class. Loads the data from a Phantom Panel file that has previously been read into memory.
```
 Base:
  + horSbar             BYTE
  + multisel            BYTE
  + colcount            SHORT
  + id                  BYTE[9]
  + object              BYTE[9]
  + reserved            BYTE
  + fieldName           BYTE[9]
  + reserved            BYTE[4]
  + width               SHORT
  + font                SHORT
  + emptyLineEnds       BYTE
  + color               BYTE
  + selImplied          BYTE
  + divBetwCols         BYTE
  + dblClickId          BYTE[9]
  + pgdnId              BYTE[9]
  + pgupId              BYTE[9]
  + selectString        BYTE[11]
  + unselectString      BYTE[11]
  + lineBetwRows        BYTE
  + divBetwHeaders      BYTE
  + divBetwHeadCol      BYTE
  + headColor           BYTE
  + headFont            SHORT
  + headCY              SHORT
  + noBorders           BYTE
  + noVertSbar          BYTE
  + colSbar             BYTE
  + listFlags           BYTE
  + noSelection         BYTE
  + vertSize            BYTE
  + pageButtons         BYTE
  + pgupSendKey         SHORT
  + pgdnSendKey         SHORT
  + topbotList          BYTE
  + Skip topSkip        BYTE
  + expand              BYTE
  + moveCursor          BYTE
  + headerBgColor       BYTE
  + listBgColor         BYTE
  + reserved            BYTE[36]
  + Skip prevSelY       SHORT
  + reserved            USHORT
  + seglen              SHORT
 
```
    Throws:
    IOException - if an I/O error occurs.
  - PhantomCListBox
```
public PhantomCListBox(PhantomFile data)
                throws IOException
```
    Constructor for Designer control.
    Throws:
    IOException - For I/O errors.
  - PhantomCListBox
```
public PhantomCListBox(PhantomPanelData panelData,
                       PhantomControlBase bc,
                       int headCy,
                       int[] lineValues,
                       GofListColumnElement[] gofListColumnElements)
                throws IOException
```
    Creates a control class for a listbox on Gui-on-the-Fly panel.
    Parameters:
    panelData - The Phantom panel data.
    bc - The listbox's base data.
    headCy - The height of the column headers.
    lineValues - An array of flags for the line between columns, headers etc settings.
    gofListColumnElements - An array of listbox elements used for creating the inner control objects for the columns.
    Throws:
    IOException
- Method Detail
  - equalsControl
```
protected boolean equalsControl(PhantomControl c)
```
    Checks for control equality. The base is already checked and the Control ID, potential fore- and background color and color conversion flags. The tooltip text is not checked.
    Specified by:
    equalsControl in class PhantomControl
  - rebind
```
public void rebind()
```
    Re-bind the panel data.
    Overrides:
    rebind in class PhantomControl
  - save
```
public void save(PhantomOutputFile file)
          throws IOException
```
    Saves the instance of the control to file.
```
 Base:
  + horSbar             BYTE
  + multisel            BYTE
  + colcount            SHORT
  + id                  BYTE[9]
  + object              BYTE[9]
  + reserved            BYTE
  + fieldName           BYTE[9]
  + reserved            BYTE[4]
  + width               SHORT
  + font                SHORT
  + emptyLineEnds       BYTE
  + color               BYTE
  + selImplied          BYTE
  + divBetwCols         BYTE
  + dblClickId          BYTE[9]
  + pgdnId              BYTE[9]
  + pgupId              BYTE[9]
  + selectString        BYTE[11]
  + unselectString      BYTE[11]
  + lineBetwRows        BYTE
  + divBetwHeaders      BYTE
  + divBetwHeadCol      BYTE
  + headColor           BYTE
  + headFont            SHORT
  + headCY              SHORT
  + noBorders           BYTE
  + noVertSbar          BYTE
  + colSbar             BYTE
  + listFlags           BYTE
  + noSelection         BYTE
  + vertSize            BYTE
  + pageButtons         BYTE
  + pgupSendKey         SHORT
  + pgdnSendKey         SHORT
  + topbotList          BYTE
  + Skip topSkip        BYTE
  + expand              BYTE
  + moveCursor          BYTE
  + headerBgColor       BYTE
  + listBgColor         BYTE
  + reserved            BYTE[36]
  + Skip prevSelY       SHORT
  + reserved            USHORT
  + seglen              SHORT
 
```
    Specified by:
    save in class PhantomControl
    Parameters:
    file -
    Throws:
    IOException - if an I/O error occurs.
  - getDataSize
```
public int getDataSize(PhantomOutputFile outputFile)
```
    Get the size when saved to file.
    Specified by:
    getDataSize in class PhantomControl
  - updateReferences
```
public void updateReferences(ApplicationReferences refs)
```
    Updates the Applications References instance.
    Specified by:
    updateReferences in class PhantomControl
  - addNPObjects
```
protected void addNPObjects(ENPObject obj)
```
    Gets the NPObject for the control.
    Specified by:
    addNPObjects in class PhantomControl
  - getControlObjectID
```
public String getControlObjectID()
```
    Needs override by the control if the object instance if not resolved in this class instance.
    Overrides:
    getControlObjectID in class PhantomControl
    Returns:
    the Object ID connected to this control, null or empty string for none.
  - updateGuiOnTheFlyValue
```
public void updateGuiOnTheFlyValue(CRC32 crc32)
```
    Updates the CRC32 value of a Gui-on-the-fly value with the control's base data.
    All controls that implements a Gui-on-the-fly constructor must always override this method and start by calling super.updateGuiOnTheFlyCRC32(crc32) before adding control specific data.
    Overrides:
    updateGuiOnTheFlyValue in class PhantomControl
  - resolveComponentReferences
```
public void resolveComponentReferences()
```
    Resolves double click reference of this control to other panel component, after the panel has been loaded.
    Overrides:
    resolveComponentReferences in class PhantomControl
  - isActionConnectedEnabled
```
public boolean isActionConnectedEnabled()
```
    Checks if a control is action connected to another.
    Overrides:
    isActionConnectedEnabled in class PhantomControl
  - doEndListAtProtSel
```
public boolean doEndListAtProtSel()
```
    Checks if the list ends at first protected selection line.
  - reloadObject
```
public void reloadObject()
                  throws IOException
```
    Reload object reference.
    Specified by:
    reloadObject in class PhantomControl
    Throws:
    IOException

Class PhantomCListBox

Nested Class Summary

Field Summary

Fields inherited from class se.entra.phantom.server.PhantomControl

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

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

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

Constructor Summary

Method Summary

Methods inherited from class se.entra.phantom.server.PhantomControl

Methods inherited from class java.lang.Object

Field Detail

COLMOVEABLE

COLSORTABLE

ENDPROTSEL

EXPANDRIGHT

PAGEUPDOWN

NEXTLINE

RTOL

LISTCOL_FOREGROUND

LISTCOL_BACKGROUND

LISTCOL_XLATE

LISTCOL_ALWUPD

LISTCOL_AUTOTAB

LISTCOL_KEYPAD

LISTCOL_CURFIRST

LISTCOL_NOTSELFIELD

LISTCOLNF_RTL

LISTCOLNF_HINDI

FLAGS_NOSEL

FLAGS_MULSEL

FLAGS_VERTSBAR

FLAGS_HORZSBAR

FLAGS_COLSBAR

FLAGS_LINEBROWS

FLAGS_PAGEUD

FLAGS_LISTHEIGHT

FLAGS_RTOL

FLAGS_BORDER

FLAGS_HEADDIV_SINGLE

FLAGS_HEADDIV_DOUBLE

FLAGS_HCDIV_SINGLE

FLAGS_HCDIV_DOUBLE

FLAGS_COLDIV_SINGLE

FLAGS_COLDIV_DOUBLE

CFLAGS_COLMOVEABLE

CFLAGS_COLSORTABLE

CFLAGS_EXPANDRIGHT

CFLAGS_PAGEUPDOWN

CFLAGS_NEXTLINE

CFLAGS_XPAND

CFLAGS_SELREQ

COLFLAGS_HEADLEFTJUST

COLFLAGS_HEADRIGHTJUST

COLFLAGS_HEADCENTJUST

COLFLAGS_COLLEFTJUST

COLFLAGS_COLRIGHTJUST

COLFLAGS_COLCENTJUST

COLFLAGS_EDITABLE

COLFLAGS_CURSBEG

COLFLAGS_SELENT

COLFLAGS_AUTOTAB

COLFLAGS_ACTKEYPAD

COLFLAGS_RTOL

COLFLAGS_HINDINUM

horSbar

multisel

colCount

objectName

fieldName

font

emptyLineEnds

color

selImplied

divBetwCols

doubleClickID

doubleClickIndex

pgdnId

pageDownIndex

pgupId