se.entra.phantom.server

Class PhantomCCheckBox

java.lang.Object

se.entra.phantom.server.PhantomControl

se.entra.phantom.server.PhantomCCheckBox

All Implemented Interfaces:

Cloneable, PhantomControlFlags, PhantomControlType

public class PhantomCCheckBox
extends PhantomControl

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

Field Summary

Fields

Modifier and Type	Field and Description
int	bitmapFlags Bitmap image flags.
String	doubleClickID Control ID to activate when double clicked.
int	doubleClickIndex Control ID index to activate when double clicked.
static int	FLAG_ALWAYSUPDATE Always update text prompt.
static int	FLAG_BACKGROUND Background color conversion.
static int	FLAG_FOREGROUND Foreground color conversion.
static int	FLAG_NODISABLE Don't disable for host field.
static int	FLAG_RTL Right-to-left layout.
static int	FLAG_SELNOMATCH Select when no match.
static int	FLAG_TEXTIDSTRING Text ID is text string.
static int	FLAG_UNSELNOMATCH Unselect when no match.
int	flags Control flags.
int	font Font index.
PhantomHostField	hostField The host field (may be null if the panel doesn't have a screen name).
String	hostFieldName The host field name.
boolean	isSelected Flag for control selected at start.
boolean	isStringTextID Flag indicates that the selected string is a text ID.
String	objectName Object name.
String	selectedString The selected string for the control.
static int	STATE_NOTSELECTED
static int	STATE_SELECTED
static int	STATE_UNDETERMINED
String	text Text prompt.
String	unSelectedString The unselected string for the control.

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
PhantomCCheckBox(PhantomFile data) Check box data reading Creates an instance of the control class.
PhantomCCheckBox(PhantomFile data, PhantomPanelData panelData, int index, PhantomControlBase controlBase) Creates an instance of the control class.
PhantomCCheckBox(PhantomPanelData panelData, PhantomControlBase controlBase, PhantomHostField hostField, String selStr, String unselStr, boolean isChecked) Creates a check box 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.
String	getControlObjectID() Needs override by the control if the object instance if not resolved in this class instance.
int	getDataSize(PhantomOutputFile outputFile) Get the size when saved to file.
int	getDefaultSelectionState(int prevSelectionState) Compare current text with selection/unselection text and return current selection state.
String	getHostFieldID() Gets the host field ID for this control.
protected String	getNPObjectExtra() Gets the "Extra" String for the NPObject.
String	getSelectedText(VirtualRuntime runtime) Get selected text, eventually from text file.
String	getUnselectedText(VirtualRuntime runtime) Get unselected text, eventually from text file.
boolean	isNeverDisabled() Should checkbox never be disabled.
boolean	isTextPromptRefreshRequired() Checks if the static text always needs updates.
void	rebind() Re-bind the panel data.
void	reloadObject() Reload object reference.
void	resolveComponentReferences() Resolves double click reference of this control to other panel component, after the panel has been loaded.
void	save(PhantomOutputFile file) Saves the instance 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, getDesignerControl, getForegroundColor, getHostField, getID, getIndex, getNPObjectID, getObject, getObject, getPanelData, getReferencedFiles, getTypeDescription, getTypeDescriptionID, initializeDesignerControls, isActionConnectedEnabled, processColorConversion, processColorConversion, processColorConversion, processDisabledBackground, saveBase, setBackgroundColor, setForegroundColor, setIndex

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_FOREGROUND

public static final int FLAG_FOREGROUND

Foreground color conversion.

See Also:

Constant Field Values

FLAG_BACKGROUND

public static final int FLAG_BACKGROUND

Background color conversion.

See Also:

Constant Field Values

FLAG_UNSELNOMATCH

public static final int FLAG_UNSELNOMATCH

Unselect when no match.

See Also:

Constant Field Values

FLAG_NODISABLE

public static final int FLAG_NODISABLE

Don't disable for host field.

See Also:

Constant Field Values

FLAG_TEXTIDSTRING

public static final int FLAG_TEXTIDSTRING

Text ID is text string.

See Also:

Constant Field Values

FLAG_RTL

public static final int FLAG_RTL

Right-to-left layout.

See Also:

Constant Field Values

FLAG_SELNOMATCH

public static final int FLAG_SELNOMATCH

Select when no match.

See Also:

Constant Field Values

FLAG_ALWAYSUPDATE

public static final int FLAG_ALWAYSUPDATE

Always update text prompt.

See Also:

Constant Field Values

STATE_NOTSELECTED

public static final int STATE_NOTSELECTED

See Also:

Constant Field Values

STATE_SELECTED

public static final int STATE_SELECTED

See Also:

Constant Field Values

STATE_UNDETERMINED

public static final int STATE_UNDETERMINED

See Also:

Constant Field Values

text

public String text

Text prompt.

objectName

public String objectName

Object name.

isSelected

public boolean isSelected

Flag for control selected at start.

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

selectedString

public String selectedString

The selected string for the control.

unSelectedString

public String unSelectedString

The unselected string for the control.

font

public int font

Font index.

doubleClickID

public String doubleClickID

Control ID to activate when double clicked.

doubleClickIndex

public int doubleClickIndex

Control ID index to activate when double clicked.

bitmapFlags

public int bitmapFlags

Bitmap image flags.

flags

public int flags

Control flags.

isStringTextID

public boolean isStringTextID

Flag indicates that the selected string is a text ID.

Constructor Detail

PhantomCCheckBox

public PhantomCCheckBox(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:
  + text                    BYTE [97]
  + id                      BYTE [9]
  + object                  BYTE [9]
  + isSelected              BYTE
  + reserved                BYTE
  + hostField               BYTE [9]
  + selectedString          BYTE [11]
  + unSelectedString        BYTE [11]
  + reserved                BYTE
  + font                    USHORT
  + foregroundColor         BYTE
  + doubleClickID           BYTE [9]
  + bitmapFlags             BYTE
  + flags                   BYTE
  + reserved                BYTE
 

Throws:

IOException - if an I/O error occurs.

PhantomCCheckBox

public PhantomCCheckBox(PhantomFile data)
                 throws IOException

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

Throws:

IOException - if an I/O error occurs.

PhantomCCheckBox

public PhantomCCheckBox(PhantomPanelData panelData,
                        PhantomControlBase controlBase,
                        PhantomHostField hostField,
                        String selStr,
                        String unselStr,
                        boolean isChecked)

Creates a check box control for Gui-on-the-fly.

Method Detail

rebind

public void rebind()

Re-bind the panel data.

Overrides:

rebind in class PhantomControl

save

public void save(PhantomOutputFile file)
          throws IOException

Saves the instance to the indicated file.

 Base:
  + text                    BYTE [97]
  + id                      BYTE [9]
  + object                  BYTE [9]
  + isSelected              BYTE
  + reserved                BYTE
  + hostField               BYTE [9]
  + selectedString          BYTE [11]
  + unSelectedString        BYTE [11]
  + reserved                BYTE
  + font                    USHORT
  + foregroundColor         BYTE
  + doubleClickID           BYTE [9]
  + bitmapFlags             BYTE
  + flags                   BYTE
  + reserved                BYTE
 

Specified by:

save in class PhantomControl

Parameters:

file -

Throws:

IOException - if an I/O error occurs.

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

getSelectedText

public String getSelectedText(VirtualRuntime runtime)

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

Returns:

text string or empty string for error.

reloadObject

public void reloadObject()
                  throws IOException

Reload object reference.

Specified by:

reloadObject in class PhantomControl

Throws:

IOException

getUnselectedText

public String getUnselectedText(VirtualRuntime runtime)

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

Returns:

text string or null for error.

getDefaultSelectionState

public int getDefaultSelectionState(int prevSelectionState)

Compare current text with selection/unselection text and return current selection state. If text does not match, see default flags to determine the returning state. Selection/unselection text can also be a text ID, that must be fetched from the text file before comparison.

isNeverDisabled

public boolean isNeverDisabled()

Should checkbox never be disabled.

isTextPromptRefreshRequired

public boolean isTextPromptRefreshRequired()

Checks if the static text always needs updates.

resolveComponentReferences

public void resolveComponentReferences()

Resolves double click reference of this control to other panel component, after the panel has been loaded.

Overrides:

resolveComponentReferences in class PhantomControl

getHostFieldID

public String getHostFieldID()

Gets the host field ID for this control.

Overrides:

getHostFieldID in class PhantomControl

Returns:

String may be of zero-length if no host field ID is defined.

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

getNPObjectExtra

protected String getNPObjectExtra()

Gets the "Extra" String for the NPObject.

Overrides:

getNPObjectExtra in class PhantomControl

getControlObjectID

public String getControlObjectID()

Needs override by the control if the object instance if not resolved in this class instance.

Overrides:

getControlObjectID in class PhantomControl

Returns:

the Object ID connected to this control, null or empty string for none.

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