se.entra.phantom.server

Class PhantomCPushButton

java.lang.Object

se.entra.phantom.server.PhantomControl

se.entra.phantom.server.PhantomCPushButton

All Implemented Interfaces:

Cloneable, PhantomControlFlags, PhantomControlType

public class PhantomCPushButton
extends PhantomControl

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

Field Summary

Fields

Modifier and Type	Field and Description
int	actionKey Action key for the push Button.
int	bitmap The bitmap values.
String	connectedControlID Connected control ID.
int	connectedControlIndex Connected control index in panel.
boolean	doLockPanel Flag for locking the panel when menu item is selected.
boolean	doSkipEnableCheck Flag to indicate that no check should be done to disable the menu item for connected controls.
static int	FLAG_ALWAYSUPDATE Always update the text
static int	FLAG_DISABLE Disable from start.
static int	FLAG_NODISABLE Don't disable for host field.
static int	FLAG_TEXTIDSTRING Text ID string
int	flags Flags for the push button.
int	font Font for the Push Button.
int	foregroundColor The foreground color.
boolean	hasFunctionality This flag indicates that the push button has no functional implementation, because it has no ID, object, host field name, send string, send key and no next panel.
PhantomHostField	hostField The host field (may be null if the panel doesn't have a screen name).
String	hostFieldName The host field name.
boolean	isDefault Default Flag.
boolean	isDisabledFromStart Flag for disabled from start.
boolean	isStringTextID Flag indicates that the send string is a text ID.
String	nextPanel Name of the next Panel
String	objectName Name of connected object
int	sendKey The send key to host.
String	sendString Send string for the menu item.
String	text Text of the push Button

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
PhantomCPushButton(PhantomFile data) Constructor for the Designer Control implementation.
PhantomCPushButton(PhantomFile data, PhantomPanelData panelData, int index, PhantomControlBase controlBase) Creates an instance of the control class.
PhantomCPushButton(PhantomPanelData panelData, PhantomControlBase controlBase, PhantomHostField hostField, String text) Creates an push button 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.
String	getHostFieldID() Gets the host field ID for this control.
protected String	getNPObjectExtra() Gets the "Extra" String for the NPObject.
String	getSendString(VirtualRuntime runtime) Get send string, eventually from text file.
boolean	isDisabledFromStart() Should the push button be disabled from start.
boolean	isStateHostConnected() Checks if the push button is state-connected to the host field.
boolean	isTextPromptRefreshRequired() Checks if the static text always needs updates.
void	rebind() Re-bind the panel data.
void	reloadObject() Reload object reference.
static int	remapActionKey(int vk) Remaps the action keys F13-F24 to Shift+F1-F12 because Java doesn't have F13-F24.
void	resolveComponentReferences() Resolves reference of this control to other panel component, after the panel has been loaded.
void	save(PhantomOutputFile file) Saves the instance of the control class to 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_NODISABLE

public static final int FLAG_NODISABLE

Don't disable for host field.

See Also:

Constant Field Values

FLAG_ALWAYSUPDATE

public static final int FLAG_ALWAYSUPDATE

Always update the text

See Also:

Constant Field Values

FLAG_DISABLE

public static final int FLAG_DISABLE

Disable from start.

See Also:

Constant Field Values

FLAG_TEXTIDSTRING

public static final int FLAG_TEXTIDSTRING

Text ID string

See Also:

Constant Field Values

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

text

public String text

Text of the push Button

objectName

public String objectName

Name of connected object

nextPanel

public String nextPanel

Name of the next Panel

connectedControlID

public String connectedControlID

Connected control ID.

connectedControlIndex

public int connectedControlIndex

Connected control index in panel.

sendString

public String sendString

Send string for the menu item.

actionKey

public int actionKey

Action key for the push Button.

sendKey

public int sendKey

The send key to host.

font

public int font

Font for the Push Button.

isDefault

public boolean isDefault

Default Flag.

doSkipEnableCheck

public boolean doSkipEnableCheck

Flag to indicate that no check should be done to disable the menu item for connected controls.

doLockPanel

public boolean doLockPanel

Flag for locking the panel when menu item is selected.

bitmap

public int bitmap

The bitmap values.

flags

public int flags

Flags for the push button.

isStringTextID

public boolean isStringTextID

Flag indicates that the send string is a text ID.

isDisabledFromStart

public boolean isDisabledFromStart

Flag for disabled from start.

hasFunctionality

public boolean hasFunctionality

This flag indicates that the push button has no functional implementation, because it has no ID, object, host field name, send string, send key and no next panel.

foregroundColor

public int foregroundColor

The foreground color.

Constructor Detail

PhantomCPushButton

public PhantomCPushButton(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[32]
 + id                  BYTE[9]
 + object              BYTE[9]
 + nextPanel           BYTE[9]
 + Skip updateFld      BYTE
 + Skip HasSeparator   BYTE
 + connectedControlID  BYTE[9]
 + hostField           BYTE[9]
 + sendString          BYTE[32]
 + actionKey           USHORT
 + sendKey             USHORT
 + font                USHORT
 + isDefault           BYTE
 + foregroundColor     BYTE
 + doSkipEnableCheck   BYTE
 + doLockPanel         BYTE
 + bitmap              BYTE
 + Skip subMenuCount   BYTE
 + flags               BYTE
 + reserved            BYTE[7]
 

Throws:

IOException - if an I/O error occurs.

PhantomCPushButton

public PhantomCPushButton(PhantomFile data)
                   throws IOException

Constructor for the Designer Control implementation.

Throws:

IOException

PhantomCPushButton

public PhantomCPushButton(PhantomPanelData panelData,
                          PhantomControlBase controlBase,
                          PhantomHostField hostField,
                          String text)

Creates an push button 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 of the control class to file.

 Base:
 + text                BYTE[32]
 + id                  BYTE[9]
 + object              BYTE[9]
 + nextPanel           BYTE[9]
 + Skip updateFld      BYTE
 + Skip HasSeparator   BYTE
 + connectedControlID  BYTE[9]
 + hostField           BYTE[9]
 + sendString          BYTE[32]
 + actionKey           USHORT
 + sendKey             USHORT
 + font                USHORT
 + isDefault           BYTE
 + foregroundColor     BYTE
 + doSkipEnableCheck   BYTE
 + doLockPanel         BYTE
 + bitmap              BYTE
 + Skip subMenuCount   BYTE
 + flags               BYTE
 + reserved            BYTE[7]
 

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

remapActionKey

public static int remapActionKey(int vk)

Remaps the action keys F13-F24 to Shift+F1-F12 because Java doesn't have F13-F24.

isTextPromptRefreshRequired

public boolean isTextPromptRefreshRequired()

Checks if the static text always needs updates.

isStateHostConnected

public boolean isStateHostConnected()

Checks if the push button is state-connected to the host field.

isDisabledFromStart

public boolean isDisabledFromStart()

Should the push button be disabled from start.

resolveComponentReferences

public void resolveComponentReferences()

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

The specified control ID is controling disable/enable of the push button. Example of control types are list box and entry fields.

Overrides:

resolveComponentReferences in class PhantomControl

getSendString

public String getSendString(VirtualRuntime runtime)

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

Returns:

text string or empty string for error.

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.

reloadObject

public void reloadObject()
                  throws IOException

Reload object reference.

Specified by:

reloadObject in class PhantomControl

Throws:

IOException

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