se.entra.phantom.server

Class PhantomCStaticText

java.lang.Object

se.entra.phantom.server.PhantomControl

se.entra.phantom.server.PhantomCStaticText

All Implemented Interfaces:

Cloneable, PhantomControlFlags, PhantomControlType

public class PhantomCStaticText
extends PhantomControl

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

Field Summary

Fields

Modifier and Type	Field and Description
int	clientFlags The flags passed on to the client.
static int	FLAG_ALWAYSUPDATE Always update text.
static int	FLAG_CONNECTTONEXT Flag: connect state to next control.
static int	FLAG_HTML HTML text.
static int	FLAG_ID ID is present.
static int	FLAG_MNEMONIC Flag: use mnemonics.
int	flags The control flags.
int	font Font index.
boolean	isMultiLine Flag for multiple lines.
int	justification Justification (0x00=left, 0x01=horizontal center, 0x02=right) together with the flags (0x00=top, 0x04=vertical center, 0x08=bottom).
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_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
PhantomCStaticText(PhantomFile data) Creates an instance of the control class for the Designer control.
PhantomCStaticText(PhantomFile data, PhantomPanelData panelData, int index, PhantomControlBase controlBase) Creates an instance of the control class.
PhantomCStaticText(PhantomPanelData panelData, PhantomControlBase controlBase, boolean isRightJustified, String text) Creates an static text control for Gui-on-the-fly.

Method Summary

Modifier and Type	Method and Description
protected void	addNPObjects(ENPObject obj) Gets the NPObject for the control.
protected boolean	equalsControl(PhantomControl c) Checks for control equality.
int	getDataSize(PhantomOutputFile outputFile) 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	reinitliazeClientFlags() Reinitializes the clientFlags internally from the flags.
void	reloadObject() Reload object reference.
void	save(PhantomOutputFile data) Saves the control to the indicated file.
void	updateGuiOnTheFlyValue(CRC32 crc32) Updates the CRC32 value of a Gui-on-the-fly value with the control's base data.
void	updateReferences(ApplicationReferences refs) Updates the Applications References instance.

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

addControlID, addControlReference, addHostFieldReference, appendBaseTransaction, checkTextPromptReferences, checkTextPromptReferences, clone, create, createNPObject, equals, getApplicationData, getBackgroundColor, getControlObjectID, getDesignerControl, getForegroundColor, getHostField, getHostFieldID, getID, getIndex, getNPObjectExtra, getNPObjectID, getObject, getObject, getPanelData, getReferencedFiles, getTypeDescription, getTypeDescriptionID, initializeDesignerControls, isActionConnectedEnabled, processColorConversion, processColorConversion, processColorConversion, processDisabledBackground, resolveComponentReferences, saveBase, setBackgroundColor, setForegroundColor, setIndex

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_CONNECTTONEXT

public static final int FLAG_CONNECTTONEXT

Flag: connect state to next control.

See Also:

Constant Field Values

FLAG_MNEMONIC

public static final int FLAG_MNEMONIC

Flag: use mnemonics.

See Also:

Constant Field Values

FLAG_ALWAYSUPDATE

public static final int FLAG_ALWAYSUPDATE

Always update text.

See Also:

Constant Field Values

FLAG_ID

public static final int FLAG_ID

ID is present.

See Also:

Constant Field Values

FLAG_HTML

public static final int FLAG_HTML

HTML text.

See Also:

Constant Field Values

isMultiLine

public boolean isMultiLine

Flag for multiple lines.

justification

public int justification

Justification (0x00=left, 0x01=horizontal center, 0x02=right) together with the flags (0x00=top, 0x04=vertical center, 0x08=bottom).

font

public int font

Font index.

flags

public int flags

The control flags.

text

public String text

The text prompt.

clientFlags

public int clientFlags

The flags passed on to the client.

Constructor Detail

PhantomCStaticText

public PhantomCStaticText(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:
  + isMultiLine         BYTE
  + justification       BYTE
  + font                USHORT
  + foregroundColor     BYTE
  + flags               BYTE
  + backgroundColor     BYTE
  + reserved            BYTE
  + text                ZTSTRING
 

Throws:

IOException - if an I/O error occurs.

PhantomCStaticText

public PhantomCStaticText(PhantomFile data)
                   throws IOException

Creates an instance of the control class for the Designer control.

Throws:

IOException - if an I/O error occurs.

PhantomCStaticText

public PhantomCStaticText(PhantomPanelData panelData,
                          PhantomControlBase controlBase,
                          boolean isRightJustified,
                          String text)

Creates an static text control for Gui-on-the-fly.

Method Detail

reinitliazeClientFlags

public void reinitliazeClientFlags()

Reinitializes the clientFlags internally from the flags. This method is used by Gui-on-the-fly.

save

public void save(PhantomOutputFile data)
          throws IOException

Saves the control to the indicated file.

 Base:
  + isMultiLine         BYTE
  + justification       BYTE
  + font                USHORT
  + foregroundColor     BYTE
  + flags               BYTE
  + backgroundColor     BYTE
  + reserved            BYTE
  + text                ZTSTRING
 

Specified by:

save in class PhantomControl

Parameters:

data - The output file.

Throws:

IOException - if an I/O error occurs.

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

getDataSize

public int getDataSize(PhantomOutputFile outputFile)

Get the size when saved to file.

Specified by:

getDataSize in class PhantomControl

updateGuiOnTheFlyValue

public void updateGuiOnTheFlyValue(CRC32 crc32)

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

All controls that implements a Gui-on-the-fly constructor must always override this method and start by calling super.updateGuiOnTheFlyCRC32(crc32) before adding control specific data.

Overrides:

updateGuiOnTheFlyValue 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.

updateReferences

public void updateReferences(ApplicationReferences refs)

Updates the Applications References instance.

Specified by:

updateReferences in class PhantomControl

addNPObjects

protected void addNPObjects(ENPObject obj)

Gets the NPObject for the control.

Specified by:

addNPObjects in class PhantomControl

equalsControl

protected boolean equalsControl(PhantomControl c)

Checks for control equality. The base is already checked and the Control ID, potential fore- and background color and color conversion flags. The tooltip text is not checked.

Specified by:

equalsControl in class PhantomControl