se.entra.phantom.server

Class PhantomCUserWindow

java.lang.Object

se.entra.phantom.server.PhantomControl

se.entra.phantom.server.PhantomCUserWindow

All Implemented Interfaces:

Cloneable, PhantomControlFlags, PhantomControlType

public class PhantomCUserWindow
extends PhantomControl

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

Field Summary

Fields

Modifier and Type	Field and Description
PhantomCBar	barData The bar object data.
boolean	doReturnErrorMessage Flag indicating that error report is to be done for external images.
int	font Field font.
PhantomHostField	hostField The host field (may be null if the panel doesn't have a screen name).
String	initialExternalImage The initial text for the external image.
boolean	isExternalImage The flag indicating the user window is an external image.
String	moduleName The module name.
String	originalModuleName The original module name.
String	originalProcedureName The original procedure name.
String	procedureName The procedure name.
Class<?>	serverUserWindow Class that implements the VirtualServerUserWindowInterface interface.
int	type The user window type.
byte[]	userWindowData The user window data.

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
PhantomCUserWindow(PhantomFile data, PhantomPanelData panelData, int index, PhantomControlBase controlBase) Creates an instance of the control class.
PhantomCUserWindow(PhantomRuntime runtime, PhantomFile data) Constructor for Designer control.

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.
void	getReferencedFiles(ArrayList<String> files) Adds all files that are referenced by this control.
boolean	isBar() Check if it's a bar.
boolean	isRemapped() Checks if the cuserwin2 package is used on the client side rather than cuserwin.
boolean	isToolbar() Checks if this is a toolbar control (Bar control but not a status bar).
void	rebind() Re-bind the panel data.
void	reloadObject() Reload object reference.
void	save(PhantomOutputFile file) Saves the instance of the control to file.
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, getTypeDescription, getTypeDescriptionID, initializeDesignerControls, isActionConnectedEnabled, processColorConversion, processColorConversion, processColorConversion, processDisabledBackground, resolveComponentReferences, saveBase, setBackgroundColor, setForegroundColor, setIndex, updateGuiOnTheFlyValue

Methods inherited from class java.lang.Object

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

Field Detail

type

public int type

The user window type.

hostField

public PhantomHostField hostField

The host field (may be null if the panel doesn't have a screen name).

font

public int font

Field font.

moduleName

public String moduleName

The module name.

originalModuleName

public String originalModuleName

The original module name.

procedureName

public String procedureName

The procedure name.

originalProcedureName

public String originalProcedureName

The original procedure name.

barData

public PhantomCBar barData

The bar object data.

userWindowData

public byte[] userWindowData

The user window data.

isExternalImage

public boolean isExternalImage

The flag indicating the user window is an external image.

initialExternalImage

public String initialExternalImage

The initial text for the external image.

doReturnErrorMessage

public boolean doReturnErrorMessage

Flag indicating that error report is to be done for external images.

serverUserWindow

public Class<?> serverUserWindow

Class that implements the VirtualServerUserWindowInterface interface.

Constructor Detail

PhantomCUserWindow

public PhantomCUserWindow(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:
  + type                BYTE
  + backgroundColor     BYTE
  + font                USHORT
  + foregroundColor     BYTE
  + moduleName          BYTE [9]
  + procedureName       BYTE [33]
  + dataLen             USHORT
  + (skip) pointer      PVOID
  + (skip) testMode     BYTE
  + id                  BYTE [9]
.
 The following data is read by the user window if it's a bar or an external image.
.
  + data - variable     BYTE [dataLen]
 

Throws:

IOException - if an I/O error occurs.

PhantomCUserWindow

public PhantomCUserWindow(PhantomRuntime runtime,
                          PhantomFile data)
                   throws IOException

Constructor for Designer control.

Throws:

IOException - if an I/O error occurs.

Method Detail

isRemapped

public boolean isRemapped()

Checks if the cuserwin2 package is used on the client side rather than cuserwin.

save

public void save(PhantomOutputFile file)
          throws IOException

Saves the instance of the control to file.

 Base:
  + type                BYTE
  + backgroundColor     BYTE
  + font                USHORT
  + foregroundColor     BYTE
  + moduleName          BYTE [9]
  + procedureName       BYTE [33]
  + dataLen             USHORT
  + (skip) pointer      PVOID
  + (skip) testMode     BYTE
  + id                  BYTE [9]
.
 The following data is read by the user window if it's a bar or an external image.
.
  + data - variable     BYTE [dataLen]
 

Specified by:

save in class PhantomControl

Parameters:

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()
                  throws IOException

Reload object reference.

Specified by:

reloadObject in class PhantomControl

Throws:

IOException

getDataSize

public int getDataSize(PhantomOutputFile outputFile)

Get the size when saved to file.

Specified by:

getDataSize in class PhantomControl

isBar

public boolean isBar()

Check if it's a bar.

isToolbar

public boolean isToolbar()

Checks if this is a toolbar control (Bar control but not a status bar).

getReferencedFiles

public void getReferencedFiles(ArrayList<String> files)

Adds all files that are referenced by this control.

Overrides:

getReferencedFiles in class PhantomControl

Parameters:

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

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