PhantomPanelData (NetPhantom® 8.0 Java API Specification)

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

All Implemented Interfaces:: Cloneable, PhantomControlType, IENPObjectOwner, INPObjects

public class PhantomPanelData
extends Object
implements Cloneable, PhantomControlType, INPObjects, IENPObjectOwner

This class loads the Phantom Panel file.

Field Summary

Fields
Modifier and Type	Field and Description
`PhantomApplicationData`	`application` The application data.
`int`	`controlCount` The count of controls in the panel.
`Hashtable<String,PhantomControl>`	`controlIDs` Maps control IDs to virtual controls.
`PhantomControl[]`	`controls` The controls.
`static int`	`DELPOPUP_ALL` Remove all existing popups when new popup is displayed.
`static int`	`DELPOPUP_CURRENT` Remove current popup when new popup is displayed.
`static int`	`DELPOPUP_NONE` Do not remove any current popups when new popup is displayed.
`int`	`dividerX` Divider position in X.
`int`	`dividerY` Divider position in Y.
`boolean`	`doLeaveSecondaryPanelsEnabled` Flag to leave other secondary panels active when this panel is created.
`boolean`	`doRemoveAllPopupWindows` Flag indicates that when this pop-up window is created, it should remove all pop-up windows before.
`boolean`	`doRemovePopup` Removes the previous pop-up window if any.
`boolean`	`doUpdateOnHostChange` This flag causes every host change to update the panel.
`static int`	`FLAG_ALWAYSUPDATE` Always update text.
`static int`	`FLAG_FONTSIZE` Panel is font size dependent.
`static int`	`FLAG_INDSIZE` Individual size.
`static int`	`FLAG_MSGDISALL` Both (16+32) msg box.
`static int`	`FLAG_MSGDISBASE` Panel msg box base.
`static int`	`FLAG_MSGDISDISABLE` Disable msg box for panel.
`static int`	`FLAG_MSGDISENABLE` Enable msg box for panel.
`static int`	`FLAG_NEW_STYLE` New style for panels.
`static int`	`FLAG_PASSFKEYS` Pass through F-keys to emulator.
`static int`	`FLAG_RTL` Panel is RTL.
`static int`	`FLAG_SAMEASMAIN` Same level as main panel.
`static int`	`FLAG_SIZE10` Panel size is multiplied by 10.
`static int`	`FLAG_UNLOCKPOSCURSOR` Position cursor at unlock.
`int`	`flags` The panel flags.
`boolean`	`hasNoHostConnection` This flag indicates that the panel is not host connected.
`boolean`	`hasNoPanelHostCursor` No panel host cursor.
`boolean`	`hasNoZOrder` No Z-order ensuring when drawing controls.
`PhantomHostData`	`hostData` The host data.
`PhantomHostScreen`	`hostScreen` The host screen associated with this panel.
`String`	`iconFile` Icon file name.
`int`	`iconID` Icon ID.
`boolean`	`isApplicationPanel` Flag indicating the panel has the Application Panel flag set.
`boolean`	`isDialogFrame` Flag indicating that the panel has a dialog window frame.
`boolean`	`isSizeIndependent` Size independent panel
`Hashtable<String,PhantomMenuItem>`	`menuItemIDs` Maps control IDs to menu items.
`PhantomMenu[]`	`menus` The menus.
`PhantomMessageBox[]`	`messageBoxes` The message boxes.
`String`	`notebookID` The notebook panel ID of this notebook page = The main panel that should contain a notebook control that should contain this notebook page.
`PhantomObject`	`object` The reference to the panel object or null if none exist.
`String`	`objectName` Panel object name.
`int`	`offsetX` The offset for pop-up windows in X relative to its owner.
`int`	`offsetY` The offset for pop-up windows in Y relative to its owner.
`se.entra.phantom.geditor.NPPColor`	`panelColor` Panel color.
`int`	`panelCX` Panel size in X using Phantom dialog coordinates.
`int`	`panelCY` Panel size in Y using Phantom dialog coordinates.
`int`	`panelFont` the panel font.
`String`	`panelID` The panel ID.
`int`	`panType` Panel type (main, pop-up or notebook).
`static int`	`PANTYPE_MAIN` Main panel.
`static int`	`PANTYPE_NBPAGE` Notebook page.
`static int`	`PANTYPE_POPUP` Pop-up panel.
`HashSet<PhantomPopupMenu>`	`popupMenus` The table of pop-up panels connected to the controls in this panel.
`String`	`screen` Connected host screen for the panel.
`String`	`title` Panel title.

