se.entra.phantom.server

Class VirtualTextPrompt

java.lang.Object

se.entra.phantom.server.VirtualTextData

se.entra.phantom.server.VirtualTextPrompt

All Implemented Interfaces:

NetPhantomConstants

public class VirtualTextPrompt
extends VirtualTextData
implements NetPhantomConstants

Handles text prompt data for multiple purposes using transactions and changes. Typically a static text control (the virtual one) uses this class. The class is extended from VirtualTextData that provides the text support.

A text prompt can contain the following escape characters:

  + @HOSTFIELD@   Reference to a host field ID.
  + @*TEXTID@     Reference to a text file ID.
  + @**MW@        Message Waiting, 5250 only. 1 if MW flag is on in the OIA, otherwise 0.
  + @**PANELID@   The ID of the panel where this control is used.
  + @**SCRID@     The ID of the current screen.
  + @**RTCRT@     Timestamp of the runtime file (.PHR).
  + @**PROGVER@   Phantom program version string.
  + @**DATE@      Current date in long format.
  + @**TIME@      Current time in long format.
  + @**APPDIR@    Application directory.
  + @**APPNAME@   Application name (.PHR or .PHA file without extension).
  + @**PROGDIR@   The program directory.
  + @**PROGNAME@  The exe file name (without extension).
 

Field Summary

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
VirtualTextPrompt(String textPrompt) The constructor saves the text prompt string and the reference to the virtual panel.
VirtualTextPrompt(VirtualPanel panel, String textPrompt) The constructor saves the text prompt string and the reference to the virtual panel.

Method Summary

Modifier and Type	Method and Description
static String	eclipseFormatTextPrompt(PhantomRuntime runtime, PhantomPanelData panel, ENPObject obj, String text) This static method formats a text prompt in a StringBuilder for the Editor, typically used for the title text of a panel, displayed in Eclipse Navigator.
boolean	format() Formats this string and possibly changes the text contents.
boolean	format(PhantomWorker worker, VirtualRuntime runtime) Formats this string and possibly changes the text contents.
static boolean	formatTextPrompt(PhantomWorker worker, PhantomRuntime runtime, VirtualPanel panel, String text, StringBuffer buf) This static method formats a text prompt in a StringBuilder.
static boolean	formatTextPrompt(PhantomWorker worker, PhantomRuntime runtime, VirtualPanel panel, String text, StringBuilder buf) This static method formats a text prompt in a StringBuilder.
static boolean	formatTextPrompt(VirtualPanel vp, String text, StringBuffer buf) This static method formats a text prompt in a StringBuilder.
static boolean	formatTextPrompt(VirtualPanel vp, String text, StringBuilder buf) This static method formats a text prompt in a StringBuilder.
static String	getSpecialVariable(PhantomWorker worker, PhantomRuntime runtime, VirtualPanel panel, String var) Gets a special variable.
static String	getSpecialVariable(PhantomWorker worker, PhantomRuntime runtime, VirtualPanel panel, String var, boolean isEclipse) Gets a special variable.
boolean	setText(String t) Sets the text of an item.
static boolean	updateReferences(ApplicationReferences refs, Object container, Object owner, String text, String location) Updates the references for a text prompt.
static boolean	updateReferences(ApplicationReferences refs, Object owner, String text, String location) Updates the references for a text prompt.

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

appendTransaction, appendUpdateTransaction, getLength, getText, getTextResetChange, hasChanged, resetChange, setChanged, setText

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualTextPrompt

public VirtualTextPrompt(String textPrompt)

The constructor saves the text prompt string and the reference to the virtual panel. The "format" method is then used to format the text itself.

VirtualTextPrompt

public VirtualTextPrompt(VirtualPanel panel,
                         String textPrompt)

The constructor saves the text prompt string and the reference to the virtual panel. The "format" method is then used to format the text itself.

Method Detail

setText

public boolean setText(String t)

Sets the text of an item. The change flag is affected depending of the new content.

Overrides:

setText in class VirtualTextData

Returns:

true if the text changed with this call, false otherwise.

format

public boolean format()

Formats this string and possibly changes the text contents. The method keeps track for external references and if none exist, only the first time an internal representation of the text prompt is created.

Returns:

true if the text changed with this call, false otherwise.

format

public boolean format(PhantomWorker worker,
                      VirtualRuntime runtime)

Formats this string and possibly changes the text contents. The method keeps track for external references and if none exist, only the first time an internal representation of the text prompt is created.

