se.entra.phantom.server

Class PhantomControl

java.lang.Object

se.entra.phantom.server.PhantomControl

All Implemented Interfaces:

Cloneable, PhantomControlFlags, PhantomControlType

Direct Known Subclasses:

PhantomCBusGraph, PhantomCCheckBox, PhantomCEntryField, PhantomCGroupBox, PhantomCListBox, PhantomCMLE, PhantomCNoteBook, PhantomCOutputText, PhantomCPushButton, PhantomCRadioButton, PhantomCRectangle, PhantomCStaticText, PhantomCSubWindow, PhantomCTree, PhantomCUnknown, PhantomCUserWindow, PhantomListCapableControl

public abstract class PhantomControl
extends Object
implements PhantomControlType, PhantomControlFlags, Cloneable

This class is the superclass for all Phantom controls. It holds references to other objects and utility methods.

Field Summary

Fields

Modifier and Type	Field and Description
PhantomControlBase	controlBase Control base data position,size,type and other basic data.
protected se.entra.phantom.geditor.NPPColor	controlColor Foreground and background color that possibly is set from respectively control.
String	id The control ID (or null if the control doesn't have an ID).
int	index The control index in the panel.
boolean	isBackgroundConverted The host VIO color is background converted.
boolean	isForegroundConverted The host VIO color is foreground converted.
PhantomObject	object The object connected to this control (or null for no object).
PhantomPanelData	panelData The panel data.
PhantomPopupMenu	popupMenu The possible connection to a pop-up menu (may be null).
String	tooltipText The tool-tip text connected to the control.

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
PhantomControl(PhantomPanelData panelData, int index, PhantomControlBase controlBase) Loads the control base definition from the Phantom Panel file.

Method Summary

Modifier and Type	Method and Description
void	addControlID(String id) Adds a control with a control ID to the panel.
void	addControlReference(ENPObject obj, String controlID) Adds a control reference.
void	addHostFieldReference(ENPObject obj, String hostField) Helper method to add a reference to a host field.
protected abstract void	addNPObjects(ENPObject obj) Adds the NPObject references.
void	appendBaseTransaction(Transaction trans) Appends the basic control data to the create transaction to the client (flags, x, y, cx, cy).
void	checkTextPromptReferences(ENPObject obj, String text) Checks a text prompt for added references to text ID and host fields.
void	checkTextPromptReferences(ENPObject obj, String text, int bitmapFlags) Processes a text string for the push button, check box and radio button for images.
protected PhantomControl	clone() Makes a clone of a PhantomControl instance.
static PhantomControl	create(PhantomPanelData panelData, int index, PhantomFile file, PhantomControlBase controlBase, PhantomControlBase lastBase) Loads the control specific definition from the Phantom Panel file and creates the control.
ENPObject	createNPObject() Gets the NPObject for the control.
boolean	equals(Object o) Checks if two control base's are equal.
protected abstract boolean	equalsControl(PhantomControl c) Checks for control equality.
PhantomApplicationData	getApplicationData() Gets the application data.
int	getBackgroundColor() Get control background color.
String	getControlObjectID() Needs override by the control if the object instance if not resolved in this class instance.
abstract int	getDataSize(PhantomOutputFile outputFile) Get the size when saved to file.
static IDesignerControl	getDesignerControl(int type) Gets the designer control implementor for a type.
int	getForegroundColor() Get control foreground color.
PhantomHostField	getHostField(String fieldName) Gets the host field of a specific name.
String	getHostFieldID() Gets the host field ID for this control.
String	getID() Gets ID of this control.
int	getIndex() Gets the index of this control.
protected String	getNPObjectExtra() Gets the "Extra" String for the NPObject.
protected String	getNPObjectID() Gets the "ID" for the NPObject.
PhantomObject	getObject() Gets the object reference of this control.
PhantomObject	getObject(String objectName) Gets the object associated with the object name, may be null if the object name is empty.
PhantomPanelData	getPanelData() Gets the panel data.
void	getReferencedFiles(ArrayList<String> files) Adds all files that are referenced by this control.
String	getTypeDescription() Gets the type description of this control in "English", such as "Notebook" or "Push Button".
String	getTypeDescriptionID() Gets the type description of this control in "English", such as "Notebook ID nn" or "Push Button ID nn", including the control ID.
static void	initializeDesignerControls() Editor initializing.
boolean	isActionConnectedEnabled() Checks if a control is action connected to another.
void	processColorConversion(VirtualControl vCtl, int vioColor) Handle color conversion for host update.
void	processColorConversion(VirtualControl vCtl, int vioColor, boolean doKeepBackgroundAtNoConversion) Handle color conversion for host update.
void	processColorConversion(VirtualControl vCtl, int vioColor, boolean doForegroundColor, boolean doKeepBackgroundAtNoConversion) Handle color conversion for host update.
se.entra.phantom.geditor.NPPColor	processDisabledBackground(VirtualControl vCtl, boolean isDisable, boolean backgroundAsPanel, se.entra.phantom.geditor.NPPColor originalBackground) Handle background as panel when read only.
void	rebind() Re-bind the panel data.
abstract void	reloadObject() Reload object reference.
void	resolveComponentReferences() Resolves references of this control to other panel components, after the panel has been loaded.
abstract void	save(PhantomOutputFile file) The save to file method to be implemented by all subclasses.
void	saveBase(PhantomOutputFile file) The save the base to file.
void	setBackgroundColor(int colorIndex) Set background color (from e.g.
void	setForegroundColor(int colorIndex) Set foreground color (from ex GOF).
void	setIndex(int index) Sets the index of the control in the panel.
void	updateGuiOnTheFlyValue(CRC32 crc32) Updates the CRC32 value of a Gui-on-the-fly value with the control's base data.
abstract void	updateReferences(ApplicationReferences refs) Updates the Applications References instance.

Methods inherited from class java.lang.Object

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

Field Detail

controlBase

public PhantomControlBase controlBase

Control base data position,size,type and other basic data.

panelData

public PhantomPanelData panelData

The panel data.

popupMenu

public PhantomPopupMenu popupMenu

The possible connection to a pop-up menu (may be null).

index

public int index

The control index in the panel.

id

public String id

The control ID (or null if the control doesn't have an ID).

object

public PhantomObject object

The object connected to this control (or null for no object).

isForegroundConverted

public boolean isForegroundConverted

The host VIO color is foreground converted.

isBackgroundConverted

public boolean isBackgroundConverted

The host VIO color is background converted.

tooltipText

public String tooltipText

The tool-tip text connected to the control.

controlColor

protected se.entra.phantom.geditor.NPPColor controlColor

Foreground and background color that possibly is set from respectively control.

Constructor Detail

PhantomControl

public PhantomControl(PhantomPanelData panelData,
                      int index,
                      PhantomControlBase controlBase)

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
 

Method Detail

initializeDesignerControls

public static void initializeDesignerControls()

Editor initializing.

getDesignerControl

public static IDesignerControl getDesignerControl(int type)

Gets the designer control implementor for a type.

getForegroundColor

public int getForegroundColor()

Get control foreground color.

Returns:

color index 0-nn or -1 if not initiated.

getBackgroundColor

public int getBackgroundColor()

Get control background color.

Returns:

color index 0-nn or -1 if not initiated.

setForegroundColor

public void setForegroundColor(int colorIndex)

Set foreground color (from ex GOF).

setBackgroundColor

public void setBackgroundColor(int colorIndex)

Set background color (from e.g. GOF).

create

public static PhantomControl create(PhantomPanelData panelData,
                                    int index,
                                    PhantomFile file,
                                    PhantomControlBase controlBase,
                                    PhantomControlBase lastBase)
                             throws IOException

Loads the control specific definition from the Phantom Panel file and creates the control.

 Control specific data:
  + data - variable     BYTE [dataLen]
 

Throws:

IOException - if an I/O error occurs.

getTypeDescription

public String getTypeDescription()

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

getTypeDescriptionID

public String getTypeDescriptionID()

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

setIndex

public void setIndex(int index)

Sets the index of the control in the panel. This method should only be called from the PhantomPanelData class when creating Gui-on-the-fly controls.

resolveComponentReferences

public void resolveComponentReferences()

Resolves references of this control to other panel components, after the panel has been loaded.

getReferencedFiles

public void getReferencedFiles(ArrayList<String> files)

Adds all files that are referenced by this control.

Parameters:

files - The ArrayList of file names that are referenced will be filled in.

getPanelData

public PhantomPanelData getPanelData()

Gets the panel data.

getApplicationData

public PhantomApplicationData getApplicationData()

Gets the application data.

addControlID

public void addControlID(String id)

Adds a control with a control ID to the panel. Every control that has a string ID should call this method in the constructor. Controls that do not do so will not be found when an ID is searched for in the panel. The panel keeps a hash table with all the IDs.

When this method is called, the table of connection IDs to pop-up menus is also checked for reference. If such connection exist, the PhantomPopupMenu reference is saved.

getObject

public PhantomObject getObject(String objectName)
                        throws IOException

Gets the object associated with the object name, may be null if the object name is empty.

Throws:

IOException - if the object is not found in the application

getIndex

public int getIndex()

Gets the index of this control.

getDataSize

public abstract int getDataSize(PhantomOutputFile outputFile)

Get the size when saved to file.

getObject

public PhantomObject getObject()

Gets the object reference of this control.

reloadObject

public abstract void reloadObject()
                           throws IOException

Reload object reference.

Throws:

IOException

rebind

public void rebind()

Re-bind the panel data.

getID

public String getID()

Gets ID of this control.

getHostField

public PhantomHostField getHostField(String fieldName)

Gets the host field of a specific name.

Returns:

null if host field is not found, or the panel doesn't have a host screen name specified.

appendBaseTransaction

public void appendBaseTransaction(Transaction trans)

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

isActionConnectedEnabled

public boolean isActionConnectedEnabled()

Checks if a control is action connected to another. It is the list box and the entry field that does support it, and these controls override this method and returns true when the appropriate flags are set.

processColorConversion

public void processColorConversion(VirtualControl vCtl,
                                   int vioColor)

Handle color conversion for host update.

processColorConversion

public void processColorConversion(VirtualControl vCtl,
                                   int vioColor,
                                   boolean doKeepBackgroundAtNoConversion)

Handle color conversion for host update.

processColorConversion

public void processColorConversion(VirtualControl vCtl,
                                   int vioColor,
                                   boolean doForegroundColor,
                                   boolean doKeepBackgroundAtNoConversion)

Handle color conversion for host update.

processDisabledBackground

public se.entra.phantom.geditor.NPPColor processDisabledBackground(VirtualControl vCtl,
                                                                   boolean isDisable,
                                                                   boolean backgroundAsPanel,
                                                                   se.entra.phantom.geditor.NPPColor originalBackground)

Handle background as panel when read only.

Returns:

suitable background color.

getHostFieldID

public String getHostFieldID()

Gets the host field ID for this control. Override this method and return the host field ID for controls that supports a host field ID.

Returns:

null the host field ID in VirtualControl is never defined, it's up the the extending class to return it by overriding this method.

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.

save

public abstract void save(PhantomOutputFile file)
                   throws IOException

The save to file method to be implemented by all subclasses.

Parameters:

file -

Throws:

IOException

saveBase

public void saveBase(PhantomOutputFile file)
              throws IOException

The save the base to file.

Parameters:

file -

Throws:

IOException

clone

protected PhantomControl clone()

Makes a clone of a PhantomControl instance.

Overrides:

clone in class Object

Returns:

A new instance that is identically to the current instance.

updateReferences

public abstract void updateReferences(ApplicationReferences refs)

Updates the Applications References instance.

createNPObject

public ENPObject createNPObject()

Gets the NPObject for the control.

getNPObjectID

protected String getNPObjectID()

Gets the "ID" for the NPObject. Override, e.g. for static text to get the Text prompt instead.

getNPObjectExtra

protected String getNPObjectExtra()

Gets the "Extra" String for the NPObject.

addNPObjects

protected abstract void addNPObjects(ENPObject obj)

Adds the NPObject references.

getControlObjectID

public String getControlObjectID()

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

Returns:

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

checkTextPromptReferences

public void checkTextPromptReferences(ENPObject obj,
                                      String text)

Checks a text prompt for added references to text ID and host fields.

checkTextPromptReferences

public void checkTextPromptReferences(ENPObject obj,
                                      String text,
                                      int bitmapFlags)

Processes a text string for the push button, check box and radio button for images.

addControlReference

public void addControlReference(ENPObject obj,
                                String controlID)

Adds a control reference.

addHostFieldReference

public void addHostFieldReference(ENPObject obj,
                                  String hostField)

Helper method to add a reference to a host field.

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

equalsControl

protected abstract 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.