se.entra.phantom.server

Class PhantomPopupMenu

java.lang.Object

se.entra.phantom.server.PhantomPopupMenu

public class PhantomPopupMenu
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
PhantomPopupMenu(PhantomFile file, PhantomApplicationData application, String id) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	getIndex() Gets the index of this pop-up menu.
String	getName() Gets the name (ID) of the pop-up menu.
PhantomPopupMenuItem[]	getPopupMenuItems() Gets the pop-up menu items.
void	load(PhantomFile file, PhantomApplicationData application, String id) Creates and loads the definition of a pop-up menu.
boolean	needsReload() Check if this file needs to be reloaded.
int	reload(boolean force) Reload internal state from external sources.
void	reloadObject() Reloads objects for the menu items.
void	resolveComponentReferences() Resolves references of all menu items to other panel components, after the panel has been loaded.
void	setApplication(PhantomApplicationData application) Set the runtime reference.
void	setIndex(int index) Sets the index of this pop-up menu.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

menuItems

public PhantomPopupMenuItem[] menuItems

The menu items.

connectedControls

public final HashSet<String> connectedControls

The hash table containing the connected controls (as key and value).

Constructor Detail

PhantomPopupMenu

public PhantomPopupMenu(PhantomFile file,
                PhantomApplicationData application,
                String id)
                 throws IOException

Constructor.

Parameters:

file -

application -

id -

Throws:

IOException

Method Detail

load

public void load(PhantomFile file,
        PhantomApplicationData application,
        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(boolean force)
           throws IOException

Reload internal state from external sources.

Parameters:

force - - force the reload.

Returns:

int

Throws:

IOException

setApplication

public void setApplication(PhantomApplicationData application)

Set the runtime reference.

Parameters:

rt -

reloadObject

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