PhantomApplicationData (NetPhantom® 7.7 Java API Specification)

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

All Implemented Interfaces:

Cloneable, IENPObjectOwner, INPObjects
```
public class PhantomApplicationData
extends Object
implements Cloneable, INPObjects, IENPObjectOwner
```
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`
`protected boolean`	`doReplaceProgramText` How files (text and translation tables are loaded), with or without program name conversion.
`static PhantomPanelData[]`	`EMPTY_PANELS` Empty panels array.
`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.

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

All Methods Static Methods Instance Methods Concrete 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`	`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`	`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.
`ApplicationReferences`	`getApplicationReferences()` Gets the Application References for the entire application.
`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.
`PhantomCBar[]`	`getBars()` Gets the Bar files.
`ApplicationReferences`	`getCachedApplicationReferences()` Gets a cached instance of the references.
`ENPRootObject`	`getCachedNPObject()` Gets the cached NPObject root.
`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.
`static 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`	`getExistingHelpDocumentForID(String id)` Gets an existing help document for a help ID.
`String`	`getHelpDocument(String controlID, String panelID)` Map a help ID entry to a HTML help document when an application uses the help ID file.
`Hashtable<String,String>`	`getHelpIDTable()` Gets the Help ID table for the application.
`String`	`getHiddenPanelDescription(PhantomApplicationData.Directory dir)` Gets the description for a hidden panel.
`String`	`getIconFile()` Gets a iconFile
`int`	`getIconID()` Gets a iconID
`ENPRootObject`	`getNPObject()` Gets the NPObjects for the application data.
`String`	`getNPObjectName()` Gets the NP Object file name in the project application directory.
`PhantomObject`	`getObject(String name)` Gets an object from its name.
`PhantomObject`	`getObject(String objectName, String referer, String location)` Gets the object associated with the object name, may be null if the object name is empty.
`Iterator<PhantomObject>`	`getObjectIterator()` Gets all objects as an Iterator that is always defined.
`Enumeration<PhantomObject>`	`getObjects()` Gets all the objects in the application.
`Collection<PhantomObject>`	`getObjectsCollection()` Gets all objects as a Collection that is always defined.
`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
`PhantomPanelData[]`	`getPanelsArray()` Gets the panels array (thread-safe) in the application.
`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.
`int`	`getPopupMenuCount()` Gets the count of pop-up menus in the application.
`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.
`PhantomPopupMenu[]`	`getPopupMenus()` Gets all the pop-up menus in the application.
`static 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.
`Hashtable<String,String>`	`getTooltipTextTable()` Gets the tooltip text table.
`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`	`hasBarFile(String barFile)` Checks if the bar file could potentially be loaded if not already.
`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`	`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, boolean doLoadOtherExternalFiles, boolean doConvertProgramText)` Loads the host definitions from the application file.
`int`	`loadObjectClasses()` Loads the class files for REXX/DLL objects.
`void`	`maybeThrowIOException(MaybeIOException exception)` Throws an IOException with the message specified if the runtime file is loaded normally and doesn't have the flag doIgnoreNonFatalErrors set.
`boolean`	`needsHelpIDLoad()` Does helpID file needs to be loaded for the first time or reloaded?
`boolean`	`needsReload(boolean allFiles)` Check if this file needs to be reloaded.
`boolean`	`needsReloadPHA()` Check if the .PHA file needs to be reloaded.
`boolean`	`needsTextLoad()` Does message file needs to be loaded for the first time or reloaded?
`boolean`	`needsTooltipLoad()` Does tooltip file needs to be loaded for the first time or reloaded?
`boolean`	`needsXlateLoad()` Does translation file needs to be loaded for the first time or reloaded?
`void`	`onENPObjectInvalidated()` Invalidates the chain of objects up to the owner in order to get it sent to Eclipse.
`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(PhantomHostData hostData, IProgressMonitor monitor, IReloadListener listener, boolean allFiles)` Reload internal state from external sources.
`boolean`	`reloadTextFile(boolean always)` Reloads the text file immediately if it is required.
`void`	`resolveCachedImageReferences()` Re-checks the cached NPObjects for referenced image changes.
`void`	`save(PhantomOutputFile file)` Saves the file to the output file.
`void`	`save(String fileName)` Saves the host definitions to the application file.
`void`	`save(String fileName, boolean isNetPhantom5)` 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`	`setTooltipTextTable(Hashtable<String,String> t)` Sets the tooltip text table.
`void`	`updateReferences(ApplicationReferences refs)` Updates the Applications References instance.
`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
```
  - doReplaceProgramText
```
protected boolean doReplaceProgramText
```
    How files (text and translation tables are loaded), with or without program name conversion. Note: Always false so far.
  - 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.
  - EMPTY_PANELS
```
public static final PhantomPanelData[] EMPTY_PANELS
```
    Empty panels array.
- Constructor Detail
  - PhantomApplicationData
```
public PhantomApplicationData()
```
    Creates a default empty by initiated instance of the application data.
- Method Detail
  - 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.
    
    Parameters:
    
    runtime - The runtime.
    
    file - The application (.PHA) file.
    
    doLoadObjects - Flag to load and instantiate the objects.
    
    doLoadOtherExternalFiles - Flag indicating external files (PHW PHO PHM PHX TT) should be loaded.
    
    doConvertProgramText - If texts in the text file and translation table should be converted, (e.g. for @*PROGNAME@).
    
    Throws:
    
    IOException - If an I/O error occurs.
  - save
```
public void save(String fileName)
          throws IOException
