se.entra.phantom.server

Class PhantomListCapableControl

java.lang.Object

se.entra.phantom.server.PhantomControl

se.entra.phantom.server.PhantomListCapableControl

All Implemented Interfaces:

Cloneable, PhantomControlFlags, PhantomControlType

Direct Known Subclasses:

PhantomCComboBox, PhantomCSpinButton

public abstract class PhantomListCapableControl
extends PhantomControl

Abstract class used by combobox and spin button.

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isDirectChecked Indicates if every character pressed is checked.
boolean	isHostConverted Flag for list is host converted.
boolean	isSorted Flag indicating list requires sorting.

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

Modifier	Constructor and Description
	PhantomListCapableControl(PhantomPanelData panelData, int index, PhantomControlBase controlBase) Constructor matching PhantomControl.
protected	PhantomListCapableControl(PhantomPanelData panelData, int index, PhantomControlBase controlBase, Vector<String> list) Constructor matching PhantomControl but 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 abstract int	getBaseDataSize() Gets the base data size of the extending control.
protected int	getContentSize() The content size of the lists.
int	getDataSize(PhantomOutputFile outputFile) Get the size when saved to file.
FileListContent	getFileListContent() Gets the file list contents instance, it is null if no external file is used.
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.
abstract boolean	hasFileName() Checks for filename.
boolean	isSorted() If the list is sorted.
protected void	loadContents(boolean hasValueRange, PhantomFile data, int size) Loads the contents of the list or file name.
protected void	saveContents(PhantomOutputFile file) Saves the contents of the lists.
void	updateReferences(ApplicationReferences refs, String descr) 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, rebind, reloadObject, resolveComponentReferences, save, saveBase, setBackgroundColor, setForegroundColor, setIndex, updateGuiOnTheFlyValue, updateReferences

Methods inherited from class java.lang.Object

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

Field Detail

isHostConverted

public boolean isHostConverted

Flag for list is host converted.

isSorted

public boolean isSorted

Flag indicating list requires sorting.

isDirectChecked

public boolean isDirectChecked

Indicates if every character pressed is checked.

Constructor Detail

PhantomListCapableControl

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

Constructor matching PhantomControl.

PhantomListCapableControl

protected PhantomListCapableControl(PhantomPanelData panelData,
                                    int index,
                                    PhantomControlBase controlBase,
                                    Vector<String> list)

Constructor matching PhantomControl but for GUI-on-the-fly.

Method Detail

hasFileName

public abstract boolean hasFileName()

Checks for filename.

getBaseDataSize

protected abstract int getBaseDataSize()

Gets the base data size of the extending control.

loadContents

protected final void loadContents(boolean hasValueRange,
                                  PhantomFile data,
                                  int size)
                           throws IOException

Loads the contents of the list or file name.

Throws:

IOException - For file errors.

isSorted

public final boolean isSorted()

If the list is sorted.

getFileListContent

public final FileListContent getFileListContent()

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

getReferencedFiles

public final 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.

getContentSize

protected final int getContentSize()

The content size of the lists.

getDataSize

public final int getDataSize(PhantomOutputFile outputFile)

Get the size when saved to file.

Specified by:

getDataSize in class PhantomControl

saveContents

protected final void saveContents(PhantomOutputFile file)
                           throws IOException

Saves the contents of the lists.

Throws:

IOException - For write errors.

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

getListConversion

public final Vector<String> getListConversion()

Gets the current conversion list.

Returns:

The conversion list, or null if no conversion.

getListContent

public final Vector<String> getListContent()

Gets the current content list.

Returns:

The content list.

getLists

public final 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 final 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 final 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 final 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.

updateReferences

public void updateReferences(ApplicationReferences refs,
                             String descr)

Updates the Applications References instance.

addNPObjects

protected void addNPObjects(ENPObject obj)

Gets the NPObject for the control.

Specified by:

addNPObjects in class PhantomControl