public class PhantomPanelData extends Object implements Cloneable, PhantomControlType, INPObjects, IENPObjectOwner
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.
|
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 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.
|
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.
|
public static final int FLAG_INDSIZE
public static final int FLAG_SAMEASMAIN
public static final int FLAG_UNLOCKPOSCURSOR
public static final int FLAG_ALWAYSUPDATE
public static final int FLAG_MSGDISBASE
public static final int FLAG_MSGDISENABLE
public static final int FLAG_MSGDISDISABLE
public static final int FLAG_MSGDISALL
public static final int FLAG_RTL
public static final int FLAG_FONTSIZE
public static final int FLAG_PASSFKEYS
public static final int FLAG_NEW_STYLE
public static final int FLAG_SIZE10
public static final int PANTYPE_MAIN
public static final int PANTYPE_POPUP
public static final int PANTYPE_NBPAGE
public static final int DELPOPUP_NONE
public static final int DELPOPUP_CURRENT
public static final int DELPOPUP_ALL
public int panelCX
public int panelCY
public int panType
public boolean doUpdateOnHostChange
public String title
public String screen
public String objectName
public boolean isSizeIndependent
public boolean isApplicationPanel
public se.entra.phantom.geditor.NPPColor panelColor
public String iconFile
public int iconID
public boolean doLeaveSecondaryPanelsEnabled
public boolean hasNoZOrder
public boolean hasNoPanelHostCursor
public boolean isDialogFrame
public boolean doRemoveAllPopupWindows
public int dividerX
public int dividerY
public boolean hasNoHostConnection
public boolean doRemovePopup
public String panelID
public String notebookID
public int flags
public int offsetX
public int offsetY
public int panelFont
public PhantomMenu[] menus
public PhantomMessageBox[] messageBoxes
public PhantomControl[] controls
public int controlCount
public PhantomApplicationData application
public PhantomHostData hostData
public Hashtable<String,PhantomControl> controlIDs
public Hashtable<String,PhantomMenuItem> menuItemIDs
public PhantomHostScreen hostScreen
public PhantomObject object
public HashSet<PhantomPopupMenu> popupMenus
public PhantomPanelData(PhantomHostData hostData, PhantomApplicationData application, PhantomFile file) throws IOException
IOException
public PhantomPanelData(PhantomApplicationData application, PhantomHostScreen hostScreen, PhantomPanelData basePanel, String heading, int panelCX, int panelCY, boolean isPopupWindow)
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.
public void rebind(PhantomApplicationData applicationData, PhantomHostData hostData) throws IOException
IOException
public void save(String fileName) throws IOException
fileName
- The file name.IOException
- if an I/O error occurs.public void save(String fileName, boolean isNetPhantom5) throws IOException
fileName
- The file name.isNetPhantom5
- Flag for NetPhantom 5.IOException
- if an I/O error occurs.public void setApplication(PhantomApplicationData rt)
rt
- public void setHostData(PhantomHostData hd)
hd
- public void setTitle(String title)
title
- The new title for the panel.public void addMenu(PhantomMenu menu)
public void addControl(PhantomControl pc)
public boolean equals(Object o)
equalsPanel(o)
.public boolean equalsPanel(PhantomPanelData p)
public boolean equalsGuiOnTheFly(PhantomPanelData panel)
public PhantomApplicationData getApplicationData()
public int reload() throws IOException
IOException
public boolean needsReload()
public PhantomHostScreen getHostScreen()
public String getHostScreenName()
public PhantomHostField getHostField(String fieldName)
public PhantomObject getObject()
public PhantomObject getObject(String objectName, String referer) throws IOException
IOException
- if the object is not found in the applicationpublic boolean isMainPanel()
public boolean isPopupRemoved()
public boolean areAllPopupsRemoved()
public boolean isCursorPositionedAtHostUnlock()
public boolean getNoHostConnection()
public boolean getNoPanelHostCursor()
public String getPanelID()
public boolean isDialogFrame()
public void addControlID(PhantomControl c, String id)
public void addMenuItemID(PhantomMenuItem mi, String id)
public PhantomControl getControlFromID(String id)
public PhantomMenu getMenu(int index)
public PhantomMenuItem getMenuItemFromID(String id)
public int getIndexFromControlOrMenu(String id)
public int getActionConnectedControlIndex(String id)
public boolean isTextPromptRefreshRequired()
public String getTitle()
public int getControlCount()
public PhantomControl getControl(int ii)
public boolean isHostConnected()
public boolean hasIndividualSize()
public int getPanelFont()
public se.entra.phantom.geditor.NPPColor getPanelColor()
public int getWidth()
public int getHeight()
public int getDividerX()
public int getDividerY()
public boolean isPopupWindow()
public boolean isNotebookPage()
public boolean hasSameLevelAsMain()
public boolean areAllPFKeysPassedToHost()
public int getOffsetX()
public int getOffsetY()
public PhantomControl[] getControls()
public PhantomMenu[] getMenus()
public HashSet<PhantomPopupMenu> getPopupMenus()
public void getReferencedFiles(ArrayList<String> files)
public Iterator<PhantomPopupMenu> getConnectedPopupMenus()
public PhantomPopupMenu[] getConnectedPopupMenuArray()
public int getConnectedPopupMenuCount()
public String getNotebookPanelID()
public boolean isGuiOnTheFlyPanel()
public PhantomMessageBox[] getMessageBoxes()
public boolean isSystemMessageBoxEnabled()
public int getSystemMessageBoxEnabled()
public int getPanelType()
public String getPanelTitle()
public String getPanelObjectName()
public String getPanelScreen()
public int getPanelControlCount()
public String getIconFile()
public int getIconID()
public boolean isNewStyle()
public void updateReferences(ApplicationReferences refs)
public String getNPObjectName()
getNPObjectName
in interface INPObjects
public void onENPObjectInvalidated()
onENPObjectInvalidated
in interface IENPObjectOwner
public ENPRootObject getCachedNPObject()
getCachedNPObject
in interface INPObjects
public ENPRootObject getNPObject()
getNPObject
in interface INPObjects
public boolean addRecursiveControlReference(PhantomControl pc)
public String getNPObjectScreen()
public boolean isReferencingPanelID(String panelID)
public HashSet<String> getReferencesPanelIDs()
public boolean containsNotebookPagePanel(String pageID)
Phantom® and NetPhantom® are registered trademarks of Mindus SARL.
© © Mindus SARL, 2024. All rights reserved.