```
    Saves the host definitions to the application file.
    
    Parameters:
    
    fileName -
    
    Throws:
    
    IOException - if an I/O error occurs.
  - save
```
public void save(String fileName,
                 boolean isNetPhantom5)
          throws IOException
```
    Saves the host definitions to the application file.
    
    Parameters:
    
    fileName - File name.
    
    isNetPhantom5 - Flag for NetPhantom 5 compatibility.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - 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 int loadObjectClasses()
                      throws IOException
```
    Loads the class files for REXX/DLL objects. This is useful when the runtime has been loaded without loading the classes.
    
    Returns:
    
    Count of errors of loading.
    
    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.
  - getObjectIterator
```
public Iterator<PhantomObject> getObjectIterator()
```
    Gets all objects as an Iterator that is always defined.
  - getObjectsCollection
```
public Collection<PhantomObject> getObjectsCollection()
```
    Gets all objects as a Collection that is always defined.
  - getPopupMenuIDs
```
public Hashtable<String,PhantomPopupMenu> getPopupMenuIDs()
```
    Gets all the popupMenuIDs in the application.
    
    Returns:
    
    The table, never null.
  - getPopupMenus
```
public PhantomPopupMenu[] getPopupMenus()
```
    Gets all the pop-up menus in the application.
    
    Returns:
    
    The array, never null.
  - getBarObjects
```
public Hashtable<String,PhantomCBar> getBarObjects()
```
    Gets all the barObjects in the application.
    
    Returns:
    
    The table, never null.
  - getBars
```
public PhantomCBar[] getBars()
```
    Gets the Bar files.
    
    Returns:
    
    The array of Bar files.
  - 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.
  - maybeThrowIOException
```
public void maybeThrowIOException(MaybeIOException exception)
                           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.
  - getPanelsArray
```
public PhantomPanelData[] getPanelsArray()
```
    Gets the panels array (thread-safe) in the application.
    
    Returns:
    
    A non-null array.
  - 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.
  - getHelpIDTable
```
public Hashtable<String,String> getHelpIDTable()
```
    Gets the Help ID table for the application.
    
    Returns:
    
    null if not used or not set.
  - getTooltipTextTable
```
public Hashtable<String,String> getTooltipTextTable()
```
    Gets the tooltip text table.
    
    Returns:
    
    null if not used or not set.
  - setTooltipTextTable
```
public void setTooltipTextTable(Hashtable<String,String> t)
```
    Sets the tooltip text table.
  - getExistingHelpDocumentForID
```
public String getExistingHelpDocumentForID(String id)
```
    Gets an existing help document for a help ID. The runtime file directory will be searched for a matching file name before returning.
    This method will return null if the help ID file (if used) doesn't have the entry specified.
    
    Returns:
    
    null if the help ID does not have an existing document.
  - getHelpDocument
```
public String getHelpDocument(String controlID,
                              String panelID)
```
    Map a help ID entry to a HTML help document when an application uses the help ID file. If the application doesn't use the help ID file, the ID that has a help document as described above is returned.
    The help ID that is searched is:
```
  - PANELID_CONTROLID  (may be PANELID_MENUnn for main menus, if panelID!=null).
  - __CONTROLID        (when a control ID exist, if panelID!=null)
  - PANELID            (if panelID!=null)
  - APPLICATION_HELP   (if panelID!=null)
 
