se.entra.phantom.server

Interface VirtualInterface

All Known Subinterfaces:

AdminFileTransferInterface, VirtualServerUserWindowInterface, VirtualUserWindowInterface

All Known Implementing Classes:

PHED_AVAILABLECOLORS, RCONSOLE_AVAILABLECOLORS, RCONSOLE_COLORCHOOSER, RCONSOLE_FILEMANAGER, RCONSOLE_FILETRANSFER, RCONSOLE_FONTMETRICS, RCONSOLE_HTML, RCONSOLE_JMXRMI, RCONSOLE_LISTHEADERCOLOR, RCONSOLE_PROGRESSBAR, RCONSOLE_TERMINAL, VirtualCBar, VirtualCBusGraph, VirtualCCheckBox, VirtualCComboBox, VirtualCEntryField, VirtualCExternalImage, VirtualCGroupBox, VirtualCListBox, VirtualCListCapableControl, VirtualCMLE, VirtualCNoteBook, VirtualControl, VirtualCOutputText, VirtualCPushButton, VirtualCRadioButton, VirtualCRectangle, VirtualCSpinButton, VirtualCStaticText, VirtualCSubWindow, VirtualCTree, VirtualCUnknown, VirtualCUserWindow, VirtualMenuItem, VirtualPanel, VirtualPopupMenu, VirtualPopupMenuItem, VirtualPullDownMenu, VirtualServerUserWindowAdapter

public interface VirtualInterface

This interface is implemented by the VirtualPanel, VirtualMenu and VirtualControl. It is used by the server extensions to access and manipulate panels and their contents.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TOOLTIP_TEXT

Method Summary

