se.entra.phantom.server

Class VirtualCListCapableControl

java.lang.Object

se.entra.phantom.server.VirtualControl

se.entra.phantom.server.VirtualCListCapableControl

All Implemented Interfaces:

NetPhantomConstants, PhantomControlType, VirtualChangeEvent, VirtualClientMessages, VirtualInterface, VirtualTooltipInterface

Direct Known Subclasses:

VirtualCComboBox, VirtualCSpinButton

public abstract class VirtualCListCapableControl
extends VirtualControl

List capable controls, the combobox and spin button.

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
protected se.entra.phantom.server.VirtualCachedListItem	cacheItem Member initiated to the cached file.
protected IListCapableControl	data The control data.
protected VirtualHostField	hostField The virtual host field.
protected boolean	isListChanged Flag for list contents changed.
protected Vector<String>	listConversion The list of host conversion contents - the host converted data, could be null.
protected Vector<String>	listData The combobox's list current contents - the visible data.
protected int	selectLine The selected line.
protected VirtualTextData	textData The virtual text data, contains the client converted data.

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

Modifier	Constructor and Description
protected	VirtualCListCapableControl(VirtualPanel panel, IListCapableControl data) Constructor.

Method Summary

Modifier and Type	Method and Description
void	clientUpdated(String updateString) This method is called from the VirtualPanel to cause a client transaction to update the panels.
void	clientUpdated(Transaction trans) This method is called from the VirtualPanel to cause a client transaction to update the panels.
String	convertFromHost(String hostData, boolean setLine) Convert host text to combobox text.
String	convertToHost(String clientData, boolean setLine) Convert combobox text to host text.
boolean	deleteAll() Deletes the whole ComboBox.
boolean	deleteLine(int line) Deletes a single line in the ComboBox.
void	fireCreate(Transaction trans) This method fires the creation data transaction to the client.
protected abstract void	fireCreateComponent(Transaction trans) Fire create for the component.
void	fireUpdate(Transaction trans) Fires the update data transaction to the client.
VirtualControl	getControlConnectedToHost(PhantomHostScreen screen, PhantomHostField hostField, int flags) Check if control is connected to host field.
String	getHostStringFromIndex(int line, boolean setLine, boolean setChanged) Get host string from index in combobox.
int	getLength() Gets the maximum editable length.
String	getLine(int line) Gets the data from an existing line in the listbox.
int	getLineCount() Gets the number of lines in the listbox.
int	getNextSelection(int line) Gets the next selected line, starting from a specified line.
VirtualControl	getSelectableControl(int flags) Check if this control can receive focus (is selectable).
void	hostScreenChanged(PhantomHostScreen screen) The connected host screen has changed.
boolean	insertLine(String text, int line) Inserts a line in a combobox.
boolean	isDirectChecked() Is characters direct checked.
void	issueAction(Transaction trans) 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).
void	refresh() This method is used to refresh the contents of the virtual classes.
int	searchListData(String text) Search list data for text from the top of the list.
boolean	setFileFromList(PhantomOutputFile pFile) Insert the contents of a list into a file.
boolean	setFocus() Sets the focus to this control.
boolean	setLine(String text, int line) Sets the data in a existing line in the listbox.
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	setText(String text) Sets the text of an item.

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

appendCreateTransaction, appendFieldCheckTransaction, appendFontTransaction, appendUpdateTransaction, areTextPromptsAlwaysRefreshed, callControl, callObject, callObject, dispose, getBackgroundColor, getBasicData, getCell, getClientSession, getColor, getComponentLockObject, getControlID, getControlIDHostFieldID, getControlType, getCurrentHostSession, getExtraUpdateFlags, getFont, getForegroundColor, getHostField, getID, getIndex, getObject, getPanel, getPreviousConnectedControl, getProperty, getText, getTextData, getTooltipText, getVirtualSessionManager, hasChanged, isChecked, isConnectToNextControlPropertySet, isEnabled, isNewGroup, issueControlAction, isTabSkipped, isVisible, parseRuntimeFont, refreshTextPrompts, refreshTextPrompts, requestFocus, selectField, setBackgroundColor, setCell, setChanged, setChecked, setColor, setEnabled, setFocus, setFont, setForegroundColor, setLength, setProperty, setTooltipText, setupControlIDObject, setVirtualText, setVisible, textFileChanged

Methods inherited from class java.lang.Object

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

Field Detail

data

protected final IListCapableControl data

The control data.

textData

protected final VirtualTextData textData

The virtual text data, contains the client converted data.

hostField

protected VirtualHostField hostField

The virtual host field.

listData

protected Vector<String> listData

The combobox's list current contents - the visible data.

listConversion

protected Vector<String> listConversion

The list of host conversion contents - the host converted data, could be null.

selectLine

protected int selectLine

The selected line. Is defaulted to -1, which means that selection should be set by means of the host fields data.

isListChanged

protected boolean isListChanged

Flag for list contents changed. This means that the whole list content is sent to the client.