```
    The help document has the name: "applicationName\HELP_ID.html". For .PHH files, the HELP_ID is the item specified in the file (and after the equal sign if specified).
    Parameters:
    
    controlID - the Control ID or specific help ID.
    
    panelID - set to null for specific IDs (e.g. APPLICATION_HELPKEY).
    
    Returns:
    
    null if no help ID was found.
  - getApplicationPanel
```
public PhantomPanelData getApplicationPanel()
```
    Gets the loaded application panel.
    
    Returns:
    
    null if no application panel exist.
  - 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:
    
    source - The source PhantomApplicationData to copy into this instance.
  - copyApplicationPanel
```
public PhantomPanelData copyApplicationPanel(PhantomApplicationData source)
```
    Copy application panel and settings.
    
    Parameters:
    
    source - The PhantomApplicationData to copy to the application panel and some size settings for main panels.
    
    Returns:
    
    PhantomPanelData - null means that no application panel was available in source
  - copyColorConversion
```
public void copyColorConversion(PhantomApplicationData source)
```
    Copy color conversion tables.
    
    Parameters:
    
    source - Copy color conversion tables from the source PhantomApplicationData into this instance.
  - 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.
  - 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.
  - getPropertyWorker
```
public static se.entra.phantom.geditor.PropertyWorker getPropertyWorker()
```
    Get property worker reference.
  - getColorItemManager
```
public static se.entra.phantom.geditor.NPPColorItemManager getColorItemManager()
```
    Shortcut to get color item manager from property worker.
  - needsReloadPHA
```
public boolean needsReloadPHA()
```
    Check if the .PHA file needs to be reloaded.
  - needsReload
```
public boolean needsReload(boolean allFiles)
```
    Check if this file needs to be reloaded.
  - needsTextLoad
```
public boolean needsTextLoad()
```
    Does message file needs to be loaded for the first time or reloaded?
    
    Returns:
    
    true if the file needs to be loaded for the first time or reloaded.
  - needsXlateLoad
```
public boolean needsXlateLoad()
```
    Does translation file needs to be loaded for the first time or reloaded?
    
    Returns:
    
    true if the file needs to be loaded for the first time or reloaded.
  - needsTooltipLoad
```
public boolean needsTooltipLoad()
```
    Does tooltip file needs to be loaded for the first time or reloaded?
    
    Returns:
    
    true if the file needs to be loaded for the first time or reloaded.
  - needsHelpIDLoad
```
public boolean needsHelpIDLoad()
```
    Does helpID file needs to be loaded for the first time or reloaded?
    
    Returns:
    
    true if the file needs to be loaded for the first time or reloaded.
  - reload
```
public int reload(PhantomHostData hostData,
                  IProgressMonitor monitor,
                  IReloadListener listener,
                  boolean allFiles)
           throws IOException
```
    Reload internal state from external sources.
    
    Parameters:
    
    listener - The reload listener, or null for none.
    
    allFiles - Flag indicating just the PHA file when allFiles=false, not the others.
    
    Returns:
    
    IReloadable.FAILURE, IReloadable.SUCCESS or IReloadable.NOTHING_DONE.
    
    Throws:
    
    IOException
  - reloadTextFile
```
public boolean reloadTextFile(boolean always)
                       throws IOException
```
    Reloads the text file immediately if it is required.
    
    Returns:
    
    true if the file was reloaded, false if it is not.
    
    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.
  - getObject
```
public PhantomObject getObject(String objectName,
                               String referer,
                               String location)
                        throws IOException
```
    Gets the object associated with the object name, may be null if the object name is empty.
    
    Throws:
    
    IOException - if the object is not found in the application
  - 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.
  - hasBarFile
```
public boolean hasBarFile(String barFile)
```
    Checks if the bar file could potentially be loaded if not already.
    
    Returns:
    
    false if file is not present.
  - 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.
  - getPopupMenuCount
```
public int getPopupMenuCount()
```
    Gets the count of pop-up menus in the application.
  - getApplicationReferences
```
public ApplicationReferences getApplicationReferences()
```
    Gets the Application References for the entire application. A new fresh reference instance is built, invalidating the cached one.
  - getCachedApplicationReferences
```
public ApplicationReferences getCachedApplicationReferences()
```
    Gets a cached instance of the references.
  - updateReferences
```
public void updateReferences(ApplicationReferences refs)
```
    Updates the Applications References instance.
  - getNPObjectName
```
public String getNPObjectName()
```
    Gets the NP Object file name in the project application directory.
    
    Specified by:
    
    getNPObjectName in interface INPObjects
  - onENPObjectInvalidated
```
public void onENPObjectInvalidated()
```
    Invalidates the chain of objects up to the owner in order to get it sent to Eclipse.
    
    Specified by:
    
    onENPObjectInvalidated in interface IENPObjectOwner
  - getCachedNPObject
```
public ENPRootObject getCachedNPObject()
```
    Gets the cached NPObject root.
    
    Specified by:
    
    getCachedNPObject in interface INPObjects
    
    Returns:
    
    The cached root or null for none.
  - getNPObject
```
public ENPRootObject getNPObject()
```
    Gets the NPObjects for the application data.
    
    Specified by:
    
    getNPObject in interface INPObjects
  - resolveCachedImageReferences
```
public void resolveCachedImageReferences()
```
    Re-checks the cached NPObjects for referenced image changes.

Class PhantomApplicationData

Nested Class Summary

Field Summary

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

doReplaceProgramText

objects

textFile

xlateFile

phaFileName

appObject

EMPTY_PANELS

Constructor Detail

PhantomApplicationData

Method Detail

load

save

save

save

getObject

loadObjectClasses

getObjects

getObjectIterator

getObjectsCollection

getPopupMenuIDs

getPopupMenus

getBarObjects

getBars

getAllObjects

getPanelToScreens

addPopupMenuControlID

getPopupMenuForControlID

getPanelFromScreen

getScreenFromPanel

getHiddenPanelDescription

addHiddenPanel

addObject

addPanel

maybeThrowIOException

getPanel

getIconFile

getConnectionsForPopupMenu

getIconID

getAllPanels

getPanelsArray

getStdWidth

getStdHeight

getDirectories

getPanels

getTranslationFile

getTextFile

getHelpIDTable

getTooltipTextTable

setTooltipTextTable

getExistingHelpDocumentForID

getHelpDocument

getApplicationPanel

areHostChangesProcessedDuringLock

getTitle