Use this method when the panel parameter in the constructor is not specified (or null).

Returns:

true if the text changed with this call, false otherwise.

formatTextPrompt

public static boolean formatTextPrompt(VirtualPanel vp,
                                       String text,
                                       StringBuffer buf)

This static method formats a text prompt in a StringBuilder. The input variable "buf" is modified to contain the text. If there are no external references, the buffer will have the same contents as the variable "text". The VirtualPanel parameter may be null.

Returns:

true if there are external references in the text prompt, such as global variables, host fields or text IDs.

formatTextPrompt

public static boolean formatTextPrompt(VirtualPanel vp,
                                       String text,
                                       StringBuilder buf)

This static method formats a text prompt in a StringBuilder. The input variable "buf" is modified to contain the text. If there are no external references, the buffer will have the same contents as the variable "text". The VirtualPanel parameter may be null.

Returns:

true if there are external references in the text prompt, such as global variables, host fields or text IDs.

formatTextPrompt

public static boolean formatTextPrompt(PhantomWorker worker,
                                       PhantomRuntime runtime,
                                       VirtualPanel panel,
                                       String text,
                                       StringBuffer buf)

This static method formats a text prompt in a StringBuilder. The input variable "buf" is modified to contain the text. If there are no external references, the buffer will have the same contents as the variable "text". The VirtualPanel parameter may be null.

Returns:

true if there are external references in the text prompt, such as global variables, host fields or text IDs.

formatTextPrompt

public static boolean formatTextPrompt(PhantomWorker worker,
                                       PhantomRuntime runtime,
                                       VirtualPanel panel,
                                       String text,
                                       StringBuilder buf)

This static method formats a text prompt in a StringBuilder. The input variable "buf" is modified to contain the text. If there are no external references, the buffer will have the same contents as the variable "text". The VirtualPanel parameter may be null.

Returns:

true if there are external references in the text prompt, such as global variables, host fields or text IDs.

eclipseFormatTextPrompt

public static String eclipseFormatTextPrompt(PhantomRuntime runtime,
                                             PhantomPanelData panel,
                                             ENPObject obj,
                                             String text)

This static method formats a text prompt in a StringBuilder for the Editor, typically used for the title text of a panel, displayed in Eclipse Navigator. The input variable "buf" is modified to contain the text. If there are no external references, the buffer will have the same contents as the variable "text". The VirtualPanel parameter may be null.

Returns:

true if there are external references in the text prompt, such as global variables, host fields or text IDs.

getSpecialVariable

public static String getSpecialVariable(PhantomWorker worker,
                                        PhantomRuntime runtime,
                                        VirtualPanel panel,
                                        String var)

Gets a special variable. Special variables are:

 - PANELID (requires VirtualPanel to be non-null)
 - SCRID
 - RTCRT
 - PROGVER
 - PROGVERR
 - DATE
 - TIME
 - APPDIR
 - APPNAME
 - PROGDIR
 - PROGNAME
 - PROGSHORT
 - PROGSERVER
 - PROGCLIENT
 - HOST
 

The parameter panel may be null.

Returns:

null if variable is not found.

getSpecialVariable

public static String getSpecialVariable(PhantomWorker worker,
                                        PhantomRuntime runtime,
                                        VirtualPanel panel,
                                        String var,
                                        boolean isEclipse)

Gets a special variable. Special variables are:

 - PANELID (requires VirtualPanel to be non-null)
 - SCRID
 - RTCRT
 - PROGVER
 - PROGVERR
 - DATE
 - TIME
 - APPDIR
 - APPNAME
 - PROGDIR
 - PROGNAME
 - PROGSHORT
 - PROGSERVER
 - PROGCLIENT
 - HOST
 

The parameter panel may be null.

Returns:

null if variable is not found.

updateReferences

public static boolean updateReferences(ApplicationReferences refs,
                                       Object owner,
                                       String text,
                                       String location)

Updates the references for a text prompt.

Parameters:

refs - The ApplicationReferences instance to update.

owner - The owner.

text - The text prompt.

location - Description of reference location, null for default.

Returns:

true for external references, false for none.

updateReferences

public static boolean updateReferences(ApplicationReferences refs,
                                       Object container,
                                       Object owner,
                                       String text,
                                       String location)

Updates the references for a text prompt.

Parameters:

refs - The ApplicationReferences instance to update.

container - The container to the owner.

owner - The owner.

text - The text prompt.

location - Description of reference location, null for default.

Returns:

true for external references, false for none.