Fields inherited from interface se.entra.phantom.server.PhantomControlType
CTRLTYPE_BUTTON, CTRLTYPE_CHECK, CTRLTYPE_COMBO, CTRLTYPE_FRAME, CTRLTYPE_GRAPH, CTRLTYPE_GROUP, CTRLTYPE_INOUT, CTRLTYPE_LIST, CTRLTYPE_MLE, CTRLTYPE_NOTE, CTRLTYPE_OUT, CTRLTYPE_RADIO, CTRLTYPE_RECT, CTRLTYPE_SPIN, CTRLTYPE_SUB, CTRLTYPE_TEXT, CTRLTYPE_TREE, CTRLTYPE_UNKNOWN, CTRLTYPE_USER, CTRLTYPES_COUNT, names

Constructor Summary

Constructors
Constructor and Description
`PhantomPanelData(PhantomApplicationData application, PhantomHostScreen hostScreen, PhantomPanelData basePanel, String heading, int panelCX, int panelCY, boolean isPopupWindow)` Creates a new panel of Gui-on-the-fly type.
`PhantomPanelData(PhantomHostData hostData, PhantomApplicationData application, PhantomFile file)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addControl(PhantomControl pc)` Adds a new Gui-on-the-fly control to the panel.
`void`	`addControlID(PhantomControl c, String id)` Adds a control with a control ID.
`void`	`addMenu(PhantomMenu menu)`
`void`	`addMenuItemID(PhantomMenuItem mi, String id)` Adds a control with a control ID.
`boolean`	`addRecursiveControlReference(PhantomControl pc)` Checks if it's recursive control for references.
`boolean`	`areAllPFKeysPassedToHost()` Checks if a panel passes all PF keys to the host session (only for Gui-on-the-fly panels).
`boolean`	`areAllPopupsRemoved()` Checks if all pop-up window should be removed when this pop-up panel is created.
`boolean`	`containsNotebookPagePanel(String pageID)` Checks if this panel contains a notebook that contains the panel page ID.
`boolean`	`equals(Object o)` Checks if two panels are equal.
`boolean`	`equalsGuiOnTheFly(PhantomPanelData panel)` Checks if this panels Gui-on-the-fly CRC32 value is equal to another panel's value created in the same manner.
`boolean`	`equalsPanel(PhantomPanelData p)` Checks if two panels are equal.
`int`	`getActionConnectedControlIndex(String id)` Search for an entry field or a list box with a control ID.
`PhantomApplicationData`	`getApplicationData()` Get the application data.
`ENPRootObject`	`getCachedNPObject()` Gets the cached NPObject root.
`PhantomPopupMenu[]`	`getConnectedPopupMenuArray()` Gets the array of pop-up menus connected to this panel.
`int`	`getConnectedPopupMenuCount()` Gets count of pop-up menus connected to this panel.
`Iterator<PhantomPopupMenu>`	`getConnectedPopupMenus()` Get the enumeration of pop-up menus connected to this panel.
`PhantomControl`	`getControl(int ii)` Gets the control at a specific index.
`int`	`getControlCount()` Gets the control count.
`PhantomControl`	`getControlFromID(String id)` Gets a virtual control from a string ID.
`PhantomControl[]`	`getControls()` Gets the controls for this paneldata.
`int`	`getDividerX()` Gets the divider line position in X.
`int`	`getDividerY()` Gets the divider line position in Y.
`int`	`getHeight()` Gets the panel height in dialog coordinates (multiplied by 10).
`PhantomHostField`	`getHostField(String fieldName)` Gets the host field of a specific name.
`PhantomHostScreen`	`getHostScreen()` Gets the host screen associated with this panel.
`String`	`getHostScreenName()` Gets the host screen name associated with this panel.
`String`	`getIconFile()` Gets the icon file name.
`int`	`getIconID()` Gets the iconId.
`int`	`getIndexFromControlOrMenu(String id)` Search for control or menu from a string ID.
`PhantomMenu`	`getMenu(int index)` Gets a pull-down menu from an index.
`PhantomMenuItem`	`getMenuItemFromID(String id)` Gets a virtual control from a string ID.
`PhantomMenu[]`	`getMenus()` Gets the PhantomMenu's data.
`PhantomMessageBox[]`	`getMessageBoxes()` Gets the message boxes of the panel.
`boolean`	`getNoHostConnection()` Returns true if this panel is designed not to have a host connection.
`boolean`	`getNoPanelHostCursor()` Returns true if this panel does not update from host cursor.
`String`	`getNotebookPanelID()` This method is only used when the panel is a notebook page.
`ENPRootObject`	`getNPObject()` Gets the NPObjects for the application data.
`String`	`getNPObjectName()` Gets the NP Object file name in the project application directory.
`String`	`getNPObjectScreen()` Gets the screen for this panel.
`PhantomObject`	`getObject()` Gets the object connected to the panel.
`PhantomObject`	`getObject(String objectName, String referer)` Gets the object associated with the object name, may be null if the object name is empty.
`int`	`getOffsetX()` Gets the offset for a pop-up window panel in X.
`int`	`getOffsetY()` Gets the offset for a pop-up window panel in Y.
`se.entra.phantom.geditor.NPPColor`	`getPanelColor()` Gets the panel color index.
`int`	`getPanelControlCount()` Gets the panel data.
`int`	`getPanelFont()` Gets the panel font index.
`String`	`getPanelID()` Gets the panel ID.
`String`	`getPanelObjectName()` Gets the panel data.
`String`	`getPanelScreen()` Gets the panel data .
`String`	`getPanelTitle()` Gets the panel data.
`int`	`getPanelType()` Gets the panel data for xml writing.
`HashSet<PhantomPopupMenu>`	`getPopupMenus()` Gets the popupMenus connected to controls in panel.
`void`	`getReferencedFiles(ArrayList<String> files)` Get all the files that are referenced by this panel.
`HashSet<String>`	`getReferencesPanelIDs()` Gets the set of panel references, null for none.
`int`	`getSystemMessageBoxEnabled()` Gets the system message box enabled state: 0=disabled, 1=enabled, 2=from application.
`String`	`getTitle()` Gets the title of this panel.
`int`	`getWidth()` Gets the panel width in dialog coordinates (multiplied by 10).
`boolean`	`hasIndividualSize()` Checks if the panel has individual size.
`boolean`	`hasSameLevelAsMain()` Checks if the panel has the same Z-order level as a main panel.
`boolean`	`isCursorPositionedAtHostUnlock()` Checks if the cursor in the panel is repositioned at host unlock.
`boolean`	`isDialogFrame()` Indicating that the panel has a dialog window frame.
`boolean`	`isGuiOnTheFlyPanel()` Checks if this virtual panel is created by the Gui-on-the-fly algorithm.
`boolean`	`isHostConnected()` Checks if the panel is host connected.
`boolean`	`isMainPanel()` Checks if a panel is of main panel type.
`boolean`	`isNewStyle()` Checks if the panel is New Style for entry fields, combo boxes and spin buttons.
`boolean`	`isNotebookPage()` Checks if the panel is a notebook page.
`boolean`	`isPopupRemoved()` Checks if a pop-up window should be removed when this pop-up panel is created.
`boolean`	`isPopupWindow()` Checks if the panel is of pop-up window type.
`boolean`	`isReferencingPanelID(String panelID)` Checks if this panel has references to a panel with the specified ID.
`boolean`	`isSystemMessageBoxEnabled()` Checks if system message boxes should be displayed for this panel.
`boolean`	`isTextPromptRefreshRequired()` Checks if the static text always needs updates.
`boolean`	`needsReload()` Check if this file needs to be reloaded.
`void`	`onENPObjectInvalidated()` Invalidates the chain of objects up to the owner in order to get it sent to Eclipse.
`void`	`rebind(PhantomApplicationData applicationData, PhantomHostData hostData)` Re-bind the instance.
`int`	`reload()` Reload internal state from external sources.
`void`	`save(String fileName)` Saves the Phantom Panel file for NetPhantom 6.
`void`	`save(String fileName, boolean isNetPhantom5)` Saves the Phantom Panel file.
`void`	`setApplication(PhantomApplicationData rt)` (Re-)set the application reference.
`void`	`setHostData(PhantomHostData hd)` (Re-)set the host data reference.
`void`	`setTitle(String title)` Sets the panels heading after it has been created.
`void`	`updateReferences(ApplicationReferences refs)` Updates the Applications References instance.

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

