se.entra.phantom.server

Class PhantomCMLE

java.lang.Object

se.entra.phantom.server.PhantomControl

se.entra.phantom.server.PhantomCMLE

All Implemented Interfaces:

Cloneable, PhantomControlFlags, PhantomControlType

public class PhantomCMLE
extends PhantomControl

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

Field Summary

Fields

Modifier and Type	Field and Description
int	fieldType Field type.
static int	FLAG_BACKGROUND Background color.
static int	FLAG_FOREGROUND Foreground color.
static int	FLAG_HINDI Hindi digits.
static int	FLAG_RTL RTL.
static int	FLAG_USERCHANGELIGHTEVENT Should user change light event be sent for each document change.
int	flags Flags.
int	font Field font.
boolean	hasHorzScroll Flag for MLE has a horizontal scroll bar.
boolean	hasNoBorder Flag for no border.
boolean	hasVertScroll Flag for MLE has a vertical scroll bar.
PhantomHostField	hostField The host field (may be null if the panel doesn't have a screen name).
String	hostFieldName The host field name.
boolean	isDirectChecked Direct check of chars.
boolean	isWordWrapped Field word wraps.
int	length Field length.
String	objectName Object name.
boolean	userChangeLightEvent Should user change light event be sent for each document change.

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

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.
boolean	isActionConnectedEnabled() Checks if a control is action connected to another.
void	rebind() Re-bind the panel data.
void	reloadObject() Reload object reference.
void	save(PhantomOutputFile file) Saves the instance of the control class 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, getDesignerControl, getForegroundColor, getHostField, getID, getIndex, getNPObjectExtra, getNPObjectID, getObject, getObject, getPanelData, getReferencedFiles, getTypeDescription, getTypeDescriptionID, initializeDesignerControls, 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

FLAG_FOREGROUND

public static final int FLAG_FOREGROUND

Foreground color.

See Also:

Constant Field Values

FLAG_BACKGROUND

public static final int FLAG_BACKGROUND

Background color.

See Also:

Constant Field Values

FLAG_RTL

public static final int FLAG_RTL

RTL.

See Also:

Constant Field Values

FLAG_HINDI

public static final int FLAG_HINDI

Hindi digits.

See Also:

Constant Field Values

FLAG_USERCHANGELIGHTEVENT

public static final int FLAG_USERCHANGELIGHTEVENT

Should user change light event be sent for each document change.

See Also:

Constant Field Values

length

public int length

Field length.

objectName

public String objectName

Object name.

fieldType

public int fieldType

Field type.

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

font

public int font

Field font.

hasHorzScroll

public boolean hasHorzScroll

Flag for MLE has a horizontal scroll bar.

hasVertScroll

public boolean hasVertScroll

Flag for MLE has a vertical scroll bar.

isWordWrapped

public boolean isWordWrapped

Field word wraps.

flags

public int flags

Flags.

hasNoBorder

public boolean hasNoBorder

Flag for no border.

isDirectChecked

public boolean isDirectChecked

Direct check of chars.

userChangeLightEvent

public boolean userChangeLightEvent

Should user change light event be sent for each document change.

Constructor Detail

PhantomCMLE

public PhantomCMLE(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:
  + length             USHORT
  + isRightJustified   BYTE
  + id                 BYTE [9]
  + object             BYTE [9]
  + fieldType          USHORT
  + hostField          BYTE [9]
  + reserved           BYTE [2]
  + font               USHORT
  + foregroundColor    BYTE
  + hasHorzScroll      BYTE
  + hasVertScroll      BYTE
  + isWordWrapped      BYTE
  + backgroundColor    BYTE
  + flags              BYTE
  + reserved           BYTE [5]
  + hasNoBorder        BYTE
  + isDirectChecked    BYTE
 

Throws:

IOException - if an I/O error occurs.

PhantomCMLE

public PhantomCMLE(PhantomFile data)
            throws IOException

Constructor for Designer control.

Throws:

IOException - if an I/O error occurs.

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:
  + length             USHORT
  + isRightJustified   BYTE
  + id                 BYTE [9]
  + object             BYTE [9]
  + fieldType          USHORT
  + hostField          BYTE [9]
  + reserved           BYTE [2]
  + font               USHORT
  + foregroundColor    BYTE
  + hasHorzScroll      BYTE
  + hasVertScroll      BYTE
  + isWordWrapped      BYTE
  + backgroundColor    BYTE
  + flags              BYTE
  + reserved           BYTE [5]
  + hasNoBorder        BYTE
  + isDirectChecked    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

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

isActionConnectedEnabled

public boolean isActionConnectedEnabled()

Checks if a control is action connected to another. E.g. for Copy/Paste operations.

Overrides:

isActionConnectedEnabled in class PhantomControl

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

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