se.entra.phantom.server

Class VirtualPopupMenu

java.lang.Object

se.entra.phantom.server.VirtualPopupMenu

All Implemented Interfaces:

VirtualChangeEvent, VirtualInterface

public class VirtualPopupMenu
extends Object
implements VirtualInterface, VirtualChangeEvent

The virtual pop-up menu class contains references to the Phantom Pop-up Menu definition as well as to the Virtual Runtime that keeps track of which pop-up menus have been transfered to the client or not.

Field Summary

Fields

Modifier and Type	Field and Description
protected VirtualPopupMenuItem[]	menuItems The menu items.

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

TOOLTIP_TEXT

Constructor Summary

Constructors

Constructor and Description
VirtualPopupMenu(VirtualRuntimePopupMenu popupMenu, VirtualPanel vp) Creates an instance of the virtual runtime pop-up menu.

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.
boolean	deleteAll() Deletes all lines in a list capable control.
boolean	deleteLine(int line) Deletes a line in a list capable control.
void	fireCreate(Transaction trans) Fires the create transaction to the client of the pop-up menu.
void	fireUpdate(Transaction trans, int popupMenuIndexInPanel) Fires the update transaction to the client of the pop-up menu.
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.
String	getID() Gets the ID of the pop-up menu.
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.
VirtualMenuItem	getMenuItem(int ii) Gets the menu item from a zero-based index.
VirtualMenuItem	getMenuItem(String id) Gets a menu item from an ID.
int	getMenuItemCount() Gets the count of menu items.
VirtualInterface	getMenuItemFromIndex(int menuID) Gets a menu item VirtualInterface from a menu index.
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	hasChanged() Check if anything in the menu tree has been changed.
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 menu item has been pressed on the client side.
boolean	isVisible() Gets the visibility state of an item.
void	refresh() Causes the text prompt of this pull-down menu to be refreshed along with all menu items.
void	refreshTextPrompts(boolean alwaysRefresh) This method is used to refresh all virtual classes that have text prompt data in them.
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.
void	setChanged() This method is used to indicate that a virtual class has changed and that it needs to update the client.
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.
void	textFileChanged() Text file is changed, format text prompt.

Methods inherited from class java.lang.Object

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

Field Detail

menuItems

protected VirtualPopupMenuItem[] menuItems

The menu items.

Constructor Detail

VirtualPopupMenu

public VirtualPopupMenu(VirtualRuntimePopupMenu popupMenu,
                        VirtualPanel vp)

Creates an instance of the virtual runtime pop-up menu. This menu is maintained by the virtual runtime. The client will store all pop-up menus until it exits.

Method Detail

getID

public String getID()

Gets the ID of the pop-up menu.

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.

fireCreate

public void fireCreate(Transaction trans)

Fires the create transaction to the client of the pop-up menu.

fireUpdate

public void fireUpdate(Transaction trans,
                       int popupMenuIndexInPanel)

Fires the update transaction to the client of the pop-up menu.

Prior to calling this method, the parent component or class should use the method hasChanged() in order to call this method only when required.

textFileChanged

public void textFileChanged()

Text file is changed, format text prompt.

refresh

public void refresh()

Causes the text prompt of this pull-down menu to be refreshed along with all menu items.

refreshTextPrompts

public void refreshTextPrompts(boolean alwaysRefresh)

This method is used to refresh all virtual classes that have text prompt data in them. The parameter mustRefresh is set when the panel is created or recreated. If the class has a need to refresh the text prompt at all host changed, it must reply true to the method call areTextPromptsAlwaysRefreshed.

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.

issueAction

public void issueAction(Transaction trans)

This method is invoked by the server kernel whenever a menu item has been pressed on the client side. Every updateable control (in the VirtualNnnn classes) are set to reflect the changes made on the client side. The menu is responsible to direct the action to the appropriate pull-down menu.

getMenuItemFromIndex

public VirtualInterface getMenuItemFromIndex(int menuID)

Gets a menu item VirtualInterface from a menu index.

Returns:

null for invalid menu index.

getMenuItem

public VirtualMenuItem getMenuItem(String id)

Gets a menu item from an ID.

Returns:

null if not found.

getMenuItemCount

public int getMenuItemCount()

Gets the count of menu items.

getMenuItem

public VirtualMenuItem getMenuItem(int ii)

Gets the menu item from a zero-based index.

setChanged

public void setChanged()

This method is used to indicate that a virtual class has changed and that it needs to update the client. It is also notified to its parent, the virtual panel.

Specified by:

setChanged in interface VirtualChangeEvent

hasChanged

public boolean hasChanged()

Check if anything in the menu tree has been changed.

Specified by:

hasChanged in interface VirtualChangeEvent

setProperty

public boolean setProperty(String propertyName,
                           Object property)

Sets a property of a virtual component.

Specified by:

setProperty in interface VirtualInterface

Returns:

false for failure.

getProperty

public Object getProperty(String propertyName)

Gets a property of a virtual component.

Specified by:

getProperty in interface VirtualInterface

Returns:

null for failure.

setText

public boolean setText(String text)

Sets the text of an item.

Specified by:

setText in interface VirtualInterface

Returns:

false for failure.

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 for failure.

isEnabled

public boolean isEnabled()

Gets the enabled state of an item.

Specified by:

isEnabled in interface VirtualInterface

Returns:

false item is disabled or failure.

setVisible

public boolean setVisible(boolean state)

Sets the visibility state of an item.

Specified by:

setVisible in interface VirtualInterface

Returns:

false for failure.

isVisible

public boolean isVisible()

Gets the visibility state of an item.

Specified by:

isVisible in interface VirtualInterface

Returns:

false item is hidden or failure.

setColor

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

Sets the color of an item.

Specified by:

setColor in interface VirtualInterface

Returns:

false for failure.

getColor

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

Gets the color of an item.

Specified by:

getColor in interface VirtualInterface

Returns:

null for failure.

setForegroundColor

public boolean setForegroundColor(int colorIndex)

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

Specified by:

setForegroundColor in interface VirtualInterface

Returns:

false for failure.

getForegroundColor

public int getForegroundColor()

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

Specified by:

getForegroundColor in interface VirtualInterface

Returns:

-1 for failure.

setBackgroundColor

public boolean setBackgroundColor(int index)

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

Specified by:

setBackgroundColor in interface VirtualInterface

Returns:

false for failure.

getBackgroundColor

public int getBackgroundColor()

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

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:

-1 for failure.

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)

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:

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 for 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:

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:

null for failure.

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 no more selected lines or failure.

setFileFromList

public boolean setFileFromList(PhantomOutputFile pFile)

Insert the contents of a list into a file. 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 the control doesn't support being "called".