- Field Detail
  - FLAG_INDSIZE
```
public static final int FLAG_INDSIZE
```
    Individual size.
    See Also:
    Constant Field Values
  - FLAG_SAMEASMAIN
```
public static final int FLAG_SAMEASMAIN
```
    Same level as main panel.
    See Also:
    Constant Field Values
  - FLAG_UNLOCKPOSCURSOR
```
public static final int FLAG_UNLOCKPOSCURSOR
```
    Position cursor at unlock.
    See Also:
    Constant Field Values
  - FLAG_ALWAYSUPDATE
```
public static final int FLAG_ALWAYSUPDATE
```
    Always update text.
    See Also:
    Constant Field Values
  - FLAG_MSGDISBASE
```
public static final int FLAG_MSGDISBASE
```
    Panel msg box base.
    See Also:
    Constant Field Values
  - FLAG_MSGDISENABLE
```
public static final int FLAG_MSGDISENABLE
```
    Enable msg box for panel.
    See Also:
    Constant Field Values
  - FLAG_MSGDISDISABLE
```
public static final int FLAG_MSGDISDISABLE
```
    Disable msg box for panel.
    See Also:
    Constant Field Values
  - FLAG_MSGDISALL
```
public static final int FLAG_MSGDISALL
```
    Both (16+32) msg box.
    See Also:
    Constant Field Values
  - FLAG_RTL
