se.entra.phantom.server

Class VirtualCExternalImage

java.lang.Object

se.entra.phantom.server.VirtualCExternalImage

All Implemented Interfaces:

VirtualInterface, VirtualUserWindowInterface

public class VirtualCExternalImage
extends Object
implements VirtualUserWindowInterface

Displays an external image on the client.

Field Summary

Fields inherited from interface se.entra.phantom.server.VirtualInterface

TOOLTIP_TEXT

Constructor Summary

Constructors

Constructor and Description
VirtualCExternalImage(VirtualCUserWindow userWindow, PhantomCUserWindow data) Creates the external image.

Method Summary

Modifier and Type	Method and Description
boolean	areTextPromptsAlwaysRefreshed() If the class has a need to refresh the text prompt at all host changed, it must reply true to this method call.
boolean	callControl() "Calls" the control in question.
void	clientUpdated(Transaction trans) This method is called from the VirtualPanel to cause a client transaction to update the panels.
boolean	deleteAll() Deletes all lines in a list capable control.
boolean	deleteLine(int line) Deletes a line in a list capable control.
void	dispose() This method is called whenever a panel has been disposed of, in order to remove listeners, etc, in order to free up memory.
void	fireCreate(Transaction trans) This method fires the creation data transaction to the client.
void	fireUpdate(Transaction trans) This method is used to fire an update message to the client by a virtual class.
int	getBackgroundColor() Gets the 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() Get color of an item.
int	getFont() Gets the font index of an item.
int	getForegroundColor() Gets the 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.
void	hostScreenChanged(PhantomHostScreen screen) The connected host screen has changed.
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.
void	issueAction(Transaction trans) This method is invoked by the server kernel whenever a user window has issued an action on the client side.
boolean	isVisible() Gets the visibility state of an item.
void	refresh() This method is used to refresh all virtual controls when e.g.
void	refreshTextPrompts() This method is used to refresh all virtual controls when e.g.
boolean	selectField() Performs a visual selection of the field.
boolean	setBackgroundColor(int colorIndex) Sets the background color of an item.
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 newcolor) Set 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.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualCExternalImage

public VirtualCExternalImage(VirtualCUserWindow userWindow,
                             PhantomCUserWindow data)

Creates the external image.

Method Detail

dispose

public void dispose()

This method is called whenever a panel has been disposed of, in order to remove listeners, etc, in order to free up memory. Normal controls doesn't need to do anything here.

Specified by:

dispose in interface VirtualUserWindowInterface

hostScreenChanged

public void hostScreenChanged(PhantomHostScreen screen)

The connected host screen has changed. This can cause a need to change the host screen for host fields.

Specified by:

hostScreenChanged in interface VirtualUserWindowInterface

refresh

public void refresh()

This method is used to refresh all virtual controls when e.g. a new panel is created or when any host change occurs.

Specified by:

refresh in interface VirtualUserWindowInterface

refreshTextPrompts

public void refreshTextPrompts()

This method is used to refresh all virtual controls when e.g. a new panel is created or recreated.

Specified by:

refreshTextPrompts in interface VirtualUserWindowInterface

areTextPromptsAlwaysRefreshed

public boolean areTextPromptsAlwaysRefreshed()

If the class has a need to refresh the text prompt at all host changed, it must reply true to this method call. Otherwise return false.

A class extending VirtualControl have to override this method and return true if the text prompts need a constant refresh.

Specified by:

areTextPromptsAlwaysRefreshed in interface VirtualUserWindowInterface

fireCreate

public void fireCreate(Transaction trans)

This method fires the creation data transaction to the client. The first thing must be to call the superclass.

Specified by:

fireCreate in interface VirtualUserWindowInterface

fireUpdate

public void fireUpdate(Transaction trans)

This method is used to fire an update message to the client by a virtual class.

Specified by:

fireUpdate in interface VirtualUserWindowInterface

clientUpdated

public void clientUpdated(Transaction trans)

This method is called from the VirtualPanel to cause a client transaction to update the panels. This method provides the appropriate control behavior, matching the client request.

Specified by:

clientUpdated in interface VirtualUserWindowInterface

issueAction

public void issueAction(Transaction trans)

This method is invoked by the server kernel whenever a user window has issued an action on the client side. Every updateable control (in the VirtualNnnn classes) are set to reflect the changes made on the client side.

Specified by:

issueAction in interface VirtualUserWindowInterface

setProperty

public boolean setProperty(String propertyName,
                           Object property)

Sets a property of a virtual component.

Specified by:

setProperty in interface VirtualInterface

Returns:

true for successful operation.
false for failure.

getProperty

public Object getProperty(String propertyName)

Gets a property of a virtual component.

Specified by:

getProperty in interface VirtualInterface

Returns:

Object The object containing the property.
null for failure.

setText

public boolean setText(String text)

Sets the text of an item.

Specified by:

setText in interface VirtualInterface

Returns:

true for successful operation.

getText

public String getText()

Gets the text of an item.

Specified by:

getText in interface VirtualInterface

Returns:

null for no text support.

setEnabled

