se.entra.phantom.server

Class PhantomObject

java.lang.Object

se.entra.phantom.server.PhantomObject

All Implemented Interfaces:

Cloneable, Comparable<PhantomObject>, NetPhantomConstants, ObjectMessages

public class PhantomObject
extends Object
implements ObjectMessages, NetPhantomConstants, Comparable<PhantomObject>, Cloneable

This class contains the Phantom Object definitions. It loads its definitions from a ".PHA" file inside the runtime file.

Field Summary

Fields

Modifier and Type	Field and Description
String	description The description.
String	fileName File name for object code.
int	filter Object calling filter.
int	flags Object flags (OBJFLAG_*).
String	name Name of the object.
static int	OBJ_DLL Deprecated. See Object types.
static int	OBJ_JAVA Deprecated. See Object types.
static int	OBJ_MACRO Deprecated. See Object types.
static int	OBJ_POPUPMENU Deprecated. See Object types.
static int	OBJ_REXXAPPLICATION Deprecated. See Object types.
static int	OBJ_REXXCMD Deprecated. See Object types.
static int	OBJ_REXXMACRO Deprecated. See Object types.
static int	OBJFLAG_ASYNC Async execution.
static int	OBJFLAG_ENTER_LOCK Flag to lock panels and host at enter of object call.
static int	OBJFLAG_EXIT_UNLOCK Flag to unlock panels and host at exit of object call.
String	procedure Deprecated. This entry is only valid for NetPhantom applications below version 4.
int	type Deprecated. Object type is no longer used.

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

OBJACT_CHAR, OBJACT_CHECK, OBJACT_CLICK, OBJACT_CLOSE, OBJACT_COMMAND, OBJACT_CREATE, OBJACT_DBLCLICK, OBJACT_DDECONNECTION, OBJACT_DDEDATA, OBJACT_DDEERROR, OBJACT_DDEEXECUTE, OBJACT_DDEPOKE, OBJACT_DDEREQUEST, OBJACT_DDEVALIDATE, OBJACT_DEFOCUS, OBJACT_DESTROY, OBJACT_FOCUS, OBJACT_HIDDEN, OBJACT_HOSTCHANGE, OBJACT_LAST_MESSAGE_HANDLED, OBJACT_QUERYMSG, OBJACT_RECREATE, OBJACT_SELECT, OBJACT_SHOW, OBJACT_START, OBJACT_TRANSLATE, OBJACT_USERCHANGE, PHA_ICO_INFO, PHA_ICO_NOICON, PHA_ICO_QUESTION, PHA_ICO_STOP, PHA_ICO_WARNING, PHA_MSG_CANCEL, PHA_MSG_ENTER, PHA_MSG_ENTERCANCEL, PHA_MSG_OK, PHA_MSG_OKCANCEL, PHA_MSG_RETIGNCANCEL, PHA_MSG_RETRYCANCEL, PHA_MSG_YESNO, PHA_MSG_YESNOCANCEL

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
PhantomObject(PhantomRuntime runtime) Creates a non-initialized object that after initialization can be added to the application.

Method Summary

Modifier and Type	Method and Description
String	callObject(ObjectReply reply, PhantomWorker worker, VirtualInterface vi, String id, int action, String stringArg) Calls the object with the parameters id, action, string.
String	callObject(ObjectReply reply, PhantomWorker worker, VirtualInterface vi, String id, int action, String stringArg, boolean asyncExec) Calls the object with the parameters id, action, string.
String	callObject(PhantomWorker worker, VirtualInterface vi, String id, int action, String stringArg) Calls the object with the parameters id, action, string.
String	callObject(PhantomWorker worker, VirtualInterface vi, String id, int action, String stringArg, boolean asyncExec) Calls the object with the parameters id, action, string.
void	canCompileForNetPhantom5(ArrayList<String> errors, HashMap<String,PhantomObject> rexxClassNames) Checks if the Object can be compiled for NetPhantom 5.
int	compareTo(PhantomObject o) Used for sorting of two PhantomObjects by the name with Arrays.sort.
void	convertPhantomMacroToREXXApplication(String fn) Converts this Object instance from a Phantom Macro to a REXX Application.
ENPObject	createNPObject(boolean isReference) Gets the NPObject for a standard Object, i.e.
static PhantomObject	createREXXApplicationForPhantomMacro(String name) Creates a new Phantom Object instance used to convert a Phantom Macro to REXX Application.
boolean	equals(Object o) Checks if two Objects are equal, it doesn't work with Pop-up menus.
int	getClientEventFlags() Return the events that should make the client to issue an action event transaction to the server.
String	getDescription() Gets the description.
String	getFileName() Gets the file name of the object.
int	getFilter() Gets the filter value.
PhantomMacro	getMacro() Gets the PhantomMacro of this object.
String	getName() Gets the name of this host field.
static long	getNext() Increase counter and return it.
PhantomPopupMenu	getPopupMenu() Gets the pop-up menu of the object.
String	getProcedure() Deprecated. This entry is no longer used and is set to empty string always.
PhantomRuntime	getRuntime() Gets the runtime file where the object or pop-up menu is loaded from.
int	getType() Gets the type of the object.
boolean	isEventUsed(int event) Check if this object uses a special event.
boolean	isJava() Checks if this object is of Java type.
boolean	isJavaOrREXX() Checks if this object is of Java or REXX type, i.e.
boolean	isPhantomMacro() Checks if this is a Phantom Macro that is not yet converted to REXX.
boolean	isPopupMenu() Checks if this object is a pop-up menu.
boolean	isREXX() Checks if this object is of REXX type.
boolean	isVirtualPanelListener() Checks if a Java class uses the VirtualPanelListener-style interface and not ObjectCalling.
void	loadObjectClass(PhantomRuntime runtime) Loads the class files for REXX/DLL objects.
boolean	needsReload() Check if this file needs to be reloaded.
int	reload() Reload internal state from external sources.
void	resolve(ENPObject obj) Resolves this Object into an NPObject reference.
void	save(PhantomOutputFile file) Saves the object definition to file.
String	toString() Converts this object to a string for debug purposes.
boolean	wasPhantomMacro(String macroName) Checks if the object used to be a Phantom Macro, now converted to a REXX macro.