```
public static final int FLAG_RTL
```
    Panel is RTL.
    See Also:
    Constant Field Values
  - FLAG_FONTSIZE
```
public static final int FLAG_FONTSIZE
```
    Panel is font size dependent.
    See Also:
    Constant Field Values
  - FLAG_PASSFKEYS
```
public static final int FLAG_PASSFKEYS
```
    Pass through F-keys to emulator.
    See Also:
    Constant Field Values
  - FLAG_NEW_STYLE
```
public static final int FLAG_NEW_STYLE
```
    New style for panels.
    See Also:
    Constant Field Values
  - FLAG_SIZE10
```
public static final int FLAG_SIZE10
```
    Panel size is multiplied by 10.
    See Also:
    Constant Field Values
  - PANTYPE_MAIN
```
public static final int PANTYPE_MAIN
```
    Main panel.
    See Also:
    Constant Field Values
  - PANTYPE_POPUP
```
public static final int PANTYPE_POPUP
```
    Pop-up panel.
    See Also:
    Constant Field Values
  - PANTYPE_NBPAGE
```
public static final int PANTYPE_NBPAGE
```
    Notebook page.
    See Also:
    Constant Field Values
  - DELPOPUP_NONE
```
public static final int DELPOPUP_NONE
```
    Do not remove any current popups when new popup is displayed.
    See Also:
    Constant Field Values
  - DELPOPUP_CURRENT
```
public static final int DELPOPUP_CURRENT
```
    Remove current popup when new popup is displayed.
    See Also:
    Constant Field Values
  - DELPOPUP_ALL
```
public static final int DELPOPUP_ALL
```
    Remove all existing popups when new popup is displayed.
    See Also:
    Constant Field Values
  - panelCX
```
public int panelCX
```
    Panel size in X using Phantom dialog coordinates.
  - panelCY
```
public int panelCY
```
    Panel size in Y using Phantom dialog coordinates.
  - panType
```
public int panType
```
    Panel type (main, pop-up or notebook).
  - doUpdateOnHostChange
```
public boolean doUpdateOnHostChange
```
    This flag causes every host change to update the panel. Currently, for the Java Server, this is always true.
  - title
```
public String title
```
    Panel title.
  - screen
```
public String screen
```
    Connected host screen for the panel.
  - objectName
```
public String objectName
```
    Panel object name.
  - isSizeIndependent
```
public boolean isSizeIndependent
```
    Size independent panel
  - isApplicationPanel
