se.entra.phantom.server

Class PhantomCGroupBox

java.lang.Object

se.entra.phantom.server.PhantomControl

se.entra.phantom.server.PhantomCGroupBox

All Implemented Interfaces:

Cloneable, PhantomControlFlags, PhantomControlType

public class PhantomCGroupBox
extends PhantomControl

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAG_3D Flag: 3D effect for drawing.
static int	FLAG_ALWAYSUPDATE Flag: always update text.
static int	FLAG_CENTER Flag: center.
static int	FLAG_MNEMONIC Flag: use mnemonics.
static int	FLAG_RIGHT Flag: right justify.
int	flags The control flags.
int	font Font index.
int	frameColor Frame color index.
boolean	isConnectedToNext Connect state to next control.
String	text The text prompt.

Fields inherited from class se.entra.phantom.server.PhantomControl

controlBase, controlColor, id, index, isBackgroundConverted, isForegroundConverted, object, panelData, popupMenu, tooltipText

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_UNKNOWN, CTRLTYPE_USER, 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
PhantomCGroupBox(PhantomFile data, PhantomPanelData panelData, int index, PhantomControlBase controlBase) Creates an instance of the control class.

Method Summary

Methods

Modifier and Type	Method and Description
int	getSaveSize() Get the size when saved to file.
boolean	isConnectToNextControlPropertySet() Checks if the option "Connect to next control" property is set.
boolean	isTextPromptRefreshRequired() Checks if the static text always needs updates.
void	rebind() Re-bind the panel data.
void	reloadObject() Reload object reference.
void	save(PhantomOutputFile file) Saves the instance to file.

Methods inherited from class se.entra.phantom.server.PhantomControl

addControlID, appendBaseTransaction, clone, create, getApplicationData, getBackgroundColor, getControlSize, getForegroundColor, getHostField, getHostFieldID, getID, getIndex, getObject, getObject, getPanelData, getReferencedFiles, isActionConnectedEnabled, processColorConversion, processColorConversion, processColorConversion, processDisabledBackground, resolveComponentReferences, saveBase, setBackgroundColor, setForegroundColor, setIndex, updateGuiOnTheFlyValue

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_3D

public static final int FLAG_3D

Flag: 3D effect for drawing.

See Also:

Constant Field Values

FLAG_RIGHT

public static final int FLAG_RIGHT

Flag: right justify.

See Also:

Constant Field Values

FLAG_CENTER

public static final int FLAG_CENTER

Flag: center.

See Also:

Constant Field Values

FLAG_ALWAYSUPDATE

public static final int FLAG_ALWAYSUPDATE

Flag: always update text.

See Also:

Constant Field Values

FLAG_MNEMONIC

public static final int FLAG_MNEMONIC

Flag: use mnemonics.

See Also:

Constant Field Values

font

public int font

Font index.

frameColor

public int frameColor

Frame color index.

isConnectedToNext

public boolean isConnectedToNext

Connect state to next control.

flags

public int flags

The control flags.

text

public String text

The text prompt.

Constructor Detail

PhantomCGroupBox

public PhantomCGroupBox(PhantomFile data,
                PhantomPanelData panelData,
                int index,
                PhantomControlBase controlBase)
                 throws IOException

Creates an instance of the control class. Loads the data from a Phantom Panel file that has previously been read into memory.

 Base:
  + font                USHORT
  + foregroundColor     BYTE
  + frameColor          BYTE
  + connectToNext       BYTE
  + flags               BYTE
  + text                ZTSTRING
 

Throws:

IOException - if an I/O error occurs.

Method Detail

save

public void save(PhantomOutputFile file)
          throws IOException

Saves the instance to file.

 Base:
  + font                USHORT
  + foregroundColor     BYTE
  + frameColor          BYTE
  + connectToNext       BYTE
  + flags               BYTE
  + text                ZTSTRING
 

Specified by:

save in class PhantomControl

Parameters:

file -

Throws:

IOException - if an I/O error occurs.

getSaveSize

public int getSaveSize()

Get the size when saved to file.

Specified by:

getSaveSize in class PhantomControl

rebind

public void rebind()

Re-bind the panel data.

Overrides:

rebind in class PhantomControl

reloadObject

public void reloadObject()

Reload object reference.

Specified by:

reloadObject in class PhantomControl

isTextPromptRefreshRequired

public boolean isTextPromptRefreshRequired()

Checks if the static text always needs updates.

isConnectToNextControlPropertySet

public boolean isConnectToNextControlPropertySet()

Checks if the option "Connect to next control" property is set.