Modifier and Type	Method and Description
boolean	callControl() "Calls" the control in question.
boolean	deleteAll() Deletes all lines in a list capable control.
boolean	deleteLine(int line) Deletes a line in a list capable control.
int	getBackgroundColor() Gets the old style index background color of an item.
String	getCell(int col, int line) Gets a single cell in a list capable control.
se.entra.phantom.geditor.NPPColor	getColor() Gets the color of an item.
int	getFont() Gets the font index of an item.
int	getForegroundColor() Gets the old style index foreground color of an item.
int	getLength() Gets the control length.
String	getLine(int line) Sets a line in a list capable control.
int	getLineCount() Gets the line count for a list capable control.
int	getNextSelection(int line) Gets the next selected line in a list capable control.
Object	getProperty(String propertyName) Gets a property of a virtual component.
String	getText() Gets the text of an item.
boolean	insertLine(String data, int line) Inserts a line in a list capable control.
int	isChecked() Gets the check state of a control (e.g.
boolean	isEnabled() Gets the enabled state of an item.
boolean	isVisible() Gets the visibility state of an item.
boolean	selectField() Performs a visual selection of the field.
boolean	setBackgroundColor(int index) Sets the background color of an item from old style index.
boolean	setCell(int col, int line, String data) Sets a single cell in a list capable control.
boolean	setChecked(int state) Sets the check state of a control (e.g.
boolean	setColor(se.entra.phantom.geditor.NPPColor color) Sets the color of an item.
boolean	setEnabled(boolean state) Sets the enabled state of an item.
boolean	setFileFromList(PhantomOutputFile pFile) Insert the contents of a list into a file.
boolean	setFocus() Sets focus in the panel to this item.
boolean	setFocus(PhantomHostFieldLocation hostFieldLocation) Sets focus in the panel to this item according to a host field location.
boolean	setFont(int font) Sets the font index of an item.
boolean	setForegroundColor(int colorIndex) Sets the foreground color of an item from old style index.
boolean	setLength(int length) Sets the control length.
boolean	setLine(String data, int line) Sets a line in a list capable control.
boolean	setListFromFile(String fileName) Sets the contents of a list capable control from a file.
boolean	setProperty(String propertyName, Object property) Sets a property of a virtual component.
boolean	setSelection(int line, boolean select) Sets a line as selected (or not) in a list capable control.
boolean	setText(String text) Sets the text of an item.
boolean	setVisible(boolean state) Sets the visibility state of an item.

Field Detail

TOOLTIP_TEXT

static final String TOOLTIP_TEXT

See Also:

Constant Field Values

Method Detail

setProperty

boolean setProperty(String propertyName,
                    Object property)

Sets a property of a virtual component.

Returns:

true for successful operation.
false for failure.

getProperty

Object getProperty(String propertyName)

Gets a property of a virtual component.

Returns:

Object The object containing the property.
null for failure.

setText

boolean setText(String text)

Sets the text of an item.

Returns:

true for successful operation.
false for failure.

getText

String getText()

Gets the text of an item.

Returns:

null for no text support.

setEnabled

boolean setEnabled(boolean state)

Sets the enabled state of an item.

Returns:

true for successful operation.
false for failure.

isEnabled

boolean isEnabled()

Gets the enabled state of an item.

Returns:

true item is enabled.
false item is disabled or failure.

setVisible

boolean setVisible(boolean state)

Sets the visibility state of an item.

Returns:

true for successful operation.
false for failure.

isVisible

boolean isVisible()

Gets the visibility state of an item.

Returns:

true item is visible.
false item is hidden or failure.

setColor

boolean setColor(se.entra.phantom.geditor.NPPColor color)

Sets the color of an item.

Returns:

true for successful operation.
false for failure.

getColor

se.entra.phantom.geditor.NPPColor getColor()

Gets the color of an item.

Returns:

NPPColor background color index.
null for failure.

setForegroundColor

boolean setForegroundColor(int colorIndex)

Sets the foreground color of an item from old style index. See NPPColorItemManager for color indexes.

Returns:

true for successful operation.
false for failure.

getForegroundColor

int getForegroundColor()

Gets the old style index foreground color of an item. See NPPColorItemManager for color indexes.

Returns:

int foreground color index.
-1 for failure.

setBackgroundColor

boolean setBackgroundColor(int index)

Sets the background color of an item from old style index. See NPPColorItemManager for color indexes.

Returns:

true for successful operation.
false for failure.

getBackgroundColor

int getBackgroundColor()

Gets the old style index background color of an item. See NPPColorItemManager for color indexes.

Returns:

int background color index.
-1 for failure.

setFont

boolean setFont(int font)

Sets the font index of an item.

Returns:

true for successful operation.
false for failure.

getFont

int getFont()

Gets the font index of an item.

Returns:

0-nn font index.
-1 for failure.

setFocus

boolean setFocus()

Sets focus in the panel to this item.

Returns:

true for successful operation.
false for failure.

setFocus

boolean setFocus(PhantomHostFieldLocation hostFieldLocation)

Sets focus in the panel to this item according to a host field location.

Returns:

true for successful operation.
false for failure.

selectField

boolean selectField()

Performs a visual selection of the field. It is mainly used for entry capable controls.

Returns:

true for successful operation.
false for failure.

getLength

int getLength()

Gets the control length. It is mainly used for entry capable controls.

Returns:

-1 for error (getLength not implemented for control)
0-nn control length.

setLength

boolean setLength(int length)

Sets the control length. It is mainly used for entry capable controls that is not host connected.

Returns:

true for successful operation.
false for failure.

setChecked

boolean setChecked(int state)

Sets the check state of a control (e.g. check box) or a menu item.

Returns:

true for successful operation.
false for failure.

isChecked

int isChecked()

Gets the check state of a control (e.g. check box) or a menu item.

Returns:

0 item is unchecked.
1 item is checked.
2 item is in third state.
-1 for failure.

getLineCount

int getLineCount()

Gets the line count for a list capable control.

Returns:

0-nn the count of lines.
-1 failure.

insertLine

boolean insertLine(String data,
                   int line)

Inserts a line in a list capable control.

Returns:

true for successful operation.
false for failure.

setLine

boolean setLine(String data,
                int line)

Sets a line in a list capable control.

Returns:

true for successful operation.
false for failure.

getLine

String getLine(int line)

Sets a line in a list capable control.

Returns:

null for failure, otherwise the string.

deleteLine

boolean deleteLine(int line)

Deletes a line in a list capable control.

Returns:

true for successful operation.
false for failure.

deleteAll

boolean deleteAll()

Deletes all lines in a list capable control.

Returns:

true for successful operation.
false for failure.

setCell

boolean setCell(int col,
                int line,
                String data)

Sets a single cell in a list capable control.

Parameters:

col - The column for the cell.

line - The line for the column.

data - The data for the cell.

Returns:

True for successful operation
false for failure.

getCell

String getCell(int col,
               int line)

Gets a single cell in a list capable control.

Parameters:

col - The column for the cell.

line - The line for the column.

Returns:

The contents of the cell.

setSelection

boolean setSelection(int line,
                     boolean select)

Sets a line as selected (or not) in a list capable control.

Returns:

true for successful operation.
false for failure.

getNextSelection

int getNextSelection(int line)

Gets the next selected line in a list capable control.

Returns:

0-nn the next selected line.
-1 no more selected lines or failure.

setFileFromList

boolean setFileFromList(PhantomOutputFile pFile)

Insert the contents of a list into a file.

Returns:

true for successful operation.
false for failure.

setListFromFile

boolean setListFromFile(String fileName)
                 throws IOException

Sets the contents of a list capable control from a file.

Parameters:

fileName - the file name.

Returns:

true for successful operation.
false for failure.

Throws:

IOException - for file failures.

callControl

boolean callControl()

"Calls" the control in question. It is used by push buttons and menu items. When called, it generates a transaction to the client that causes it to update the server immediately. When this transaction is received, the control is "called", much like if the user had pressed and released the push button or selected the menu item.

Returns:

true for successful operation.
false the control doesn't support being "called".