```
public boolean isApplicationPanel
```
    Flag indicating the panel has the Application Panel flag set. This DOESN'T mean that it really is the application panel for the application data as several application panels could exist in an application (because of old Phantom versions). To check if it is the real application panel, compare the panel ID in this class with the application panel ID in the application data. Another way is to get the application panel reference directly from the VirtualPanel or PhantomApplicationData instances.
  - panelColor
```
public se.entra.phantom.geditor.NPPColor panelColor
```
    Panel color.
  - iconFile
```
public String iconFile
```
    Icon file name.
  - iconID
```
public int iconID
```
    Icon ID.
  - doLeaveSecondaryPanelsEnabled
```
public boolean doLeaveSecondaryPanelsEnabled
```
    Flag to leave other secondary panels active when this panel is created.
  - hasNoZOrder
```
public boolean hasNoZOrder
```
    No Z-order ensuring when drawing controls.
  - hasNoPanelHostCursor
```
public boolean hasNoPanelHostCursor
```
    No panel host cursor.
  - isDialogFrame
```
public boolean isDialogFrame
```
    Flag indicating that the panel has a dialog window frame.
  - doRemoveAllPopupWindows
```
public boolean doRemoveAllPopupWindows
```
    Flag indicates that when this pop-up window is created, it should remove all pop-up windows before. This results in this window being on top of the main panel.
  - dividerX
```
public int dividerX
```
    Divider position in X.
  - dividerY
```
public int dividerY
```
    Divider position in Y.
  - hasNoHostConnection
```
public boolean hasNoHostConnection
```
    This flag indicates that the panel is not host connected.
  - doRemovePopup
```
public boolean doRemovePopup
```
    Removes the previous pop-up window if any.
  - panelID
```
public String panelID
```
    The panel ID.
  - notebookID
```
public String notebookID
```
    The notebook panel ID of this notebook page = The main panel that should contain a notebook control that should contain this notebook page.
  - flags
```
public int flags
```
    The panel flags.
  - offsetX
```
public int offsetX
```
    The offset for pop-up windows in X relative to its owner.
  - offsetY
```
public int offsetY
```
    The offset for pop-up windows in Y relative to its owner.
  - panelFont
```
public int panelFont
```
    the panel font.
  - menus
```
public PhantomMenu[] menus
```
    The menus.
  - messageBoxes
```
public PhantomMessageBox[] messageBoxes
```
    The message boxes.
  - controls
```
public PhantomControl[] controls
```
    The controls.
  - controlCount
```
public int controlCount
```
    The count of controls in the panel.
  - application
```
public PhantomApplicationData application
```
    The application data.
  - hostData
```
public PhantomHostData hostData
```
    The host data.
  - controlIDs
```
public Hashtable<String,PhantomControl> controlIDs
```
    Maps control IDs to virtual controls.
  - menuItemIDs
```
public Hashtable<String,PhantomMenuItem> menuItemIDs
```
    Maps control IDs to menu items.
  - hostScreen
```
public PhantomHostScreen hostScreen
```
    The host screen associated with this panel. If no host screen is found or the screen name is empty.
  - object
```
public PhantomObject object
```
    The reference to the panel object or null if none exist.
  - popupMenus
```
public HashSet<PhantomPopupMenu> popupMenus
```
    The table of pop-up panels connected to the controls in this panel. The PhantomPanelData class gets all pop-up menus that are connected to control IDs.
- Constructor Detail
  - PhantomPanelData
```
public PhantomPanelData(PhantomHostData hostData,
                        PhantomApplicationData application,
                        PhantomFile file)
                 throws IOException
```
    Constructor.
    Throws:
    IOException
  - PhantomPanelData
```
public PhantomPanelData(PhantomApplicationData application,
                        PhantomHostScreen hostScreen,
                        PhantomPanelData basePanel,
                        String heading,
                        int panelCX,
                        int panelCY,
                        boolean isPopupWindow)
```
    Creates a new panel of Gui-on-the-fly type. The controls are added to the panel using the addControl method, with the base data created. The host screen must also be created prior to calling this constructor.
    The PhantomApplicationData parameter must also be a Gui-on-the-fly created application. This instance can be global for the entire server as it will only hold static information such as color conversion, application title, etc.
    See Also:
    addControl(se.entra.phantom.server.PhantomControl)
