se.entra.phantom.server

Class PhantomCComboBox

java.lang.Object

se.entra.phantom.server.PhantomControl

se.entra.phantom.server.PhantomListCapableControl

se.entra.phantom.server.PhantomCComboBox

All Implemented Interfaces:

Cloneable, IListCapableControl, PhantomControlFlags, PhantomControlType

public class PhantomCComboBox
extends PhantomListCapableControl
implements IListCapableControl

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_AUTOCOMPLETE_NO Auto-complete entry field: NO.
static int	FLAG_AUTOCOMPLETE_YES Auto-complete entry field: YES.
static int	FLAG_BACKGROUND Background color.
static int	FLAG_FILENAME Use file name in contents.
static int	FLAG_FOREGROUND Foreground color.
static int	FLAG_HINDI Hindi digits.
static int	FLAG_NOCASE Not case sensitive list.
static int	FLAG_NODISABLE Don't disable for host field.
static int	FLAG_RTL RTL.
static int	FLAG_USERCHGLIGHTEVENT User change light event on all document changes.
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	isDirectChecked Indicates if every character pressed is checked.
int	length Length of entry field data.
int	listType List type.
int	maxDropDownRows Row count for drop-down list, zero for old-style.
String	objectName Object name.
String	text Text prompt.

Fields inherited from class se.entra.phantom.server.PhantomListCapableControl

isHostConverted, isSorted

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
PhantomCComboBox(PhantomFile data) Constructor for Designer control.
PhantomCComboBox(PhantomFile data, PhantomPanelData panelData, int index, PhantomControlBase controlBase) Creates an instance of the control class.
PhantomCComboBox(PhantomPanelData panelData, PhantomControlBase controlBase, PhantomHostField hostField, Vector<String> list, boolean isUneditable) Creates a combo 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.
protected int	getBaseDataSize() Gets the base data size of the extending control.
String	getControlObjectID() Needs override by the control if the object instance if not resolved in this class instance.
int	getFieldType() Gets the field type.
String	getFileName() Gets the filename for this control.
int	getFont() Gets the font.
PhantomHostField	getHostField() Gets the host field.
String	getHostFieldID() Gets the host field ID for this control.
String	getHostFieldName() Gets the host field name.
String	getID() Gets the ID.
int	getLength() Gets the length of the entry field.
PhantomObject	getObject() Gets the object, null for none.
boolean	hasFileName() Checks for filename.
boolean	hasValueRange() Checks for value range, spin button only.
boolean	isActionConnectedEnabled() Checks if a control is action connected to another.
boolean	isCaseSensitive() Is list case sensitive.
boolean	isDirectChecked() Check for direct-checked when user types a character.
boolean	isNeverDisabled() Should combobox never be disabled.
void	rebind() Re-bind the panel data.
void	reloadObject() Reload object reference.
void	save(PhantomOutputFile file) Saves the instance 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.PhantomListCapableControl

getContentSize, getDataSize, getFileListContent, getListContent, getListConversion, getLists, getLists, getLists, getLists, getReferencedFiles, isSorted, loadContents, saveContents, updateReferences

Methods inherited from class se.entra.phantom.server.PhantomControl

addControlID, addControlReference, addHostFieldReference, appendBaseTransaction, checkTextPromptReferences, checkTextPromptReferences, clone, create, createNPObject, equals, getApplicationData, getBackgroundColor, getDesignerControl, getForegroundColor, getHostField, getIndex, getNPObjectExtra, getNPObjectID, getObject, getPanelData, getTypeDescription, getTypeDescriptionID, initializeDesignerControls, processColorConversion, processColorConversion, processColorConversion, processDisabledBackground, resolveComponentReferences, saveBase, setBackgroundColor, setForegroundColor, setIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface se.entra.phantom.server.IListCapableControl

getBackgroundColor, getFileListContent, getForegroundColor, getLists, isSorted, processColorConversion

Field Detail

FLAG_NOCASE

public static final int FLAG_NOCASE

Not case sensitive list.

See Also:

Constant Field Values

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_NODISABLE

public static final int FLAG_NODISABLE

Don't disable for host field.

See Also:

Constant Field Values

FLAG_USERCHGLIGHTEVENT

public static final int FLAG_USERCHGLIGHTEVENT

User change light event on all document changes.

See Also:

Constant Field Values

FLAG_FILENAME

public static final int FLAG_FILENAME

Use file name in contents.

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_AUTOCOMPLETE_YES

public static final int FLAG_AUTOCOMPLETE_YES

Auto-complete entry field: YES.

See Also:

Constant Field Values

FLAG_AUTOCOMPLETE_NO

