se.entra.phantom.server

Class PhantomControlBase

java.lang.Object

se.entra.phantom.server.PhantomControlBase

All Implemented Interfaces:

Cloneable, PhantomControlFlags, PhantomControlType

public class PhantomControlBase
extends Object
implements PhantomControlType, PhantomControlFlags, Cloneable

This class loads the control definition from the Phantom Panel file.

Field Summary

Fields

Modifier and Type	Field and Description
int	cx Width.
int	cy Height.
int	dataLength Length of control specific data.
int	flags Control flags.
int	type Type.
int	x Position in X.
int	y Position in Y.

Fields inherited from interface se.entra.phantom.server.PhantomControlType

CTRLTYPE_BUTTON, CTRLTYPE_CHECK, CTRLTYPE_COMBO, CTRLTYPE_FRAME, CTRLTYPE_GRAPH, CTRLTYPE_GROUP, CTRLTYPE_INOUT, CTRLTYPE_LIST, CTRLTYPE_MLE, CTRLTYPE_NOTE, CTRLTYPE_OUT, CTRLTYPE_RADIO, CTRLTYPE_RECT, CTRLTYPE_SPIN, CTRLTYPE_SUB, CTRLTYPE_TEXT, CTRLTYPE_TREE, CTRLTYPE_UNKNOWN, CTRLTYPE_USER, CTRLTYPES_COUNT, names

Fields inherited from interface se.entra.phantom.server.PhantomControlFlags

CTRLFLAG_MOVEX, CTRLFLAG_MOVEY, CTRLFLAG_NEWGROUP, CTRLFLAG_SIZEX, CTRLFLAG_SIZEY, CTRLFLAG_SUBWIN, CTRLFLAG_TABSTOP, CTRLFLAG_TRANSPARENT

Constructor Summary

Constructors

Constructor and Description
PhantomControlBase(int x, int y, int cx, int cy, int type) Creates a Gui-on-the-fly control base.
PhantomControlBase(PhantomFile file) Loads the control base definition from the Phantom Panel file.

Method Summary

Modifier and Type	Method and Description
void	appendBaseTransaction(Transaction trans) Appends the basic control data to the create transaction to the client (flags, x, y, cx, cy).
protected PhantomControlBase	clone() Makes a clone of a PhantomControlBase instance.
boolean	equals(Object o) Checks if two control base's are equal.
String	getTypeDescription() Gets the type description of this control in "English", such as "Notebook" or "Push Button".
void	save(PhantomOutputFile file) Saves the control base definition to the Phantom Panel file.
void	updateGuiOnTheFlyValue(CRC32 crc32) Updates the CRC32 value of a Gui-on-the-fly value with the control's base data.

Methods inherited from class java.lang.Object

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

Field Detail

x

public int x

Position in X.

y

public int y

Position in Y.

cx

public int cx

Width.

cy

public int cy

Height.

type

public int type

Type.

flags

public int flags

Control flags.

dataLength

public int dataLength

Length of control specific data.

Constructor Detail

PhantomControlBase

public PhantomControlBase(PhantomFile file)
                   throws IOException

Loads the control base definition from the Phantom Panel file.

 Base:
  + x                   SHORT
  + y                   SHORT
  + cx                  SHORT
  + cy                  SHORT
  + typeAndFlags        BYTE
  + flags               BYTE
  + dataLength          USHORT
  + skip data pointer   ULONG
 

Throws:

IOException - if an I/O error occurs.

PhantomControlBase

public PhantomControlBase(int x,
                          int y,
                          int cx,
                          int cy,
                          int type)

Creates a Gui-on-the-fly control base. The members of the base data are all public, why this constructor doesn't have any parameters.

Method Detail

save

public void save(PhantomOutputFile file)
          throws IOException

Saves the control base definition to the Phantom Panel file.

 Base:
  + x                   SHORT
  + y                   SHORT
  + cx                  SHORT
  + cy                  SHORT
  + typeAndFlags        BYTE
  + flags               BYTE
  + dataLength          USHORT
  + skip data pointer   ULONG
 

Parameters:

file - the open file to write to.

Throws:

IOException - if an I/O error occurs.

updateGuiOnTheFlyValue

public void updateGuiOnTheFlyValue(CRC32 crc32)

Updates the CRC32 value of a Gui-on-the-fly value with the control's base data.

appendBaseTransaction

public void appendBaseTransaction(Transaction trans)

Appends the basic control data to the create transaction to the client (flags, x, y, cx, cy).

clone

protected PhantomControlBase clone()

Makes a clone of a PhantomControlBase instance.

Overrides:

clone in class Object

Returns:

A new instance that is identically to the current instance.

getTypeDescription

public String getTypeDescription()

Gets the type description of this control in "English", such as "Notebook" or "Push Button".

equals

public boolean equals(Object o)

Checks if two control base's are equal. Check with the dataLength is not done.

Overrides:

equals in class Object