cacheItem

protected se.entra.phantom.server.VirtualCachedListItem cacheItem

Member initiated to the cached file. If null, no caching is present.

Constructor Detail

VirtualCListCapableControl

protected VirtualCListCapableControl(VirtualPanel panel,
                                     IListCapableControl data)

Constructor.

Method Detail

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

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

fireCreate

public final void fireCreate(Transaction trans)

This method fires the creation data transaction to the client.

Specified by:

fireCreate in interface VirtualClientMessages

Overrides:

fireCreate in class VirtualControl

fireCreateComponent

protected abstract void fireCreateComponent(Transaction trans)

Fire create for the component.

getLength

public int getLength()

Gets the maximum editable length.

Specified by:

getLength in interface VirtualInterface

Overrides:

getLength in class VirtualControl

Returns:

-1 for error (getLength not implemented for control)
0-nn control length.

fireUpdate

public final void fireUpdate(Transaction trans)

Fires the update data transaction to the client. The following data is appended:

  + USHORT   size
  + STRING   list items (as many items as is defined in size)
  + SHORT    selected line (-1 if set by host field)
 

Specified by:

fireUpdate in interface VirtualClientMessages

Overrides:

fireUpdate in class VirtualControl

clientUpdated

public void clientUpdated(Transaction trans)

This method is called from the VirtualPanel to cause a client transaction to update the panels.

The only thing required to update is changes in the list and the selection. The entry field is updated by VirtualControl because it is registered.

Specified by:

clientUpdated in class VirtualControl

Parameters:

trans - A transaction that is already being processed.

clientUpdated

public void clientUpdated(String updateString)

This method is called from the VirtualPanel to cause a client transaction to update the panels.

The only thing required to update is changes in the list and the selection. The entry field is updated by VirtualControl because it is registered.

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

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 is overwritten from VirtualControl.

Overrides:

getSelectableControl in class VirtualControl

Returns:

VirtualControl if selectable, otherwise null.

setFocus

public boolean setFocus()

Sets the focus to this control.

Specified by:

setFocus in interface VirtualInterface

Overrides:

setFocus in class VirtualControl

Returns:

false for failure.

deleteAll

public boolean deleteAll()

Deletes the whole ComboBox.

Specified by:

deleteAll in interface VirtualInterface

Overrides:

deleteAll in class VirtualControl

Returns:

Boolean true if successful.
Boolean false if not.

deleteLine

public boolean deleteLine(int line)

Deletes a single line in the ComboBox.

Specified by:

deleteLine in interface VirtualInterface

Overrides:

deleteLine in class VirtualControl

Parameters:

line - The line to delete.

Returns:

true if successful,
false if not.

insertLine

public boolean insertLine(String text,
                          int line)

Inserts a line in a combobox.

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:

Boolean true if successful.
Boolean false if 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.

line - The line to update.

Returns:

false for failure.

getLine

public String getLine(int line)

Gets the data from an existing line in the listbox.

Specified by:

getLine in interface VirtualInterface

Overrides:

getLine in class VirtualControl

Parameters:

line - The line to fetch.

Returns:

The line data.

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.

setText

public boolean setText(String text)

Sets the text of an item. This method overrides the VirtualControl setText method, so that setSelection can be synchronized with text.

Specified by:

setText in interface VirtualInterface

Overrides:

setText in class VirtualControl

Returns:

true for successful operation.
false for failure.

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 if successful,
false if not.

getNextSelection

public int getNextSelection(int line)

Gets the next selected line, starting from a specified line.

Specified by:

getNextSelection in interface VirtualInterface

Overrides:

getNextSelection in class VirtualControl

Parameters:

line - The line to start search from.

Returns:

The next selected line, or -1 if no selected line was found.

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.

setFileFromList

public boolean setFileFromList(PhantomOutputFile pFile)

Insert the contents of a list into a file.

Specified by:

setFileFromList in interface VirtualInterface

Overrides:

setFileFromList in class VirtualControl

Parameters:

pFile - The Phantom-file to write to.

Returns:

Boolean true for successful operation.
Boolean false for failure.

issueAction

public void issueAction(Transaction trans)

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.

Specified by:

issueAction in class VirtualControl

Parameters:

trans - A transaction that is already being processed.

convertFromHost

public String convertFromHost(String hostData,
                              boolean setLine)

Convert host text to combobox text.

convertToHost

public String convertToHost(String clientData,
                            boolean setLine)

Convert combobox text to host text.

getHostStringFromIndex

public String getHostStringFromIndex(int line,
                                     boolean setLine,
                                     boolean setChanged)

Get host string from index in combobox.

searchListData

public int searchListData(String text)

Search list data for text from the top of the list.

Returns:

listData index (0-nn) or -1 if text not found.

isDirectChecked

public boolean isDirectChecked()

Is characters direct checked. Overrides the default implementation.

Overrides:

isDirectChecked in class VirtualControl

Returns:

Default implementation returns false.