- Method Detail
  - rebind
```
public void rebind(PhantomApplicationData applicationData,
                   PhantomHostData hostData)
            throws IOException
```
    Re-bind the instance.
    Throws:
    IOException
  - save
```
public void save(String fileName)
          throws IOException
```
    Saves the Phantom Panel file for NetPhantom 6.
    Parameters:
    fileName - The file name.
    Throws:
    IOException - if an I/O error occurs.
  - save
```
public void save(String fileName,
                 boolean isNetPhantom5)
          throws IOException
```
    Saves the Phantom Panel file.
    Parameters:
    fileName - The file name.
    isNetPhantom5 - Flag for NetPhantom 5.
    Throws:
    IOException - if an I/O error occurs.
  - setApplication
```
public void setApplication(PhantomApplicationData rt)
```
    (Re-)set the application reference.
    Parameters:
    rt -
  - setHostData
```
public void setHostData(PhantomHostData hd)
```
    (Re-)set the host data reference.
    Parameters:
    hd -
  - setTitle
```
public void setTitle(String title)
```
    Sets the panels heading after it has been created. Mainly for Gui-on-the-fly panels where title has been extracted from the panel's fields.
    Parameters:
    title - The new title for the panel.
  - addMenu
```
public void addMenu(PhantomMenu menu)
```
  - addControl
```
public void addControl(PhantomControl pc)
```
    Adds a new Gui-on-the-fly control to the panel.
  - equals
```
public boolean equals(Object o)
```
    Checks if two panels are equal. Calls equalsPanel(o).
    Overrides:
    equals in class Object
  - equalsPanel
```
public boolean equalsPanel(PhantomPanelData p)
```
    Checks if two panels are equal.
  - equalsGuiOnTheFly
```
public boolean equalsGuiOnTheFly(PhantomPanelData panel)
```
    Checks if this panels Gui-on-the-fly CRC32 value is equal to another panel's value created in the same manner.
    Returns:
    false if two panels are not equal to one another in terms of controls, layout, etc. If one or both of the panels are not of Gui-on-the-fly type, this method will return false.
  - getApplicationData
```
public PhantomApplicationData getApplicationData()
```
    Get the application data.
  - reload
```
public int reload()
           throws IOException
```
    Reload internal state from external sources.
    Returns:
    int
    Throws:
    IOException
  - needsReload
```
public boolean needsReload()
```
    Check if this file needs to be reloaded.
    Returns:
    boolean
  - getHostScreen
```
public PhantomHostScreen getHostScreen()
```
    Gets the host screen associated with this panel.
    Returns:
    null if no host screen is found or the screen name is empty.
  - getHostScreenName
```
public String getHostScreenName()
```
    Gets the host screen name associated with this panel.
  - getHostField
```
public PhantomHostField getHostField(String fieldName)
```
    Gets the host field of a specific name.
    Returns:
    null if host field is not found, or the panel doesn't have a host screen name specified.
  - getObject
```
public PhantomObject getObject()
```
    Gets the object connected to the panel.
    Returns:
    null if none is connected.
  - getObject
```
public PhantomObject getObject(String objectName,
                               String referer)
                        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
  - isMainPanel
```
public boolean isMainPanel()
```
    Checks if a panel is of main panel type.
  - isPopupRemoved
```
public boolean isPopupRemoved()
```
    Checks if a pop-up window should be removed when this pop-up panel is created.
  - areAllPopupsRemoved
```
public boolean areAllPopupsRemoved()
```
    Checks if all pop-up window should be removed when this pop-up panel is created.
  - isCursorPositionedAtHostUnlock
```
public boolean isCursorPositionedAtHostUnlock()
```
    Checks if the cursor in the panel is repositioned at host unlock.
  - getNoHostConnection
```
public boolean getNoHostConnection()
```
    Returns true if this panel is designed not to have a host connection.
  - getNoPanelHostCursor
```
public boolean getNoPanelHostCursor()
```
    Returns true if this panel does not update from host cursor.
  - getPanelID
```
public String getPanelID()
```
    Gets the panel ID.
  - isDialogFrame
```
public boolean isDialogFrame()
```
    Indicating that the panel has a dialog window frame.
  - addControlID
```
public void addControlID(PhantomControl c,
                         String id)
