se.entra.phantom.server

Class PhantomMenuItem

java.lang.Object

se.entra.phantom.server.PhantomMenuItem

Direct Known Subclasses:

PhantomPopupMenuItem

public class PhantomMenuItem
extends Object

This class loads the menu item definition from the Phantom Panel file.

Field Summary

Fields

Modifier and Type	Field and Description
int	actionKey The action key for the menu item.
String	connectedControlID The ID of the connected control.
boolean	doLockPanel Flag for locking the panel when menu item is selected.
boolean	doSkipEnableCheck Flag indicating that no check should be done to disable the menu item for connected controls.
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	flags The flags for the menu item.
boolean	hasFunctionality This flag indicates that the menu item has no functional implementation, because it has no ID, object, host field name, send string, send key and no next panel.
boolean	hasSeparator Flag for separator before menu item.
PhantomHostField	hostField The host field reference, might be null.
String	hostFieldName The name of the host field.
String	id The ID of the menu item.
int	index The index of this menu item.
boolean	isStringTextID Flag indicates that the send string is a text ID.
String	nextPanel The name of the next panel.
PhantomObject	object The object reference.
String	objectName The name of the connected object.
PhantomPanelData	panelData Store reference to panel data or null if none.
static int	SAVE_SIZE Text ID string
int	sendKey The send key to host.
String	sendString The send string for the menu item.
int	subMenuCount The number of submenu items.
String	text Text for menu item.
String	tooltipText The tool-tip text connected to the menu item.

Constructor Summary

Constructors

Constructor and Description
PhantomMenuItem(PhantomApplicationData application, PhantomPanelData panelData, PhantomFile file, int index) Loads the submenu definition from the Phantom Panel file.
PhantomMenuItem(PhantomPanelData panelData, int index, String text, int sendKey) Constructor for GUI-on-the-fly.

Method Summary

Methods

Modifier and Type	Method and Description
int	getConnectedControlIndex(PhantomPanelData panelData) Gets the connected control.
String	getID() Gets the referenced object.
PhantomObject	getObject() Gets the referenced object.
String	getSendString(VirtualRuntime runtime) Get send string, eventually from text file.
boolean	isDisabledFromStart() Checks if the menu item should be disabled from start.
boolean	isStateHostConnected() Checks if the push button is state-connected to the host field.
boolean	isTextPromptRefreshRequired() Checks if the static text always needs updates.
void	reloadObject() Reload object reference.
void	resolveComponentReferences() Resolves reference of this menu item to other panel component, after the panel has been loaded.
void	save(PhantomOutputFile file) Saves the sub-menu definition from the Phantom Panel file.

Methods inherited from class java.lang.Object

clone, equals, 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

SAVE_SIZE

public static final int SAVE_SIZE

Text ID string

See Also:

Constant Field Values

panelData

public PhantomPanelData panelData

Store reference to panel data or null if none.

text

public String text

Text for menu item.

id

public String id

The ID of the menu item.

objectName

public String objectName

The name of the connected object.

object

public PhantomObject object

The object reference.

nextPanel

public String nextPanel

The name of the next panel.

hasSeparator

public boolean hasSeparator

Flag for separator before menu item.

connectedControlID

public String connectedControlID

The ID of the connected control.

hostFieldName

public String hostFieldName

The name of the host field.

hostField

public PhantomHostField hostField

The host field reference, might be null.

sendString

public String sendString

The send string for the menu item.

actionKey

public int actionKey

The action key for the menu item.

sendKey

public int sendKey

The send key to host.

doSkipEnableCheck

public boolean doSkipEnableCheck

Flag indicating that no check should be done to disable the menu item for connected controls.

doLockPanel

public boolean doLockPanel

Flag for locking the panel when menu item is selected.

subMenuCount

public int subMenuCount

The number of submenu items.

flags

public int flags

The flags for the menu item.

index

public int index

The index of this menu item.

isStringTextID

public boolean isStringTextID

Flag indicates that the send string is a text ID.

hasFunctionality

public boolean hasFunctionality

This flag indicates that the menu item has no functional implementation, because it has no ID, object, host field name, send string, send key and no next panel.

tooltipText

public String tooltipText

The tool-tip text connected to the menu item.

Constructor Detail

PhantomMenuItem

public PhantomMenuItem(PhantomApplicationData application,
               PhantomPanelData panelData,
               PhantomFile file,
               int index)
                throws IOException

Loads the submenu definition from the Phantom Panel file. If the parameter panelData is null, the menu item ID is not added to the panel in its hashtable. This is used for PhantomPopupMenuItems.

 Base:
  + text                       BYTE [32]
  + id                         BYTE [9]
  + object                     BYTE [9]
  + nextPanel                  BYTE [9]
  + Skip UpdateFld             BYTE
  + hasSeparator               BYTE
  + connectedControlID         BYTE [9]
  + hostField                  BYTE [9]
  + sendString                 BYTE [32]
  + actionKey                  USHORT
  + sendKey                    USHORT
  + Skip (font+default+color)  BYTE [4]
  + doSkipEnableCheck          BYTE
  + doLockPanel                BYTE
  + Skip bitmap                BYTE
  + subMenuCount               BYTE
  + Reserved                   BYTE [7]
 

Throws:

IOException - if an I/O error occurs.

PhantomMenuItem

public PhantomMenuItem(PhantomPanelData panelData,
               int index,
               String text,
               int sendKey)

Constructor for GUI-on-the-fly.

Method Detail

save

public void save(PhantomOutputFile file)
          throws IOException

Saves the sub-menu definition from the Phantom Panel file.

 Base:
  + text                       BYTE [32]
  + id                         BYTE [9]
  + object                     BYTE [9]
  + nextPanel                  BYTE [9]
  + Skip UpdateFld             BYTE
  + hasSeparator               BYTE
  + connectedControlID         BYTE [9]
  + hostField                  BYTE [9]
  + sendString                 BYTE [32]
  + actionKey                  USHORT
  + sendKey                    USHORT
  + Skip (font+default+color)  BYTE [4]
  + doSkipEnableCheck          BYTE
  + doLockPanel                BYTE
  + Skip bitmap                BYTE
  + subMenuCount               BYTE
  + Reserved                   BYTE [7]
 

Parameters:

file - the already opened file to write to.

Throws:

IOException - if an I/O error occurs.

isTextPromptRefreshRequired

public boolean isTextPromptRefreshRequired()

Checks if the static text always needs updates.

isStateHostConnected

public boolean isStateHostConnected()

Checks if the push button is state-connected to the host field.

isDisabledFromStart

public boolean isDisabledFromStart()

Checks if the menu item should be disabled from start.

Returns:

true if the menu item should be disabled from start, false otherwise.

resolveComponentReferences

public void resolveComponentReferences()

Resolves reference of this menu item to other panel component, after the panel has been loaded. The specified control ID is controlling disable/enable of this menu item. Example of control types are list box and entry fields.

getSendString

public String getSendString(VirtualRuntime runtime)

Get send string, eventually from text file. In the case of an error, an event is logged.

Returns:

text string or null for error.

getID

public String getID()

Gets the referenced object.

getObject

public PhantomObject getObject()

Gets the referenced object.

reloadObject

public void reloadObject()
                  throws IOException

Reload object reference.

Throws:

IOException

getConnectedControlIndex

public int getConnectedControlIndex(PhantomPanelData panelData)

Gets the connected control.

Returns:

-1 if no connection exists and (>=0 if connected to a control).