se.entra.phantom.server

Class VirtualCEntryField

java.lang.Object

se.entra.phantom.server.VirtualControl

se.entra.phantom.server.VirtualCEntryField

All Implemented Interfaces:

NetPhantomConstants, PhantomControlType, VirtualChangeEvent, VirtualClientMessages, VirtualInterface, VirtualTooltipInterface

public class VirtualCEntryField
extends VirtualControl

The entry field is normally connected to a host field to which the color properties optionally are synchronized with. The text content, colors, font, visibility and enabled properties are reflected to the client whenever changed on the server. The client will update the server during an action event in order to synchronize the text with the server. At this point, the host field may also be updated accordingly. No other client property is sent back to the server.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_DYNAMIC_HOST_FIELD Property string for using a dynamic host field position and length.
static String	PROPERTY_DYNAMIC_HOST_FIELD_NOWRAP Property string to set the dynamic host field position and length not to wrap line on the host screen.
static String	PROPERTY_DYNAMIC_WIDTH Property indicating that the size of the entry field is dynamic, i.e.
static String	PROPERTY_HIDE_PROTECTED_EMPTY Property string for hiding the entry field when the host field is protected and empty.
static String	PROPERTY_READONLY Property string read only.

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
VirtualCEntryField(VirtualPanel panel, PhantomCEntryField data) The constructor of the control always calls the superclass.

Method Summary

Modifier and Type	Method and Description
void	clientUpdated(Transaction trans) This method is called from the VirtualPanel to cause a client transaction to update the panels.
void	fireCreate(Transaction trans) This method fires the creation data transaction to the client.
void	fireUpdate(Transaction trans) Everything is handled by VirtualControl.
VirtualControl	getControlConnectedToHost(PhantomHostScreen screen, PhantomHostField hostField, int flags) Check if control is connected to host field.
protected int	getExtraUpdateFlags() Gets the extra flags used for the update transaction.
int	getLength() Gets the maximum editable length.
Object	getProperty(String propertyName) Gets a property of a virtual component.
VirtualControl	getSelectableControl(int flags) Check if this control can receive focus (is selectable).
String	getText() Gets the text of an item.
void	hostScreenChanged(PhantomHostScreen screen) The connected host screen has changed.
boolean	isDirectChecked() Is characters direct checked.
void	issueAction(Transaction trans) This method is invoked by the server kernel when an event has occured 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.
boolean	selectField() Performs a visual selection of the field.
boolean	setBackgroundColor(int colorIndex) This method is overriden so that original color (not disabled color) is saved in this class.
boolean	setEnabled(boolean isEnabled) Call from API.
boolean	setFocus() Sets the focus to this control.
boolean	setForegroundColor(int colorIndex) This method is overriden so that original color (not disabled color) is saved in this class.
boolean	setLength(int newlength) Sets the maximum editable length.
boolean	setProperty(String propertyName, Object property) Sets a property of a virtual component.

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

appendCreateTransaction, appendFieldCheckTransaction, appendFontTransaction, appendUpdateTransaction, areTextPromptsAlwaysRefreshed, callControl, callObject, callObject, deleteAll, deleteLine, dispose, getBackgroundColor, getBasicData, getCell, getClientSession, getColor, getComponentLockObject, getControlID, getControlIDHostFieldID, getControlType, getCurrentHostSession, getFont, getForegroundColor, getHostField, getID, getIndex, getLine, getLineCount, getNextSelection, getObject, getPanel, getPreviousConnectedControl, getTextData, getTooltipText, getVirtualSessionManager, hasChanged, insertLine, isChecked, isConnectToNextControlPropertySet, isEnabled, isNewGroup, issueControlAction, isTabSkipped, isVisible, parseRuntimeFont, refreshTextPrompts, refreshTextPrompts, requestFocus, setCell, setChanged, setChecked, setColor, setFileFromList, setFocus, setFont, setLine, setListFromFile, setSelection, setText, 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

PROPERTY_READONLY

public static final String PROPERTY_READONLY

Property string read only. Entry field should be read only instead of disabled.

See Also:

Constant Field Values

PROPERTY_DYNAMIC_HOST_FIELD

public static final String PROPERTY_DYNAMIC_HOST_FIELD

Property string for using a dynamic host field position and length.

See Also:

Constant Field Values

PROPERTY_DYNAMIC_HOST_FIELD_NOWRAP

public static final String PROPERTY_DYNAMIC_HOST_FIELD_NOWRAP

