PhantomApplicationData (NetPhantom(R) 5.5 Java API documentation)

java.lang.Object
- se.entra.phantom.server.PhantomApplicationData

All Implemented Interfaces:

IReloadable
```
public class PhantomApplicationData
extends Object
implements IReloadable
```
This class loads the Phantom Application file.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PhantomApplicationData.Directory
This class contains the connection between screens and panels.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PhantomApplicationData.Directory` This class contains the connection between screens and panels.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`APPFLAG_ESCNOTF12` Escape not mapped to F12.
`static int`	`APPFLAG_FIELDIDHELP` Host ID, no control ID (help).
`static int`	`APPFLAG_INDSIZE` Individual main panel size.
`static int`	`APPFLAG_INHIBITTRANSFORM` Inhibit transform (font substitution and ratioX/ratioY).
`static int`	`APPFLAG_MAXIMIZE` Maximize main panels.
`static int`	`APPFLAG_MERGEPOPMENU` Merge all pop-up menus.
`static int`	`APPFLAG_MSGDISALL` Both flags for disable system message boxes.
`static int`	`APPFLAG_MSGDISBASE` Disable msg box base.
`static int`	`APPFLAG_MSGDISMAIN` Disable msg box for main.
`static int`	`APPFLAG_MSGDISPOPUP` Disable msg box for popup.
`static int`	`APPFLAG_NEWGROUP` New drawing of group boxes and frames.
`static int`	`APPFLAG_NOMNEMONIC` No mnemonics Check/Radio.
`static int`	`APPFLAG_OUTPUTTEXTFOCUS` Enable focus to all output fields.
`static int`	`APPFLAG_PASSFKEYS` Pass through function keys to the host.
`static int`	`APPFLAG_PHH` Use help ID file.
`static int`	`APPFLAG_PROCESSLOCK` Process panels at lock.
`static int`	`APPFLAG_SYSMENU` Menu in system menu.
`PhantomObject`	`appObject` The application object reference.
`static byte[]`	`defaultColorConvBack`
`static byte[]`	`defaultColorConvFore`
`LoadProgress`	`loadListener` The application object reference.
`Hashtable<String,PhantomObject>`	`objects` The table of Phantom Objects.
`String`	`phaFileName` The file name of the PHA file when not inside a runtime file, should otherwise not be used.
`String`	`textFile` The application text file or null if none.
`String`	`xlateFile` The application translation file or null if none.

Fields inherited from interface se.entra.phantom.server.IReloadable
FAILURE, NOTHING_DONE, SUCCESS

Constructor Summary

Constructors
Constructor and Description

PhantomApplicationData()
Creates a default empty by initiated instance of the application data.

Constructors
Constructor and Description
`PhantomApplicationData()` Creates a default empty by initiated instance of the application data.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addBarFile(String id, PhantomCBar bar)` Adds a new bar file object.
`boolean`	`addHiddenPanel(PhantomApplicationData.Directory dir, String descr, boolean doReplace)` Adds a directory entry (hidden panel).
`boolean`	`addObject(PhantomObject po, boolean doReplace)` Adds an object.
`boolean`	`addPanel(PhantomPanelData panel, PhantomApplicationData.Directory dir, boolean doReplace)` Adds a panel to the application.
`void`	`addPopupMenuControlID(String id, PhantomPopupMenu popupMenu)` Adds a control ID reference to a pop-up menu (if the control ID is not already in the table.
`boolean`	`areHostChangesProcessedDuringLock()` Checks if host changes are processed during session lock.
`boolean`	`areOutputFieldsFocusable()` Checks if the output fields are focusable.
`boolean`	`arePanelsMaximized()` Checks if main panels are maximized when created.
`boolean`	`arePFKeysPassedToHost()` Checks if the functions keys are passed to host.
`void`	`assignHelpIDTable(Hashtable<String,String> table)` Assigns a Help ID table to the application.
`void`	`clean()` Clean the application.
`void`	`copyApplicationData(PhantomApplicationData source)` Copy application data.
`PhantomPanelData`	`copyApplicationPanel(PhantomApplicationData source)` Copy application panel and settings.
`void`	`copyColorConversion(PhantomApplicationData source)` Copy color conversion tables.
`void`	`createDefaultColorConversionTables()` Creates the default color conversion tables.
`boolean`	`doApplicationChildrenInset()` Checks if the panels of a panel session are children of the application panel.
`boolean`	`doCreateProperties()` Do create properties (NOTYET TW TEST).
`boolean`	`doMapEscapeToF12()` Checks if the application maps Escape key to F12 or not.
`boolean`	`doUseHelpIDTable()` Checks if the application uses a help ID file or not.
`Hashtable<String,PhantomObject>`	`getAllObjects()` Gets all the objects in the application.
`Enumeration<PhantomPanelData>`	`getAllPanels()` Gets all panels in the application.
`PhantomPanelData`	`getApplicationPanel()` Gets the loaded application panel.
`PhantomCBar`	`getBarFile(PhantomControl control, String id)` Gets a bar file object.
`PhantomCBar`	`getBarFile(PhantomControl control, String id, boolean loadIfRequired)` Gets a bar file object.
`Hashtable<String,PhantomCBar>`	`getBarObjects()` Gets all the barObjects in the application.
`String`	`getCloseID()` Checks if the application uses a close ID for pop-up panels.
`void`	`getColorConversionTables(byte[] fore, byte[] back)` Returns the foreground and background color conversion tables into the arrays specified.
`se.entra.phantom.geditor.NPPColorItemManager`	`getColorItemManager()` Shortcut to get color item manager from property worker.
`Hashtable<String,Vector<String>>`	`getConnectionsForPopupMenu()` Gets hash table of connections for pop-up menus (key name of pop-up menu) (value vector of connections(String))
`se.entra.phantom.geditor.NPPColor`	`getControlBackgroundColor(VirtualControl vCtl, boolean isDisable, boolean doDisableBackground, se.entra.phantom.geditor.NPPColor originalBackground)` Set the control background color.
`int[]`	`getControlColor(int vioClr, boolean isFore, boolean isBack)` Gets the control colors from host VIO color and color conversion.
`int[]`	`getControlColor(VirtualControl vCtl, int vioClr, boolean isFore, boolean isBack)` Gets the control colors from host VIO color and color conversion.
`PhantomApplicationData.Directory[]`	`getDirectories()` Gets the application directory array of panels and screens.
`String`	`getHiddenPanelDescription(PhantomApplicationData.Directory dir)` Gets the description for a hidden panel.
`String`	`getIconFile()` Gets a iconFile
`int`	`getIconID()` Gets a iconID
`PhantomObject`	`getObject(String name)` Gets an object from its name.
`Enumeration<PhantomObject>`	`getObjects()` Gets all the objects in the application.
`PhantomPanelData`	`getPanel(String name)` Gets a loaded panel in the application.
`PhantomApplicationData.Directory`	`getPanelFromScreen(String name)` Gets a panel or hidden panel from a screen.
`Hashtable<String,PhantomPanelData>`	`getPanels()` Gets all panels in the application - returns a hash table
`Hashtable<String,PhantomApplicationData.Directory>`	`getPanelToScreens()` Gets panelToScreen hash table in the application.
`PhantomObject`	`getPhantomMacro(String macroName)` Finds an object that used to be a Phantom Macro, now converted to a REXX macro that is executed in the appropriate thread with locking of the host session from interaction with the panels.
`PhantomPopupMenu`	`getPopupMenuForControlID(String id)` Gets a pop-up menu reference from a control ID.
`Hashtable<String,PhantomPopupMenu>`	`getPopupMenuIDs()` Gets all the popupMenuIDs in the application.
`se.entra.phantom.geditor.PropertyWorker`	`getPropertyWorker()` Get property worker reference.
`void`	`getReferencedFiles(ArrayList<String> files)` Get all the files that are referenced by this panel.
`PhantomRuntime`	`getRuntime()` Get the runtime data.
`PhantomApplicationData.Directory`	`getScreenFromPanel(String name)` Gets the screen that corresponds to a panel.
`int`	`getStdHeight()` Gets the application default panel height in dialog coordinates (multiplied by 10).
`int`	`getStdWidth()` Gets the application default panel width in dialog coordinates (multiplied by 10).
`String`	`getTextFile()` Gets the text file in the application - returns a String
`String`	`getTitle()` Gets the title of the application.
`String`	`getTranslationFile()` Gets the translation file in the application - returns a String
`int`	`getWaitStableDelay()` Gets the wait-stable delay for host screens.
`boolean`	`hasApplicationPanel()` Application has application panel?
`boolean`	`hasCloseID()` Checks if the application uses a close ID for pop-up panels.
`boolean`	`hasIndividualSize()` Checks if the panel has individual size.
`boolean`	`hasMenuInSystemMenu()` Checks if panels display the menu bar or if they use the pop-up menu (as in the system menu).
`boolean`	`inhibitTransform()` Checks if the application should inhibit resize (font substitution and ratioX/ratioY).
`boolean`	`interruptLoading()` Interrupt loading?
`boolean`	`isApplicationMaximized()` Checks if the application is maximized.
`boolean`	`isSystemMessageBoxEnabled(boolean isPopup)` Checks if system message boxes are enabled.
`void`	`load(PhantomRuntime runtime, PhantomFile file, boolean doLoadObjects)` Loads the host definitions from the application file.
`void`	`load(PhantomRuntime runtime, PhantomFile file, boolean doLoadObjects, boolean doLoadOtherExternalFiles)` Loads the host definitions from the application file.
`void`	`load(PhantomRuntime runtime, PhantomFile file, boolean doLoadObjects, boolean doLoadOtherExternalFiles, boolean doConvertProgramText)` Loads the host definitions from the application file.
`void`	`loadObjectClasses()` Loads the class files for REXX/DLL objects.
`PhantomPanelData`	`loadPanel(PhantomHostData hostData, String name)` Loads the panel data (loads it if required).
`void`	`maybeThrowIOException(String msg)` Throws an IOException with the message specified if the runtime file is loaded normally and doesn't have the flag doIgnoreNonFatalErrors set.
`boolean`	`needsReload()` Check if this file needs to be reloaded.
`void`	`processTooltipText(Hashtable<String,String> t)` Sets the tool-tip texts for all ID's in the hash table for control ID's and menu ID's.
`int`	`reload(boolean force)` Reload internal state from external sources.
`void`	`save(PhantomOutputFile file)` Saves the file to the output file.
`void`	`save(String fileName)` Saves the host definitions to the application file.
`void`	`setColorConversionTables(byte[] fore, byte[] back)` Replaces a color conversion tables.
`void`	`setControlColor(VirtualControl vCtl, int vioClr, boolean isFore, boolean isBack)` Set the control color from host VIO color and color conversion.
`void`	`setControlColor(VirtualControl vCtl, int vioClr, boolean isFore, boolean isBack, boolean doForegroundColor, boolean doKeepBackgroundAtNoConversion)` Set the control color from host VIO color and color conversion.
`void`	`setLoadedPanels(Hashtable<String,PhantomPanelData> panels)` Set loaded panels.
`void`	`setLoadListener(LoadProgress listener)` Explicitly set the load listener.
`boolean`	`useHelpIDFromHost()` Checks if the application uses a the help ID from host field name whenever a control doesn't have any ID.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- APPFLAG_MAXIMIZE
```
public static final int APPFLAG_MAXIMIZE
```
  Maximize main panels.
  
  See Also:
  Constant Field Values
- APPFLAG_SYSMENU
```
public static final int APPFLAG_SYSMENU
```
  Menu in system menu.
  
  See Also:
  Constant Field Values
- APPFLAG_NEWGROUP
```
public static final int APPFLAG_NEWGROUP
```
  New drawing of group boxes and frames.
  
  See Also:
  Constant Field Values
- APPFLAG_INDSIZE
```
public static final int APPFLAG_INDSIZE
```
  Individual main panel size.
  
  See Also:
  Constant Field Values
- APPFLAG_PASSFKEYS
```
public static final int APPFLAG_PASSFKEYS
```
  Pass through function keys to the host.
  
  See Also:
  Constant Field Values
- APPFLAG_MSGDISBASE
```
public static final int APPFLAG_MSGDISBASE
```
  Disable msg box base.
  
  See Also:
  Constant Field Values
- APPFLAG_MSGDISMAIN
```
public static final int APPFLAG_MSGDISMAIN
```
  Disable msg box for main.
  
  See Also:
  Constant Field Values
- APPFLAG_MSGDISPOPUP
```
public static final int APPFLAG_MSGDISPOPUP
```
  Disable msg box for popup.
  
  See Also:
  Constant Field Values
- APPFLAG_MSGDISALL
```
public static final int APPFLAG_MSGDISALL
```
  Both flags for disable system message boxes. (APPFLAG_MSGDISMAIN + APPFLAG_MSGDISPOPUP: 32 + 64).
  
  See Also:
  Constant Field Values
- APPFLAG_PROCESSLOCK
```
public static final int APPFLAG_PROCESSLOCK
```
  Process panels at lock.
  
  See Also:
  Constant Field Values
- APPFLAG_PHH
```
public static final int APPFLAG_PHH
```
  Use help ID file.
  
  See Also:
  Constant Field Values
- APPFLAG_FIELDIDHELP
```
public static final int APPFLAG_FIELDIDHELP
```
  Host ID, no control ID (help).
  
  See Also:
  Constant Field Values
- APPFLAG_ESCNOTF12
```
public static final int APPFLAG_ESCNOTF12
```
  Escape not mapped to F12.
  
  See Also:
  Constant Field Values
- APPFLAG_NOMNEMONIC
```
public static final int APPFLAG_NOMNEMONIC
```
  No mnemonics Check/Radio.
  
  See Also:
  Constant Field Values
- APPFLAG_MERGEPOPMENU
```
public static final int APPFLAG_MERGEPOPMENU
```
  Merge all pop-up menus.
  
  See Also:
  Constant Field Values
- APPFLAG_INHIBITTRANSFORM
```
public static final int APPFLAG_INHIBITTRANSFORM
```
  Inhibit transform (font substitution and ratioX/ratioY).
  
  See Also:
  Constant Field Values
- APPFLAG_OUTPUTTEXTFOCUS
```
public static final int APPFLAG_OUTPUTTEXTFOCUS
```
  Enable focus to all output fields.
  
  See Also:
  Constant Field Values
- defaultColorConvFore
```
public static final byte[] defaultColorConvFore
```
- defaultColorConvBack
```
public static final byte[] defaultColorConvBack
```
- objects
```
public Hashtable<String,PhantomObject> objects
```
  The table of Phantom Objects.
- textFile
```
public String textFile
```
  The application text file or null if none.
- xlateFile
```
public String xlateFile
```
  The application translation file or null if none.
- phaFileName
```
public String phaFileName
```
  The file name of the PHA file when not inside a runtime file, should otherwise not be used.
- appObject
```
public PhantomObject appObject
```
  The application object reference.
- loadListener
```
public LoadProgress loadListener
```
  The application object reference.

Constructor Detail
- PhantomApplicationData
```
public PhantomApplicationData()
```
  Creates a default empty by initiated instance of the application data.

Method Detail

interruptLoading
```
public boolean interruptLoading()
```
Interrupt loading?

Returns:
boolean

load

public void load(PhantomRuntime runtime,
        PhantomFile file,
        boolean doLoadObjects)
          throws IOException

Loads the host definitions from the application file.

  Read:
    + Application title                           BYTE [97]
 
    + Last message file used for application      BYTE [9]
    + Last translation file used for application  BYTE [9]
 
    + Size of panels in X                         USHORT
    + Size of panels in Y                         USHORT
 
    + Count of panels                             USHORT
    + Count of objects                            USHORT
 
    + Application panel ID                        BYTE [9]
    + Application panel description               BYTE [65]
    + Application icon DLL                        BYTE [9]
    + Application icon ID                         USHORT
    + Application object                          BYTE [9]
    + Application scroll bar flag                 BYTE
    + Application maximize flag                   BYTE
    + Application insets children flag            BYTE
 
    + Color conversion table                      BYTE [256+32 + 256+32]
 
    + Skip flag for DLL modules names             BYTE
 
    + Close ID for pop-up panels                  BYTE [9]
    + Wait stable time                            USHORT
    + Application flags                           USHORT
    + Skip extra space in X1,X2,Y1,Y2             BYTE [4]
    + Skip base text ID                           BYTE [4]
 
    + Reserved area                               BYTE [43]
 
    + Panel type and flags array                  USHORT [panelCount]
 
    + Skip (file image size)                      ULONG
    + Skip (segmentCount)                         USHORT
    + Skip (segment sizes)                        USHORT [segmentCount]
 
    + Screen names                                ZTSTRING
    + Panel names                                 ZTSTRING
 
    + All objects (handled by PhantomObject class).

Throws:: IOException - if an I/O error occurs.
See Also:: PhantomObject

load
```
public void load(PhantomRuntime runtime,
        PhantomFile file,
        boolean doLoadObjects,
        boolean doLoadOtherExternalFiles)
          throws IOException
```
Loads the host definitions from the application file. The parameter "doLoadOtherExternalFiles" is used to set whether to load PHW, PHO PHB, PHX and PHM files or not.

Throws:

IOException

load

public void load(PhantomRuntime runtime,
        PhantomFile file,
        boolean doLoadObjects,
        boolean doLoadOtherExternalFiles,
        boolean doConvertProgramText)
          throws IOException

Loads the host definitions from the application file. The parameter "doLoadOtherExternalFiles" is used to set whether to load PHW, PHO PHB, PHX and PHM files or not.

Throws:: IOException

clean
```
public void clean()
```
Clean the application.

save

public void save(String fileName)
          throws IOException

Saves the host definitions to the application file.

  Save:
    + Application title                           BYTE [97]
 
    + Last message file used for application      BYTE [9]
    + Last translation file used for application  BYTE [9]
 
    + Size of panels in X                         USHORT
    + Size of panels in Y                         USHORT
 
    + Count of panels                             USHORT
    + Count of objects                            USHORT
 
    + Application panel ID                        BYTE [9]
    + Application panel description               BYTE [65]
    + Application icon DLL                        BYTE [9]
    + Application icon ID                         USHORT
    + Application object                          BYTE [9]
    + Application scroll bar flag                 BYTE
    + Application maximize flag                   BYTE
    + Application insets children flag            BYTE
 
    + Color conversion table                      BYTE [256+32 + 256+32]
 
    + Skip flag for DLL modules names             BYTE
 
    + Close ID for pop-up panels                  BYTE [9]
    + Wait stable time                            USHORT
    + Application flags                           USHORT
    + Skip extra space in X1,X2,Y1,Y2             BYTE [4]
    + Skip base text ID                           BYTE [4]
 
    + Reserved area                               BYTE [43]
 
    + Panel type and flags array                  USHORT [panelCount]
 
    + Skip (file image size)                      ULONG
    + Skip (segmentCount)                         USHORT
    + Skip (segment sizes)                        USHORT [segmentCount]
 
    + Screen names                                ZTSTRING
    + Panel names                                 ZTSTRING
 
    + All objects (handled by PhantomObject class).

Parameters:: fileName -
Throws:: IOException - if an I/O error occurs.
See Also:: PhantomObject

save
```
public void save(PhantomOutputFile file)
          throws IOException
```
Saves the file to the output file.

Throws:

IOException - if an I/O error occurs.

getObject
```
public PhantomObject getObject(String name)
```
Gets an object from its name. Returns null if not found.

loadObjectClasses
```
public void loadObjectClasses()
                       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.

getObjects
```
public Enumeration<PhantomObject> getObjects()
```
Gets all the objects in the application.

Returns:
null if no objects exist.

getPopupMenuIDs
```
public Hashtable<String,PhantomPopupMenu> getPopupMenuIDs()
```
Gets all the popupMenuIDs in the application.

Returns:
null if no popupMenuIDs exist.

getBarObjects
```
public Hashtable<String,PhantomCBar> getBarObjects()
```
Gets all the barObjects in the application.

Returns:
null if no barObjects exist.

getAllObjects
```
public Hashtable<String,PhantomObject> getAllObjects()
```
Gets all the objects in the application.

Returns:
null if no objects exist.

getPanelToScreens
```
public Hashtable<String,PhantomApplicationData.Directory> getPanelToScreens()
```
Gets panelToScreen hash table in the application.

Returns:
null if no table exist.

addPopupMenuControlID

public void addPopupMenuControlID(String id,
                         PhantomPopupMenu popupMenu)

Adds a control ID reference to a pop-up menu (if the control ID is not already in the table.

getPopupMenuForControlID
```
public PhantomPopupMenu getPopupMenuForControlID(String id)
```
Gets a pop-up menu reference from a control ID.

getPanelFromScreen
```
public PhantomApplicationData.Directory getPanelFromScreen(String name)
```
Gets a panel or hidden panel from a screen. It is ensured that it is either the non-secondary panel or that it is the first panel that is secondary if no non-secondary panel exists.

Returns:
null if not found.

getScreenFromPanel
```
public PhantomApplicationData.Directory getScreenFromPanel(String name)
```
Gets the screen that corresponds to a panel.

Returns:
null if not found.

getHiddenPanelDescription

public String getHiddenPanelDescription(PhantomApplicationData.Directory dir)

Gets the description for a hidden panel.

addHiddenPanel

public boolean addHiddenPanel(PhantomApplicationData.Directory dir,
                     String descr,
                     boolean doReplace)

Adds a directory entry (hidden panel).

Returns:: true for success, false for failure.

addObject

public boolean addObject(PhantomObject po,
                boolean doReplace)

Adds an object.

Returns:: true for success, false for failure.

addPanel

public boolean addPanel(PhantomPanelData panel,
               PhantomApplicationData.Directory dir,
               boolean doReplace)

Adds a panel to the application.

loadPanel

public PhantomPanelData loadPanel(PhantomHostData hostData,
                         String name)
                           throws IOException

Loads the panel data (loads it if required).

Throws:: IOException

maybeThrowIOException
```
public void maybeThrowIOException(String msg)
                           throws IOException
```
Throws an IOException with the message specified if the runtime file is loaded normally and doesn't have the flag doIgnoreNonFatalErrors set. If it is not thrown, a message is logged in the event log.

Throws:

IOException

getPanel
```
public PhantomPanelData getPanel(String name)
```
Gets a loaded panel in the application.

Returns:
null if the panel is not found.

getIconFile
```
public String getIconFile()
```
Gets a iconFile

Returns:
null if the panel is not found.

getConnectionsForPopupMenu
```
public Hashtable<String,Vector<String>> getConnectionsForPopupMenu()
```
Gets hash table of connections for pop-up menus (key name of pop-up menu) (value vector of connections(String))

getIconID
```
public int getIconID()
```
Gets a iconID

getAllPanels
```
public Enumeration<PhantomPanelData> getAllPanels()
```
Gets all panels in the application.

Returns:
null if not panels in the application.

getStdWidth
```
public int getStdWidth()
```
Gets the application default panel width in dialog coordinates (multiplied by 10).

getStdHeight
```
public int getStdHeight()
```
Gets the application default panel height in dialog coordinates (multiplied by 10).

getDirectories
```
public PhantomApplicationData.Directory[] getDirectories()
```
Gets the application directory array of panels and screens.

getPanels
```
public Hashtable<String,PhantomPanelData> getPanels()
```
Gets all panels in the application - returns a hash table

Returns:
null if not panels in the application.

getTranslationFile
```
public String getTranslationFile()
```
Gets the translation file in the application - returns a String

Returns:
null if not panels in the application.

getTextFile
```
public String getTextFile()
```
Gets the text file in the application - returns a String

Returns:
null if not panels in the application.

getApplicationPanel
```
public PhantomPanelData getApplicationPanel()
```
Gets the loaded application panel.

Returns:
null if no application panel exist.

addBarFile

public void addBarFile(String id,
              PhantomCBar bar)

Adds a new bar file object.

getBarFile

public PhantomCBar getBarFile(PhantomControl control,
                     String id)

Gets a bar file object.

Returns:: null if the bar is not loaded.

getBarFile

public PhantomCBar getBarFile(PhantomControl control,
                     String id,
                     boolean loadIfRequired)
                       throws IOException

Gets a bar file object.

Returns:: null if the bar is not loaded (and "loadIfRequired" is false).
Throws:: IOException - If bar file cannot be loaded.

areHostChangesProcessedDuringLock
```
public boolean areHostChangesProcessedDuringLock()
```
Checks if host changes are processed during session lock.

getTitle
```
public String getTitle()
```
Gets the title of the application.

arePanelsMaximized
```
public boolean arePanelsMaximized()
```
Checks if main panels are maximized when created.

hasMenuInSystemMenu
```
public boolean hasMenuInSystemMenu()
```
Checks if panels display the menu bar or if they use the pop-up menu (as in the system menu).

isApplicationMaximized
```
public boolean isApplicationMaximized()
```
Checks if the application is maximized.

doApplicationChildrenInset
```
public boolean doApplicationChildrenInset()
```
Checks if the panels of a panel session are children of the application panel.

arePFKeysPassedToHost
```
public boolean arePFKeysPassedToHost()
```
Checks if the functions keys are passed to host.

hasCloseID
```
public boolean hasCloseID()
```
Checks if the application uses a close ID for pop-up panels.

getCloseID
```
public String getCloseID()
```
Checks if the application uses a close ID for pop-up panels.

hasIndividualSize
```
public boolean hasIndividualSize()
```
Checks if the panel has individual size.

doUseHelpIDTable
```
public boolean doUseHelpIDTable()
```
Checks if the application uses a help ID file or not.

assignHelpIDTable
```
public void assignHelpIDTable(Hashtable<String,String> table)
```
Assigns a Help ID table to the application. If any is already present, it will be overwritten.

doMapEscapeToF12
```
public boolean doMapEscapeToF12()
```
Checks if the application maps Escape key to F12 or not.

inhibitTransform
```
public boolean inhibitTransform()
```
Checks if the application should inhibit resize (font substitution and ratioX/ratioY).

useHelpIDFromHost
```
public boolean useHelpIDFromHost()
```
Checks if the application uses a the help ID from host field name whenever a control doesn't have any ID.

getWaitStableDelay
```
public int getWaitStableDelay()
```
Gets the wait-stable delay for host screens.

copyApplicationData
```
public void copyApplicationData(PhantomApplicationData source)
```
Copy application data.

Parameters:
PhantomApplicationData - - source data

copyApplicationPanel
```
public PhantomPanelData copyApplicationPanel(PhantomApplicationData source)
```
Copy application panel and settings.

Parameters:
PhantomApplicationData - - source data

Returns:
PhantomPanelData - null means that no application panel was available in source

copyColorConversion
```
public void copyColorConversion(PhantomApplicationData source)
```
Copy color conversion tables.

Parameters:
PhantomApplicationData - - source data

hasApplicationPanel
```
public boolean hasApplicationPanel()
```
Application has application panel?

Returns:
boolean

processTooltipText
```
public void processTooltipText(Hashtable<String,String> t)
```
Sets the tool-tip texts for all ID's in the hash table for control ID's and menu ID's.

setControlColor
```
public void setControlColor(VirtualControl vCtl,
                   int vioClr,
                   boolean isFore,
                   boolean isBack)
```
Set the control color from host VIO color and color conversion. If flag for disable background color is set, always set same control background color as panel background color.

setControlColor

public void setControlColor(VirtualControl vCtl,
                   int vioClr,
                   boolean isFore,
                   boolean isBack,
                   boolean doForegroundColor,
                   boolean doKeepBackgroundAtNoConversion)

Set the control color from host VIO color and color conversion. If flag for disable background color is set, always set same control background color as panel background color.

getControlColor
```
public int[] getControlColor(VirtualControl vCtl,
                    int vioClr,
                    boolean isFore,
                    boolean isBack)
```
Gets the control colors from host VIO color and color conversion. If flag for disable background color is set, always set same control background color as panel background color.

Returns:
An array with two elements containing the foreground and background color index.

getControlColor
```
public int[] getControlColor(int vioClr,
                    boolean isFore,
                    boolean isBack)
```
Gets the control colors from host VIO color and color conversion. If flag for disable background color is set, always set same control background color as panel background color.

Returns:
An array with two elements containing the foreground and background color index.

setLoadListener
```
public void setLoadListener(LoadProgress listener)
```
Explicitly set the load listener.

Parameters:
listener - - LoadProgress

setLoadedPanels

public void setLoadedPanels(Hashtable<String,PhantomPanelData> panels)

Set loaded panels.

Parameters:: Hashtable - PhantomPanelData>







getControlBackgroundColor
public se.entra.phantom.geditor.NPPColor getControlBackgroundColor(VirtualControl vCtl,
                                                          boolean isDisable,
                                                          boolean doDisableBackground,
                                                          se.entra.phantom.geditor.NPPColor originalBackground)
Set the control background color. If flag for disable background color is
 set, always set same control background color as panel background color.







getReferencedFiles
public void getReferencedFiles(ArrayList<String> files)
Get all the files that are referenced by this panel.







getRuntime
public PhantomRuntime getRuntime()
Get the runtime data.







isSystemMessageBoxEnabled
public boolean isSystemMessageBoxEnabled(boolean isPopup)
Checks if system message boxes are enabled. Set isPopup=false for main
 panels.







doCreateProperties
public boolean doCreateProperties()
Do create properties (NOTYET TW TEST).







getPropertyWorker
public se.entra.phantom.geditor.PropertyWorker getPropertyWorker()
Get property worker reference.







getColorItemManager
public se.entra.phantom.geditor.NPPColorItemManager getColorItemManager()
Shortcut to get color item manager from property worker.







needsReload
public boolean needsReload()
                    throws IOException
Check if this file needs to be reloaded.

Specified by:
needsReload in interface IReloadable
Returns:
boolean
Throws:
IOException







reload
public int reload(boolean force)
           throws IOException
Reload internal state from external sources.

Specified by:
reload in interface IReloadable
Parameters:
force - force the reload.
Returns:
IReloadable.FAILURE, IReloadable.SUCCESS or IReloadable.NOTHING_DONE.
Throws:
IOException







createDefaultColorConversionTables
public void createDefaultColorConversionTables()
Creates the default color conversion tables.







setColorConversionTables
public void setColorConversionTables(byte[] fore,
                            byte[] back)
Replaces a color conversion tables. The two tables must be 256+32 bytes long each.







getColorConversionTables
public void getColorConversionTables(byte[] fore,
                            byte[] back)
Returns the foreground and background color conversion tables into the arrays specified. They
 must be 256+32 bytes long each.







getPhantomMacro
public PhantomObject getPhantomMacro(String macroName)
Finds an object that used to be a Phantom Macro, now converted to a REXX macro that
 is executed in the appropriate thread with locking of the host session from interaction
 with the panels.
Returns:
null  if not found.







areOutputFieldsFocusable
public boolean areOutputFieldsFocusable()
Checks if the output fields are focusable.

Class PhantomApplicationData

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

APPFLAG_MAXIMIZE

APPFLAG_SYSMENU

APPFLAG_NEWGROUP

APPFLAG_INDSIZE

APPFLAG_PASSFKEYS

APPFLAG_MSGDISBASE

APPFLAG_MSGDISMAIN

APPFLAG_MSGDISPOPUP

APPFLAG_MSGDISALL

APPFLAG_PROCESSLOCK

APPFLAG_PHH

APPFLAG_FIELDIDHELP

APPFLAG_ESCNOTF12

APPFLAG_NOMNEMONIC

APPFLAG_MERGEPOPMENU

APPFLAG_INHIBITTRANSFORM

APPFLAG_OUTPUTTEXTFOCUS

defaultColorConvFore

defaultColorConvBack

objects

textFile

xlateFile

phaFileName

appObject

loadListener

Constructor Detail

PhantomApplicationData

Method Detail

interruptLoading

load

load

load

clean

save

save

getObject

loadObjectClasses

getObjects

getPopupMenuIDs

getBarObjects

getAllObjects

getPanelToScreens

addPopupMenuControlID

getPopupMenuForControlID

getPanelFromScreen

getScreenFromPanel

getHiddenPanelDescription

addHiddenPanel

addObject

addPanel

loadPanel

maybeThrowIOException

getPanel

getIconFile

getConnectionsForPopupMenu

getIconID

getAllPanels

getStdWidth

getStdHeight

getDirectories

getPanels

getTranslationFile

getTextFile

getApplicationPanel

addBarFile

getBarFile

getBarFile

areHostChangesProcessedDuringLock

getTitle

arePanelsMaximized

hasMenuInSystemMenu

isApplicationMaximized