```
    Adds a control with a control ID. The new ID, if defined, causes the application data to check for references of a potential pop-up menu connected to this ID.
  - addMenuItemID
```
public void addMenuItemID(PhantomMenuItem mi,
                          String id)
```
    Adds a control with a control ID.
  - getControlFromID
```
public PhantomControl getControlFromID(String id)
```
    Gets a virtual control from a string ID. If the string ID is empty or the control not found, null is returned.
  - getMenu
```
public PhantomMenu getMenu(int index)
```
    Gets a pull-down menu from an index.
    Returns:
    null if no menu of this index is found.
  - getMenuItemFromID
```
public PhantomMenuItem getMenuItemFromID(String id)
```
    Gets a virtual control from a string ID. If the string ID is empty or the control not found, null is returned.
  - getIndexFromControlOrMenu
```
public int getIndexFromControlOrMenu(String id)
```
    Search for control or menu from a string ID.
    Returns:
    index of control or menu or -1 if not found.
  - getActionConnectedControlIndex
```
public int getActionConnectedControlIndex(String id)
```
    Search for an entry field or a list box with a control ID. The index of this control is returned, and used with push buttons or menu items (action connection).
  - isTextPromptRefreshRequired
```
public boolean isTextPromptRefreshRequired()
```
    Checks if the static text always needs updates.
  - getTitle
```
public String getTitle()
```
    Gets the title of this panel.
  - getControlCount
```
public int getControlCount()
```
    Gets the control count.
  - getControl
```
public PhantomControl getControl(int ii)
```
    Gets the control at a specific index.
  - isHostConnected
```
public boolean isHostConnected()
```
    Checks if the panel is host connected.
  - hasIndividualSize
```
public boolean hasIndividualSize()
```
    Checks if the panel has individual size.
  - getPanelFont
```
public int getPanelFont()
```
    Gets the panel font index.
  - getPanelColor
```
public se.entra.phantom.geditor.NPPColor getPanelColor()
```
    Gets the panel color index.
  - getWidth
```
public int getWidth()
```
    Gets the panel width in dialog coordinates (multiplied by 10).
  - getHeight
```
public int getHeight()
```
    Gets the panel height in dialog coordinates (multiplied by 10).
  - getDividerX
```
public int getDividerX()
```
    Gets the divider line position in X.
  - getDividerY
```
public int getDividerY()
```
    Gets the divider line position in Y.
  - isPopupWindow
```
public boolean isPopupWindow()
```
    Checks if the panel is of pop-up window type.
  - isNotebookPage
```
public boolean isNotebookPage()
```
    Checks if the panel is a notebook page.
  - hasSameLevelAsMain
```
public boolean hasSameLevelAsMain()
```
    Checks if the panel has the same Z-order level as a main panel.
  - areAllPFKeysPassedToHost
```
public boolean areAllPFKeysPassedToHost()
```
    Checks if a panel passes all PF keys to the host session (only for Gui-on-the-fly panels).
  - getOffsetX
```
public int getOffsetX()
```
    Gets the offset for a pop-up window panel in X.
  - getOffsetY
```
public int getOffsetY()
```
    Gets the offset for a pop-up window panel in Y.
  - getControls
```
public PhantomControl[] getControls()
```
    Gets the controls for this paneldata. Used by VirtualMenu class.
  - getMenus
```
public PhantomMenu[] getMenus()
```
    Gets the PhantomMenu's data. Used by VirtualMenu class.
  - getPopupMenus
```
public HashSet<PhantomPopupMenu> getPopupMenus()
```
    Gets the popupMenus connected to controls in panel.
  - getReferencedFiles
```
public void getReferencedFiles(ArrayList<String> files)
```
    Get all the files that are referenced by this panel.
  - getConnectedPopupMenus
```
public Iterator<PhantomPopupMenu> getConnectedPopupMenus()
```
    Get the enumeration of pop-up menus connected to this panel. The PhantomPanelData class gets all pop-up menus that are connected to control IDs. All other pop-up menus are discarded.
  - getConnectedPopupMenuArray
```
public PhantomPopupMenu[] getConnectedPopupMenuArray()
```
    Gets the array of pop-up menus connected to this panel.
  - getConnectedPopupMenuCount
```
public int getConnectedPopupMenuCount()
```
    Gets count of pop-up menus connected to this panel.
  - getNotebookPanelID
```
public String getNotebookPanelID()
```
    This method is only used when the panel is a notebook page. Returns the name of the panel that is specified to be the main panel containing this notebook page.
  - isGuiOnTheFlyPanel
```
public boolean isGuiOnTheFlyPanel()
```
    Checks if this virtual panel is created by the Gui-on-the-fly algorithm.
  - getMessageBoxes
```
public PhantomMessageBox[] getMessageBoxes()
```
    Gets the message boxes of the panel.
  - isSystemMessageBoxEnabled
```
public boolean isSystemMessageBoxEnabled()
```
    Checks if system message boxes should be displayed for this panel.
  - getSystemMessageBoxEnabled
```
public int getSystemMessageBoxEnabled()
```
    Gets the system message box enabled state: 0=disabled, 1=enabled, 2=from application.
  - getPanelType
```
public int getPanelType()
```
    Gets the panel data for xml writing.
  - getPanelTitle
```
public String getPanelTitle()
```
    Gets the panel data.
  - getPanelObjectName
```
public String getPanelObjectName()
```
    Gets the panel data.
  - getPanelScreen
```
public String getPanelScreen()
```
    Gets the panel data .
  - getPanelControlCount
```
public int getPanelControlCount()
```
    Gets the panel data.
  - getIconFile
```
public String getIconFile()
```
    Gets the icon file name.
  - getIconID
```
public int getIconID()
```
    Gets the iconId.
  - isNewStyle
```
public boolean isNewStyle()
```
    Checks if the panel is New Style for entry fields, combo boxes and spin buttons.
  - 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
  - addRecursiveControlReference
```
public boolean addRecursiveControlReference(PhantomControl pc)
```
    Checks if it's recursive control for references.
    Returns:
    true for success, false if it's recursing.
  - getNPObjectScreen
```
public String getNPObjectScreen()
```
    Gets the screen for this panel. If the screen is not specified and this is a notebook page, the notebook panel screen is used, if there is a notebook panel specified.
  - isReferencingPanelID
```
public boolean isReferencingPanelID(String panelID)
```
    Checks if this panel has references to a panel with the specified ID.
  - getReferencesPanelIDs
```
public HashSet<String> getReferencesPanelIDs()
```
    Gets the set of panel references, null for none. Do not modify HashSet.
  - containsNotebookPagePanel
```
public boolean containsNotebookPagePanel(String pageID)
```
    Checks if this panel contains a notebook that contains the panel page ID.

Class PhantomPanelData

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FLAG_INDSIZE

FLAG_SAMEASMAIN

FLAG_UNLOCKPOSCURSOR

FLAG_ALWAYSUPDATE

FLAG_MSGDISBASE

FLAG_MSGDISENABLE

FLAG_MSGDISDISABLE

FLAG_MSGDISALL

FLAG_RTL

FLAG_FONTSIZE

FLAG_PASSFKEYS

FLAG_NEW_STYLE

FLAG_SIZE10

PANTYPE_MAIN

PANTYPE_POPUP

PANTYPE_NBPAGE

DELPOPUP_NONE

DELPOPUP_CURRENT

DELPOPUP_ALL

panelCX

panelCY

panType

doUpdateOnHostChange

title

screen

objectName

isSizeIndependent

isApplicationPanel

panelColor

iconFile

iconID

doLeaveSecondaryPanelsEnabled

hasNoZOrder

hasNoPanelHostCursor

isDialogFrame

doRemoveAllPopupWindows

dividerX

dividerY

hasNoHostConnection

doRemovePopup

panelID

notebookID

flags

offsetX

offsetY

panelFont

menus

messageBoxes

controls

controlCount

application

hostData

controlIDs

menuItemIDs

hostScreen

object

popupMenus

Constructor Detail

PhantomPanelData

PhantomPanelData

Method Detail

rebind

save

save

setApplication

setHostData

setTitle

addMenu

addControl

equals

equalsPanel

equalsGuiOnTheFly

getApplicationData