se.entra.phantom.server

Class PhantomMessageBox

java.lang.Object

se.entra.phantom.server.PhantomMessageBox

All Implemented Interfaces:

Cloneable

public class PhantomMessageBox
extends Object
implements Cloneable

This class loads the message box definition from the Phantom Panel file.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	doNewMessageAfterSendKey Flag causes a new message after each send key.
boolean	doTranslate Flag to use translation table before displaying the message.
boolean	doUpdate Flag to update message box with new data for each host change.
PhantomHostField	hostField The host field (may be null if the panel doesn't have a screen name).
String	hostFieldName The host field name.
int	icon The selected icon in (client format, defined in NetPhantomConstants).
static int	ICON_CRITICAL Critical icon.
static int	ICON_INFORMATION Information icon.
static int	ICON_WARNING Warning icon.
boolean	is5250SystemMessage This flag indicates it is a host field that only displays information during the 5250 error state.
PhantomObject	object The connected object.
String	objectName The name of the connected object.

Constructor Summary

Constructors

Constructor and Description
PhantomMessageBox(PhantomFile file, PhantomPanelData panel) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Checks if two message boxes are equal.
void	load(PhantomFile file, PhantomPanelData panel) Loads the message box definition from the Phantom Panel file.
void	save(PhantomOutputFile file) Saves the message box definition to 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

ICON_INFORMATION

public static final int ICON_INFORMATION

Information icon.

See Also:

Constant Field Values

ICON_WARNING

public static final int ICON_WARNING

Warning icon.

See Also:

Constant Field Values

ICON_CRITICAL

public static final int ICON_CRITICAL

Critical icon.

See Also:

Constant Field Values

icon

public int icon

The selected icon in (client format, defined in NetPhantomConstants).

hostFieldName

public String hostFieldName

The host field name.

hostField

public PhantomHostField hostField

The host field (may be null if the panel doesn't have a screen name).

doUpdate

public boolean doUpdate

Flag to update message box with new data for each host change.

doTranslate

public boolean doTranslate

Flag to use translation table before displaying the message.

doNewMessageAfterSendKey

public boolean doNewMessageAfterSendKey

Flag causes a new message after each send key.

is5250SystemMessage

public boolean is5250SystemMessage

This flag indicates it is a host field that only displays information during the 5250 error state.

objectName

public String objectName

The name of the connected object.

object

public PhantomObject object

The connected object.

Constructor Detail

PhantomMessageBox

public PhantomMessageBox(PhantomFile file,
                         PhantomPanelData panel)
                  throws IOException

Constructor.

Throws:

IOException

Method Detail

load

public void load(PhantomFile file,
                 PhantomPanelData panel)
          throws IOException

Loads the message box definition from the Phantom Panel file.

 Base:
  + icon                      BYTE
  + hostField                 BYTE [9]
  + reserved                  BYTE [4]
  + doUpdate                  BYTE
  + doTranslate               BYTE
  + doNewMessageAfterSendKey  BYTE
  + is5250SystemMessage       BYTE
  + object                    BYTE [9]
  + reserved                  BYTE [3]
 

Throws:

IOException - if an I/O error occurs.

save

public void save(PhantomOutputFile file)
          throws IOException

Saves the message box definition to the Phantom Panel file.

 Base:
  + icon                      BYTE
  + hostField                 BYTE [9]
  + reserved                  BYTE [4]
  + doUpdate                  BYTE
  + doTranslate               BYTE
  + doNewMessageAfterSendKey  BYTE
  + is5250SystemMessage       BYTE
  + object                    BYTE [9]
  + reserved                  BYTE [3]
 

Parameters:

file - the open file to write to.

Throws:

IOException - if an I/O error occurs.

updateReferences

public void updateReferences(ApplicationReferences refs)

Updates the Applications References instance.

equals

public boolean equals(Object o)

Checks if two message boxes are equal.

Overrides:

equals in class Object