Property string to set the dynamic host field position and length not to wrap line on the host screen.

This property is used in conjuction with the property PROPERTY_DYNAMIC_HOST_FIELD and typically with protected host fields.

See Also:

Constant Field Values

PROPERTY_HIDE_PROTECTED_EMPTY

public static final String PROPERTY_HIDE_PROTECTED_EMPTY

Property string for hiding the entry field when the host field is protected and empty. When this condition is not met, the entry field is made visible again.

See Also:

Constant Field Values

PROPERTY_DYNAMIC_WIDTH

public static final String PROPERTY_DYNAMIC_WIDTH

Property indicating that the size of the entry field is dynamic, i.e. adjusts itself pixel-wise in width depending on the maximum input length times the maximum character width.

See Also:

Constant Field Values

Constructor Detail

VirtualCEntryField

public VirtualCEntryField(VirtualPanel panel,
                          PhantomCEntryField data)

The constructor of the control always calls the superclass.

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

selectField

public boolean selectField()

Performs a visual selection of the field. It is mainly used for entry capable controls.

Specified by:

selectField in interface VirtualInterface

Overrides:

selectField in class VirtualControl

Returns:

true for success.

setForegroundColor

public boolean setForegroundColor(int colorIndex)

This method is overriden so that original color (not disabled color) is saved in this class.

Specified by:

setForegroundColor in interface VirtualInterface

Overrides:

setForegroundColor in class VirtualControl

Returns:

true for successful operation.
false for failure.

setBackgroundColor

public boolean setBackgroundColor(int colorIndex)

This method is overriden so that original color (not disabled color) is saved in this class.

Specified by:

setBackgroundColor in interface VirtualInterface

Overrides:

setBackgroundColor in class VirtualControl

Returns:

true for successful operation.
false for failure.

setEnabled

public boolean setEnabled(boolean isEnabled)

Call from API. If disable, stay disable after host update.

Specified by:

setEnabled in interface VirtualInterface

Overrides:

setEnabled in class VirtualControl

Returns:

true for successful operation.

fireCreate

public void fireCreate(Transaction trans)

This method fires the creation data transaction to the client. The first thing must be to call the appendCreateTransaction. This will append the base data followed by the text prompt as a string. The following is then appended:

  + USHORT  length
  + BYTE    flags (bit 0:isRight, 1:border, 2:password, 3:notEmpty, 4:autoTab)
 

Specified by:

fireCreate in interface VirtualClientMessages

Overrides:

fireCreate in class VirtualControl

fireUpdate

public void fireUpdate(Transaction trans)

Everything is handled by VirtualControl.

Specified by:

fireUpdate in interface VirtualClientMessages

Overrides:

fireUpdate in class VirtualControl

getExtraUpdateFlags

protected int getExtraUpdateFlags()

Gets the extra flags used for the update transaction. These flags can be between 0x02 and 0x1F where bit 0 must be zero. This method must be overridden in order to return non-zero (the default).

Overrides:

getExtraUpdateFlags 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 entry field updates the text and also the host field if such a connection exists.

Specified by:

clientUpdated in class VirtualControl

Parameters:

trans - A transaction that is already being processed.

getText

public String getText()

Gets the text of an item.

Specified by:

getText in interface VirtualInterface

Overrides:

getText in class VirtualControl

Returns:

null for no text support.

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:

true if connected, othervise 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:

this if selectable, othervise 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.

issueAction

public void issueAction(Transaction trans)

This method is invoked by the server kernel when an event has occured 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.

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.

setLength

public boolean setLength(int newlength)

Sets the maximum editable length.

Specified by:

setLength in interface VirtualInterface

Overrides:

setLength in class VirtualControl

Returns:

true for successful operation.
false for failure.

isDirectChecked

public boolean isDirectChecked()

Is characters direct checked. Overrides the default implementation.

Overrides:

isDirectChecked in class VirtualControl

Returns:

Default implementation returns false.

setProperty

public boolean setProperty(String propertyName,
                           Object property)

Sets a property of a virtual component.

Specified by:

setProperty in interface VirtualInterface

Overrides:

setProperty in class VirtualControl

Returns:

true for successful operation.
false for failure.

getProperty

public Object getProperty(String propertyName)

Gets a property of a virtual component.

Specified by:

getProperty in interface VirtualInterface

Overrides:

getProperty in class VirtualControl

Returns:

Object The object containing the property.
null for failure.