se.entra.phantom.server

Class PhantomCComboBox

java.lang.Object

se.entra.phantom.server.PhantomControl

se.entra.phantom.server.PhantomCComboBox

All Implemented Interfaces:

Cloneable, PhantomControlFlags, PhantomControlType

public class PhantomCComboBox
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_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.
boolean	isHostConverted Flag for list is host converted.
boolean	isSorted Flag indicating list requires sorting.
int	length Length of entry field data.
int	listType List type.
String	objectName Object name.
String	text Text prompt.

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_UNKNOWN, CTRLTYPE_USER, 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, 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

Methods

Modifier and Type	Method and Description
FileListContent	getFileListContent() Gets the file list contents instance, it is null if no external file is used.
String	getFileName() Gets the filename for this control.
String	getHostFieldID() Gets the host field ID for this control.
Vector<String>	getListContent() Gets the current content list.
Vector<String>	getListConversion() Gets the current conversion list.
Vector<String>[]	getLists(VirtualPanel panel) Gets the lists in a two-vector array.
Vector<String>[]	getLists(VirtualPanel panel, Object[] isChanged) Gets the lists in a two-vector array.
Vector<String>[]	getLists(VirtualPanel panel, String newFN) Gets the lists in a two-vector array.
Vector<String>[]	getLists(VirtualPanel panel, String newFN, Object[] isChanged) Gets the lists in a two-vector array.
void	getReferencedFiles(ArrayList<String> files) Adds all files that are referenced by this control.
int	getSaveSize() Get the size when saved to file.
boolean	isActionConnectedEnabled() Checks if a control is action connected to another.
boolean	isCaseSensitive() Is list case sensitive.
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.

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

addControlID, appendBaseTransaction, clone, create, getApplicationData, getBackgroundColor, getControlSize, getForegroundColor, getHostField, getID, getIndex, getObject, getObject, getPanelData, processColorConversion, processColorConversion, processColorConversion, processDisabledBackground, resolveComponentReferences, saveBase, setBackgroundColor, setForegroundColor, setIndex

Methods inherited from class java.lang.Object

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

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.

isHostConverted

public boolean isHostConverted

Flag for list is host converted.

length

public int length

Length of entry field data.

isSorted

public boolean isSorted

Flag indicating list requires sorting.

isDirectChecked

public boolean isDirectChecked

Indicates if every character pressed is checked.

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 [11]
 

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

Throws:

IOException - if an I/O error occurs.

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

getFileListContent

public FileListContent getFileListContent()

Gets the file list contents instance, it is null if no external file is used.

rebind

public void rebind()

Re-bind the panel data.

Overrides:

rebind in class PhantomControl

getReferencedFiles

public void getReferencedFiles(ArrayList<String> files)

Adds all files that are referenced by this control.

Overrides:

getReferencedFiles in class PhantomControl

Parameters:

ArrayList -

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 [11]
 

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.

getSaveSize

public int getSaveSize()

Get the size when saved to file.

Specified by:

getSaveSize 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

reloadObject

public void reloadObject()
                  throws IOException

Reload object reference.

Specified by:

reloadObject in class PhantomControl

Throws:

IOException

getListConversion

public Vector<String> getListConversion()

Gets the current conversion list.

Returns:

The conversion list, or null if no conversion.

getListContent

public Vector<String> getListContent()

Gets the current content list.

Returns:

The content list.

getLists

public Vector<String>[] getLists(VirtualPanel panel)

Gets the lists in a two-vector array. The second vector may be null if no host conversion is used.

getLists

public Vector<String>[] getLists(VirtualPanel panel,
                        Object[] isChanged)

Gets the lists in a two-vector array. The second vector may be null if no host conversion is used.

The parameter "isChanged" should be null or an Object[1] array initiated with null as Object[0]. Upon return, the Object[0] member is non-null if the text is formatted according to the panel causing the file not to be able to be cached on the client.

getLists

public Vector<String>[] getLists(VirtualPanel panel,
                        String newFN)

Gets the lists in a two-vector array. The second vector may be null if no host conversion is used. The lists are sorted if specified in the combobox definition.

getLists

public Vector<String>[] getLists(VirtualPanel panel,
                        String newFN,
                        Object[] isChanged)

Gets the lists in a two-vector array. The second vector may be null if no host conversion is used. The lists are sorted if specified in the combobox definition.

The parameter "isChanged" should be null or an Object[1] array initiated with null as Object[0]. Upon return, the Object[0] member is non-null if the text is formatted according to the panel causing the file not to be possible to cache on the client.

isNeverDisabled

public boolean isNeverDisabled()

Should combobox never be disabled.

isCaseSensitive

public boolean isCaseSensitive()

Is list case sensitive.

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