PhantomPopupMenu (NetPhantom® 8.0 Java API Specification)

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

All Implemented Interfaces:
Cloneable, IENPObjectOwner, INPObjects
```
public class PhantomPopupMenu
extends Object
implements Cloneable, INPObjects, IENPObjectOwner
```
Loads the PhantomPopupMenu data and checks for external references in its menu item text prompts. If such references exist (i.e. to global variables @=GLOBVAR@, special variables @**VARIABLE@ or to host fields @HOSTFIELD@, but not to text IDs @*TEXTID@) then the text prompt must be transmitted to the NetPhantom Client at every host refresh.
The VirtualRuntime will also set the "dirty" flag for all text prompts containing text file references in the case of a change of the text file.

Field Summary
Fields
Modifier and Type Field and Description
HashSet<String> connectedControls
The hash table containing the connected controls (as key and value).
PhantomPopupMenuItem[] menuItems
The menu items.

Fields
Modifier and Type	Field and Description
`HashSet<String>`	`connectedControls` The hash table containing the connected controls (as key and value).
`PhantomPopupMenuItem[]`	`menuItems` The menu items.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Checks if two menu items are equal.
`ENPRootObject`	`getCachedNPObject()` Gets the cached NPObject root.
`int`	`getIndex()` Gets the index of this pop-up menu.
`String`	`getName()` Gets the name (ID) of the pop-up menu.
`ENPRootObject`	`getNPObject()` Gets the NPObjects for the host data.
`String`	`getNPObjectName()` Gets the NP Object file name in the project application directory.
`PhantomObject`	`getObject()` Gets the associated Phantom Object.
`PhantomPopupMenuItem[]`	`getPopupMenuItems()` Gets the pop-up menu items.
`ArrayList<FileError>`	`getUpdatedErrors()` For the Editor, checks for a change in the error list of this instance.
`void`	`load(PhantomFile file, PhantomRuntime runtime, String id)` Creates and loads the definition of a pop-up menu.
`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 appData)` Reloads objects for the menu items.
`int`	`reload()` Reload internal state from external sources.
`void`	`resolveComponentReferences()` Resolves references of all menu items to other panel components, after the panel has been loaded.
`void`	`save(String fileName)` Saves the file.
`void`	`setIndex(int index)` Sets the index of this pop-up menu.
`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
  - menuItems
```
public PhantomPopupMenuItem[] menuItems
```
    The menu items.
  - connectedControls
```
public HashSet<String> connectedControls
```
    The hash table containing the connected controls (as key and value).
- Method Detail
  - getObject
```
public PhantomObject getObject()
```
    Gets the associated Phantom Object.
  - load
```
public void load(PhantomFile file,
                 PhantomRuntime runtime,
                 String id)
          throws IOException
```
    Creates and loads the definition of a pop-up menu.
    Throws:
    IOException - if an I/O error occurs.
  - needsReload
```
public boolean needsReload()
```
    Check if this file needs to be reloaded.
    Returns:
    boolean
  - getName
```
public String getName()
```
    Gets the name (ID) of the pop-up menu.
  - setIndex
```
public void setIndex(int index)
```
    Sets the index of this pop-up menu. This means that a control ID somewhere in the application refers to this pop-up menu.
  - getIndex
```
public int getIndex()
```
    Gets the index of this pop-up menu. If a pop-up menu isn't referenced anywhere in the application, -1 is returned.
    Note: The PhantomApplicationData class will discard all pop-up menus after they are loaded, if they aren't referenced anywhere in the application (index = -1).
    Returns:
    -1 if the pop-up menu isn't referenced, i.e. has no index.
  - reload
```
public int reload()
           throws MaybeIOException
```
    Reload internal state from external sources.
    Throws:
    MaybeIOException
  - rebind
```
public void rebind(PhantomApplicationData appData)
            throws IOException
```
    Reloads objects for the menu items.
    Throws:
    IOException
  - resolveComponentReferences
```
public void resolveComponentReferences()
```
    Resolves references of all menu items to other panel components, after the panel has been loaded.
  - getPopupMenuItems
```
public PhantomPopupMenuItem[] getPopupMenuItems()
```
    Gets the pop-up menu items.
  - equals
```
public boolean equals(Object o)
```
    Checks if two menu items are equal.
    Overrides:
    equals in class Object
  - save
```
public void save(String fileName)
          throws IOException
```
    Saves the file.
    Parameters:
    fileName - The file name.
    Throws:
    IOException - For I/O errors.
  - updateReferences
```
public void updateReferences(ApplicationReferences refs)
```
    Updates the Applications References instance.
  - getUpdatedErrors
```
public ArrayList<FileError> getUpdatedErrors()
```
    For the Editor, checks for a change in the error list of this instance.
    Returns:
    null for no errors or no change, i.e. nothing to report to Eclipse.
  - 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 host data.
    Specified by:
    getNPObject in interface INPObjects

Class PhantomPopupMenu

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

menuItems

connectedControls

Method Detail

getObject

load

needsReload

getName

setIndex

getIndex

reload

rebind

resolveComponentReferences

getPopupMenuItems

equals

save

updateReferences

getUpdatedErrors

getNPObjectName

onENPObjectInvalidated

getCachedNPObject

getNPObject