PhantomMenu (NetPhantom® 8.0 Java API Specification)

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

All Implemented Interfaces:
Cloneable
```
public class PhantomMenu
extends Object
implements Cloneable
```
This class loads the menu definition from the Phantom Panel file.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FLAG_ALWAYSUPDATE` Always update the text.
`static int`	`FLAG_DISABLE` Disable from start.
`static int`	`FLAG_NODISABLE` Don't disable for host field.
`static int`	`FLAG_TEXTIDSTRING` Text ID string
`int`	`index` The index of this menu.
`PhantomMenuItem[]`	`menuItems` The menu items.
`PhantomPanelData`	`panelData` The panel data.
`String`	`text` The text of the menu.
`String`	`tooltipText` The tool-tip text connected to the menu item.

Constructor Summary
Constructors
Constructor and Description
PhantomMenu(PhantomPanelData panelData, int index, PhantomMenuItem[] menuItems, String text)
Creates a menu for Gui-on-the-fly.

Constructors
Constructor and Description
`PhantomMenu(PhantomPanelData panelData, int index, PhantomMenuItem[] menuItems, String text)` Creates a menu for Gui-on-the-fly.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Checks if two menus are equal.
`PhantomMenuItem[]`	`getMenuItems()` Gets menu items for this menu, returns MenuItems[]
`int`	`getSaveSize()` Calculates the size of the object when saved to file.
`void`	`rebind(PhantomApplicationData appData)` 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`	`save(PhantomOutputFile file)` Saves the menu definition from the Phantom Panel file.
`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_NODISABLE
```
public static final int FLAG_NODISABLE
```
    Don't disable for host field.
    See Also:
    Constant Field Values
  - FLAG_ALWAYSUPDATE
```
public static final int FLAG_ALWAYSUPDATE
```
    Always update the text.
    See Also:
    Constant Field Values
  - FLAG_DISABLE
```
public static final int FLAG_DISABLE
```
    Disable from start.
    See Also:
    Constant Field Values
  - FLAG_TEXTIDSTRING
```
public static final int FLAG_TEXTIDSTRING
```
    Text ID string
    See Also:
    Constant Field Values
  - text
```
public String text
```
    The text of the menu.
  - menuItems
```
public PhantomMenuItem[] menuItems
```
    The menu items.
  - panelData
```
public PhantomPanelData panelData
```
    The panel data.
  - index
```
public int index
```
    The index of this menu.
  - tooltipText
```
public String tooltipText
```
    The tool-tip text connected to the menu item.
- Constructor Detail
  - PhantomMenu
```
public PhantomMenu(PhantomPanelData panelData,
                   int index,
                   PhantomMenuItem[] menuItems,
                   String text)
```
    Creates a menu for Gui-on-the-fly.
- Method Detail
  - save
```
public void save(PhantomOutputFile file)
          throws IOException
```
    Saves the menu definition from the Phantom Panel file.
```
 Base:
  + Text                    BYTE [32]
  + Count of menu items     USHORT
  + Reserved                BYTE [16]
 
```
    Parameters:
    file - the open file to write the dfinition to.
    Throws:
    IOException - if an I/O error occurs.
  - getSaveSize
```
public int getSaveSize()
```
    Calculates the size of the object when saved to file.
    Returns:
    int.
  - 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.
  - getMenuItems
```
public PhantomMenuItem[] getMenuItems()
```
    Gets menu items for this menu, returns MenuItems[]
  - updateReferences
```
public void updateReferences(ApplicationReferences refs)
```
    Updates the Applications References instance.
  - equals
```
public boolean equals(Object o)
```
    Checks if two menus are equal.
    Overrides:
    equals in class Object

Class PhantomMenu

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FLAG_NODISABLE

FLAG_ALWAYSUPDATE

FLAG_DISABLE

FLAG_TEXTIDSTRING

text

menuItems

panelData

index

tooltipText

Constructor Detail

PhantomMenu

Method Detail

save

getSaveSize

rebind

resolveComponentReferences

getMenuItems

updateReferences

equals