public boolean setEnabled(boolean state)

Sets the enabled state of an item.

Specified by:

setEnabled in interface VirtualInterface

Returns:

false failure.

isEnabled

public boolean isEnabled()

Gets the enabled state of an item.

Specified by:

isEnabled in interface VirtualInterface

Returns:

false failure.

setVisible

public boolean setVisible(boolean state)

Sets the visibility state of an item.

Specified by:

setVisible in interface VirtualInterface

Returns:

false failure, not supported.

isVisible

public boolean isVisible()

Gets the visibility state of an item.

Specified by:

isVisible in interface VirtualInterface

Returns:

true item is visible.

setColor

public boolean setColor(se.entra.phantom.geditor.NPPColor newcolor)

Set the color of an item.

Specified by:

setColor in interface VirtualInterface

Returns:

false for failure.

getColor

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

Get color of an item.

Specified by:

getColor in interface VirtualInterface

Returns:

NPPColor foreground and background color of the item. null Failure.

setForegroundColor

public boolean setForegroundColor(int colorIndex)

Sets the foreground color of an item.

Specified by:

setForegroundColor in interface VirtualInterface

Returns:

false for failure.

getForegroundColor

public int getForegroundColor()

Gets the foreground color of an item.

Specified by:

getForegroundColor in interface VirtualInterface

Returns:

-1 for failure.

setBackgroundColor

public boolean setBackgroundColor(int colorIndex)

Sets the background color of an item.

Specified by:

setBackgroundColor in interface VirtualInterface

Returns:

false for failure.

getBackgroundColor

public int getBackgroundColor()

Gets the background color of an item.

Specified by:

getBackgroundColor in interface VirtualInterface

Returns:

-1 for failure.

setFont

public boolean setFont(int font)

Sets the font index of an item.

Specified by:

setFont in interface VirtualInterface

Returns:

false for failure.

getFont

public int getFont()

Gets the font index of an item.

Specified by:

getFont in interface VirtualInterface

Returns:

0 no font is used.

setFocus

public boolean setFocus()

Sets focus in the panel to this item.

Specified by:

setFocus in interface VirtualInterface

Returns:

false for failure.

setFocus

public boolean setFocus(PhantomHostFieldLocation hostFieldLocation)

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

Specified by:

setFocus in interface VirtualInterface

Returns:

false for failure.

selectField

public boolean selectField()

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

Specified by:

selectField in interface VirtualInterface

Returns:

false for failure.

getLength

public int getLength()

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

Specified by:

getLength in interface VirtualInterface

Returns:

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

setLength

public boolean setLength(int length)

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

Specified by:

setLength in interface VirtualInterface

Returns:

true for successful operation.
false for failure.

setChecked

public boolean setChecked(int state)

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

Specified by:

setChecked in interface VirtualInterface

Returns:

false for failure.

isChecked

public int isChecked()

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

Specified by:

isChecked in interface VirtualInterface

Returns:

-1 failure.

getLineCount

public int getLineCount()

Gets the line count for a list capable control.

Specified by:

getLineCount in interface VirtualInterface

Returns:

-1 failure.

insertLine

public boolean insertLine(String data,
                          int line)

Inserts a line in a list capable control.

Specified by:

insertLine in interface VirtualInterface

Returns:

false for failure.

setLine

public boolean setLine(String data,
                       int line)

Sets a line in a list capable control.

Specified by:

setLine in interface VirtualInterface

Returns:

false for failure.

getLine

public String getLine(int line)

Sets a line in a list capable control.

Specified by:

getLine in interface VirtualInterface

Returns:

null for failure.

deleteLine

public boolean deleteLine(int line)

Deletes a line in a list capable control.

Specified by:

deleteLine in interface VirtualInterface

Returns:

false for failure.

deleteAll

public boolean deleteAll()

Deletes all lines in a list capable control.

Specified by:

deleteAll in interface VirtualInterface

Returns:

false for failure.

setCell

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

Sets a single cell in a list capable control.

Specified by:

setCell in interface VirtualInterface

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

public String getCell(int col,
                      int line)

Gets a single cell in a list capable control.

Specified by:

getCell in interface VirtualInterface

Parameters:

col - The column for the cell.

line - The line for the column.

Returns:

The contents of the cell.

setSelection

public boolean setSelection(int line,
                            boolean select)

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

Specified by:

setSelection in interface VirtualInterface

Returns:

false for failure.

getNextSelection

public int getNextSelection(int line)

Gets the next selected line in a list capable control.

Specified by:

getNextSelection in interface VirtualInterface

Returns:

-1 failure.

setFileFromList

public boolean setFileFromList(PhantomOutputFile pFile)

Insert the contents of a list into a file. true for successful operation.
false for failure.

Specified by:

setFileFromList in interface VirtualInterface

Returns:

true for successful operation.
false for failure.

setListFromFile

public boolean setListFromFile(String fileName)

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

Specified by:

setListFromFile in interface VirtualInterface

Parameters:

fileName - the file name.

Returns:

false for failure.

callControl

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

Specified by:

callControl in interface VirtualInterface

Returns:

false failure.