Methods inherited from class java.lang.Object

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

Field Detail

OBJ_REXXCMD

@Deprecated
public static final int OBJ_REXXCMD

Deprecated. See Object types.

REXX Command file.

See Also:

Constant Field Values

OBJ_REXXMACRO

@Deprecated
public static final int OBJ_REXXMACRO

Deprecated. See Object types.

REXX macro.

See Also:

Constant Field Values

OBJ_DLL

@Deprecated
public static final int OBJ_DLL

Deprecated. See Object types.

DLL.

See Also:

Constant Field Values

OBJ_MACRO

@Deprecated
public static final int OBJ_MACRO

Deprecated. See Object types.

Phantom Macro.

See Also:

Constant Field Values

OBJ_REXXAPPLICATION

@Deprecated
public static final int OBJ_REXXAPPLICATION

Deprecated. See Object types.

REXX macro.

See Also:

Constant Field Values

OBJ_POPUPMENU

@Deprecated
public static final int OBJ_POPUPMENU

Deprecated. See Object types.

Pop-up menu.

See Also:

Constant Field Values

OBJ_JAVA

@Deprecated
public static final int OBJ_JAVA

Deprecated. See Object types.

Java code.

See Also:

Constant Field Values

OBJFLAG_ENTER_LOCK

public static final int OBJFLAG_ENTER_LOCK

Flag to lock panels and host at enter of object call.

See Also:

Constant Field Values

OBJFLAG_EXIT_UNLOCK

public static final int OBJFLAG_EXIT_UNLOCK

Flag to unlock panels and host at exit of object call.

See Also:

Constant Field Values

OBJFLAG_ASYNC

public static final int OBJFLAG_ASYNC

Async execution.

See Also:

Constant Field Values

name

public String name

Name of the object.

type

@Deprecated
public int type

Deprecated. Object type is no longer used.

Type of object.

flags

public int flags

Object flags (OBJFLAG_*).

filter

public int filter

Object calling filter.

fileName

public String fileName

File name for object code. For the Java object, this is the class name. For DLL objects, this member is now set to "dll.DLLNAME_ENTRYPOINT".

procedure

@Deprecated
public String procedure

Deprecated. This entry is only valid for NetPhantom applications below version 4.

Procedure/entry point name.

description

public String description

The description.

Constructor Detail

PhantomObject

public PhantomObject(PhantomRuntime runtime)

Creates a non-initialized object that after initialization can be added to the application.

Method Detail

getNext

public static long getNext()

Increase counter and return it.

getRuntime

public PhantomRuntime getRuntime()

Gets the runtime file where the object or pop-up menu is loaded from.

Returns:

null if it's not yet loaded.

save

public void save(PhantomOutputFile file)
          throws IOException

Saves the object definition to file.

 Base:
  + Object name            BYTE [9]
  + Description            BYTE [32]
  + Type of object         BYTE
  + File name              BYTE [13]
  + Procedure name         BYTE [26]
  + Flags                  BYTE
  + Filter                 ULONG
  + Reserved (skipped)     BYTE [16]

 Skip all these members (total 18 bytes):
  + Calling count          USHORT
  + Pointer to file data   ULONG
  + Length of file data    ULONG
  + Pointer to REXX data   ULONG
  + Length of REXX data    ULONG
 

Parameters:

file -

Throws:

IOException - if an I/O error occurs.

getDescription

public String getDescription()

Gets the description.

getFilter

public int getFilter()

Gets the filter value.

loadObjectClass

public void loadObjectClass(PhantomRuntime runtime)
                     throws IOException

Loads the class files for REXX/DLL objects. This is useful when the runtime has been loaded without loading the classes.

Throws:

IOException - if an I/O error occurs.

isVirtualPanelListener

public boolean isVirtualPanelListener()

