se.entra.phantom.client

Class CListBox

java.lang.Object

se.entra.phantom.client.PControl

se.entra.phantom.client.CListBox

All Implemented Interfaces:

ContainerListener, MouseListener, MouseMotionListener, EventListener, DocumentListener, FieldCheck, UserEventListener, NetPhantomConstants

public class CListBox
extends PControl
implements FieldCheck

A listbox controller.

Author:

J. Bergström

Field Summary

Fields inherited from class se.entra.phantom.client.PControl

bounds, panel, TYPE_BUTTON, TYPE_CHECK, TYPE_COMBO, TYPE_FRAME, TYPE_GRAPH, TYPE_GROUP, TYPE_INOUT, TYPE_LIST, TYPE_MLE, TYPE_NOTE, TYPE_OUT, TYPE_RADIO, TYPE_RECT, TYPE_SPIN, TYPE_SUB, TYPE_TEXT, TYPE_TREE, TYPE_UNKNOWN, TYPE_USER

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
CListBox()

Method Summary

Modifier and Type	Method and Description
void	create(FontManager fontManager, PPanel panel, int type, Container container, Transaction trans, int index, Font panelFont, Color headBG, Color bodyBG, double scaleScrollBar) Creation for Editor.
void	create(PPanel panel, int type, Container container, Transaction trans, int index) Fires the create transaction.
Font	getHeaderFont() Gets the header font.
PJListBox	getListBox() Gets the listbox component.
String	getText(Rectangle area) Gets the text for the clipboard operation when performing a rectangle marking in the panel.
boolean	isDeFocusAllowed(KeyEvent event, PControl focusTarget) Checks if the listbox should loose focus after a TAB or Shift-TAB has been pressed.
void	notifyUserEvent(int event) Notification of a user event.
protected void	showPopupMenu(se.entra.phantom.client.PCPopupMenu popupMenu, Component component, int x, int y, int index, int column) Shows the pop-up menu.

Methods inherited from class se.entra.phantom.client.PControl

changedUpdate, componentAdded, componentRemoved, getBackgroundIndex, getComponent, getContainer, getControlID, getFont, getForegroundIndex, getIndex, getPhantomApplet, getPopupMenu, getPPanel, getSessionManager, getStandardBackground, getStandardForeground, getTooltipText, getType, insertUpdate, isEnabled, isUserChanged, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, removeUpdate, setEnabled, setMarkingAllowed, setTabHandled, setUserChanged, setUserChangeLightEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

CListBox

public CListBox()

Method Detail

create

public void create(PPanel panel,
                   int type,
                   Container container,
                   Transaction trans,
                   int index)

Fires the create transaction.

Parameters:

panel -

type - The type of Phantom control.

container -

trans - The create transaction from the server.

index - The index of this component.

The listbox controller reads out the following data from the create transaction:

  -  STRING   the listbox index
  -  SHORT    the double click id
  -  SHORT    page up id
  -  SHORT    page down id
  -  BYTE     the number of columns
  -  SHORT    the headers height in dialog units
  -  BYTE     the headers background color index
  -  BYTE     the lists background color
  -  USHORT   the lists font
  -  USHORT   the headers font
  -  USHORT   listbox flags
  -  BYTE     common flags for all columns
  -  USHORT   the number of lines in the listbox
 

create

public void create(FontManager fontManager,
                   PPanel panel,
                   int type,
                   Container container,
                   Transaction trans,
                   int index,
                   Font panelFont,
                   Color headBG,
                   Color bodyBG,
                   double scaleScrollBar)

Creation for Editor.

getHeaderFont

public Font getHeaderFont()

Gets the header font.

getListBox

public PJListBox getListBox()

Gets the listbox component.

getText

public String getText(Rectangle area)

Gets the text for the clipboard operation when performing a rectangle marking in the panel. Tab and CR/LF are allowed, e.g. for a listbox.

Overrides:

getText in class PControl

Returns:

null if not available.

showPopupMenu

protected void showPopupMenu(se.entra.phantom.client.PCPopupMenu popupMenu,
                             Component component,
                             int x,
                             int y,
                             int index,
                             int column)

Shows the pop-up menu. Overridden here to set the current column index rather than -1 as for normal controls.

Overrides:

showPopupMenu in class PControl

notifyUserEvent

public void notifyUserEvent(int event)

Notification of a user event. Overrides PControl method.

Specified by:

notifyUserEvent in interface UserEventListener

Overrides:

notifyUserEvent in class PControl

isDeFocusAllowed

public boolean isDeFocusAllowed(KeyEvent event,
                                PControl focusTarget)

Checks if the listbox should loose focus after a TAB or Shift-TAB has been pressed. The controller will pass on the question to PJListBox if the listbox is editable, else it will allow defocus.

Specified by:

isDeFocusAllowed in interface FieldCheck

Parameters:

event - The key event causing the focus change. This parameter may be null if no special key event caused the focus change.

focusTarget - The target focus control.

Returns:

true if the listbox should loose focus, false otherwise.