public static final int FLAG_AUTOCOMPLETE_NO

Auto-complete entry field: NO.

See Also:

Constant Field Values

text

public String text

Text prompt.

objectName

public String objectName

Object name.

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

Font index.

flags

public int flags

Control flags.

fieldType

public int fieldType

Field type.

listType

public int listType

List type. 0=both, 1=drop-down list, 2=simple.

length

public int length

Length of entry field data.

isDirectChecked

public boolean isDirectChecked

Indicates if every character pressed is checked.

maxDropDownRows

public int maxDropDownRows

Row count for drop-down list, zero for old-style.

Constructor Detail

PhantomCComboBox

public PhantomCComboBox(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:
  + id                  BYTE [9]
  + object              BYTE [9]
  + fieldType           USHORT
  + fieldName           BYTE [9]
  + reserved            BYTE [3]
  + listType            BYTE
  + hostConversion      BYTE
  + preDefinedSize      USHORT
  + length              USHORT
  + font                USHORT
  + foregroundColor     BYTE
  + sortListFlag        BYTE
  + directCheckFlag     BYTE
  + flags               BYTE
  + newFlags            USHORT
  + reserved            BYTE [10]
 

Then additional data for combobox is read (list content, from file or predefined).

Throws:

IOException - if an I/O error occurs.

PhantomCComboBox

public PhantomCComboBox(PhantomFile data)
                 throws IOException

Constructor for Designer control.

Throws:

IOException - For I/O errors.

PhantomCComboBox

public PhantomCComboBox(PhantomPanelData panelData,
                        PhantomControlBase controlBase,
                        PhantomHostField hostField,
                        Vector<String> list,
                        boolean isUneditable)

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

Method Detail

hasFileName

public boolean hasFileName()

Checks for filename.

Specified by:

hasFileName in class PhantomListCapableControl

getBaseDataSize

protected int getBaseDataSize()

Gets the base data size of the extending control.

Specified by:

getBaseDataSize in class PhantomListCapableControl

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

 Base:
  + id                  BYTE [9]
  + object              BYTE [9]
  + fieldType           USHORT
  + fieldName           BYTE [9]
  + reserved            BYTE [3]
  + listType            BYTE
  + hostConversion      BYTE
  + preDefinedSize      USHORT
  + length              USHORT
  + font                USHORT
  + foregroundColor     BYTE
  + sortListFlag        BYTE
  + directCheckFlag     BYTE
  + flags               BYTE
  + newFlags            USHORT
  + reserved            BYTE [10]
 

Then additional data for combobox is read (list content, from file or predefined).

Specified by:

save in class PhantomControl

Parameters:

file -

Throws:

IOException - if an I/O error occurs.

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

reloadObject

public void reloadObject()
                  throws IOException

Reload object reference.

Specified by:

reloadObject in class PhantomControl

Throws:

IOException

isNeverDisabled

public boolean isNeverDisabled()

Should combobox never be disabled.

Specified by:

isNeverDisabled in interface IListCapableControl

isCaseSensitive

public boolean isCaseSensitive()

Is list case sensitive.

Specified by:

isCaseSensitive in interface IListCapableControl

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.

getFileName

public String getFileName()

Gets the filename for this control.

Returns:

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

isActionConnectedEnabled

public boolean isActionConnectedEnabled()

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

Overrides:

isActionConnectedEnabled in class PhantomControl

getID

public String getID()

Gets the ID.

Specified by:

getID in interface IListCapableControl

Overrides:

getID in class PhantomControl

getLength

public int getLength()

Gets the length of the entry field.

Specified by:

getLength in interface IListCapableControl

getFieldType

public int getFieldType()

Gets the field type.

Specified by:

getFieldType in interface IListCapableControl

isDirectChecked

public boolean isDirectChecked()

Check for direct-checked when user types a character.

Specified by:

isDirectChecked in interface IListCapableControl

getObject

public PhantomObject getObject()

Gets the object, null for none.

Specified by:

getObject in interface IListCapableControl

Overrides:

getObject in class PhantomControl

getFont

public int getFont()

Gets the font.

Specified by:

getFont in interface IListCapableControl

getHostField

public PhantomHostField getHostField()

Gets the host field.

Specified by:

getHostField in interface IListCapableControl

getHostFieldName

public String getHostFieldName()

Gets the host field name.

Specified by:

getHostFieldName in interface IListCapableControl

hasValueRange

public boolean hasValueRange()

Checks for value range, spin button only.

Specified by:

hasValueRange in interface IListCapableControl

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.

Overrides:

addNPObjects in class PhantomListCapableControl

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.

Overrides:

equalsControl in class PhantomListCapableControl