Checks if a Java class uses the VirtualPanelListener-style interface and not ObjectCalling.

needsReload

public boolean needsReload()

Check if this file needs to be reloaded.

Returns:

boolean

reload

public int reload()
           throws MaybeIOException

Reload internal state from external sources.

Returns:

IReloadable return code.

Throws:

MaybeIOException

getFileName

public final String getFileName()

Gets the file name of the object. Typically, this is done for REXX objects. For the Java object, this is the class name.

getName

public String getName()

Gets the name of this host field.

getMacro

public PhantomMacro getMacro()

Gets the PhantomMacro of this object.

isREXX

public boolean isREXX()

Checks if this object is of REXX type.

isJava

public boolean isJava()

Checks if this object is of Java type.

isJavaOrREXX

public boolean isJavaOrREXX()

Checks if this object is of Java or REXX type, i.e. not a pop-up menu or Phantom Macro.

isPopupMenu

public boolean isPopupMenu()

Checks if this object is a pop-up menu.

isPhantomMacro

public boolean isPhantomMacro()

Checks if this is a Phantom Macro that is not yet converted to REXX.

getType

public int getType()

Gets the type of the object.

getProcedure

@Deprecated
public String getProcedure()

Deprecated. This entry is no longer used and is set to empty string always.

Gets the procedure of the object.

getPopupMenu

public PhantomPopupMenu getPopupMenu()

Gets the pop-up menu of the object.

callObject

public String callObject(PhantomWorker worker,
                         VirtualInterface vi,
                         String id,
                         int action,
                         String stringArg)

Calls the object with the parameters id, action, string.

Returns:

The string returned by the object or null if the object cannot be instantiated. For certain object actions, other default strings are returned when a filter is used. null is also returned for and invalid object action (or message).

callObject

public String callObject(ObjectReply reply,
                         PhantomWorker worker,
                         VirtualInterface vi,
                         String id,
                         int action,
                         String stringArg)

Calls the object with the parameters id, action, string.

Returns:

The string returned by the object or null if the object cannot be instantiated. For certain object actions, other default strings are returned when a filter is used. null is also returned for and invalid object action (or message).

callObject

public String callObject(PhantomWorker worker,
                         VirtualInterface vi,
                         String id,
                         int action,
                         String stringArg,
                         boolean asyncExec)

Calls the object with the parameters id, action, string.

This method should not be used by external classes. It's use is internal for the RemoteApplication in order to avoid asynchronous execution of REXX applications and Phantom Macros.

Returns:

The string returned by the object or null if the object cannot be instantiated. For certain object actions, other default strings are returned when a filter is used. null is also returned for and invalid object action (or message).

callObject

public String callObject(ObjectReply reply,
                         PhantomWorker worker,
                         VirtualInterface vi,
                         String id,
                         int action,
                         String stringArg,
                         boolean asyncExec)

Calls the object with the parameters id, action, string.

This method should not be used by external classes. It's use is internal for the RemoteApplication in order to avoid asynchronous execution of REXX applications and Phantom Macros.

Returns:

The string returned by the object or null if the object cannot be instantiated. For certain object actions, other default strings are returned when a filter is used. null is also returned for and invalid object action (or message).

isEventUsed

public boolean isEventUsed(int event)

Check if this object uses a special event.

getClientEventFlags

public int getClientEventFlags()

Return the events that should make the client to issue an action event transaction to the server.

wasPhantomMacro

public boolean wasPhantomMacro(String macroName)

Checks if the object used to be a Phantom Macro, now converted to a REXX macro.

Returns:

true if it is a REXX macro that has a procedure name like "macroName" (in upper case).

toString

public String toString()

Converts this object to a string for debug purposes.

Overrides:

toString in class Object

compareTo

public int compareTo(PhantomObject o)

Used for sorting of two PhantomObjects by the name with Arrays.sort.

Specified by:

compareTo in interface Comparable<PhantomObject>

createREXXApplicationForPhantomMacro

public static PhantomObject createREXXApplicationForPhantomMacro(String name)

Creates a new Phantom Object instance used to convert a Phantom Macro to REXX Application.

convertPhantomMacroToREXXApplication

public void convertPhantomMacroToREXXApplication(String fn)

Converts this Object instance from a Phantom Macro to a REXX Application.

Parameters:

fn - File name of already converted Phantom Macro REXX Application.

equals

public boolean equals(Object o)

Checks if two Objects are equal, it doesn't work with Pop-up menus.

Overrides:

equals in class Object

createNPObject

public ENPObject createNPObject(boolean isReference)

Gets the NPObject for a standard Object, i.e. Java and REXX, not the other ones.

Returns:

The instance, null if not Java or REXX.

resolve

public void resolve(ENPObject obj)

Resolves this Object into an NPObject reference.

canCompileForNetPhantom5

public void canCompileForNetPhantom5(ArrayList<String> errors,
                                     HashMap<String,PhantomObject> rexxClassNames)

Checks if the Object can be compiled for NetPhantom 5.