se.entra.phantom.server

Class VirtualMenuItem

java.lang.Object

se.entra.phantom.server.VirtualMenuItem

All Implemented Interfaces:

ObjectMessages, VirtualChangeEvent, VirtualClientMessages, VirtualInterface, VirtualTooltipInterface

Direct Known Subclasses:

VirtualPopupMenuItem

public class VirtualMenuItem
extends Object
implements VirtualInterface, VirtualTooltipInterface, VirtualClientMessages, VirtualChangeEvent, ObjectMessages

The panel contains a menu bar (might be displayed as a pop-up menu). The menu bar contains a number of pull-down menus. This class handles a single menu item. The functionality of the menu item is almost the same as for a push button control.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	actionKeys The action key texts.
static int	AKEY_ALT Alt control bit.
static int	AKEY_CTRL Control key bit.
static int	AKEY_MASK The key value mask.
static int	AKEY_SHIFT Shift key bit.
protected int	connectedControlIndex The connected control index.
protected PhantomHostField	hostField The virtual host field where e.g.
protected HostScreen	hostScreen The host screen.
protected PhantomMenuItem	menuItem The menu item data.
protected VirtualChangeEvent	owner The owner of this pull-down menu (the pull-down menu or the pop-up menu).
protected VirtualPanel	panel The virtual panel.
protected VirtualInterface	parent The parent VirtualPullDownMenu, VirtualMenuItem, VirtualPopupMenu or VirtualPopupMenuItem.
protected VirtualTextPrompt	textData The virtual text data.

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

TOOLTIP_TEXT

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

OBJACT_CHAR, OBJACT_CHECK, OBJACT_CLICK, OBJACT_CLOSE, OBJACT_COMMAND, OBJACT_CREATE, OBJACT_DBLCLICK, OBJACT_DDECONNECTION, OBJACT_DDEDATA, OBJACT_DDEERROR, OBJACT_DDEEXECUTE, OBJACT_DDEPOKE, OBJACT_DDEREQUEST, OBJACT_DDEVALIDATE, OBJACT_DEFOCUS, OBJACT_DESTROY, OBJACT_FOCUS, OBJACT_HIDDEN, OBJACT_HOSTCHANGE, OBJACT_LAST_MESSAGE_HANDLED, OBJACT_QUERYMSG, OBJACT_RECREATE, OBJACT_SELECT, OBJACT_SHOW, OBJACT_START, OBJACT_TRANSLATE, OBJACT_USERCHANGE, PHA_ICO_INFO, PHA_ICO_NOICON, PHA_ICO_QUESTION, PHA_ICO_STOP, PHA_ICO_WARNING, PHA_MSG_CANCEL, PHA_MSG_ENTER, PHA_MSG_ENTERCANCEL, PHA_MSG_OK, PHA_MSG_OKCANCEL, PHA_MSG_RETIGNCANCEL, PHA_MSG_RETRYCANCEL, PHA_MSG_YESNO, PHA_MSG_YESNOCANCEL

Constructor Summary

Constructors

Constructor and Description
VirtualMenuItem(VirtualPanel vp, VirtualChangeEvent owner, PhantomMenuItem menuItem) Creates the pull-down menu with all associated sub-menus and menu items.

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.
String	callObject(int action, String argString) Calls the control's object (if defined).
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.
protected void	fireCreate(Transaction trans, boolean isPopupMenu) Fires the create transaction to the client.
void	fireUpdate(Transaction trans) Fires the update transaction to the client.
protected void	fireUpdate(Transaction trans, boolean isPopupMenu) Fires the update transaction to the client.
int	getBackgroundColor() Gets the background color of an item.
PhantomMenuItem	getBasicData() Gets the menu item basic data.
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.
String	getID() Gets the ID of this menu 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.
PhantomObject	getObject() Gets the object of the menu item.
VirtualInterface	getParent() Gets the parent VirtualPullDownMenu or VirtualMenuItem, always null for pop-up menus.
VirtualPopupMenu	getPopupMenu() Gets the pop-up menu that is the owner of this menu item.
Object	getProperty(String propertyName) Gets a property of a virtual component.
VirtualPullDownMenu	getPullDownMenu() Gets the pull-down menu that is the owner of this menu item.
int	getSubMenuCount() Gets the count of menu items in this sub-menu.
String	getText() Gets the text of an item.
String	getTooltipText() Gets the tool tip text of this component.
boolean	hasChanged() Checks if the base control data with possible text data has 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 this menu item is selected 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 classes that have text prompt data in them.
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.
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) Set the color of an item.
boolean	setEnabled(boolean state) Sets the enabled state of an item.
boolean	setEnabled(boolean state, boolean isProgramatic) 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	setTooltipText(String text) Sets the tooltip text to a value for this component.
boolean	setVisible(boolean state) Sets the visibility state of an item.
void	textFileChanged() The application text file has been changed, resulting in the need to reformat text strings (such as text prompts or send strings from a text ID) in order to reflect the new text file content.

Methods inherited from class java.lang.Object

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

Field Detail

AKEY_MASK

public static final int AKEY_MASK

The key value mask.

See Also:

Constant Field Values

AKEY_SHIFT

public static final int AKEY_SHIFT

Shift key bit.

See Also:

Constant Field Values

AKEY_CTRL

public static final int AKEY_CTRL

Control key bit.

See Also:

Constant Field Values

AKEY_ALT

public static final int AKEY_ALT

Alt control bit.

See Also:

Constant Field Values

actionKeys

public static final String[] actionKeys

The action key texts.

textData

protected VirtualTextPrompt textData

The virtual text data.

owner

protected VirtualChangeEvent owner

The owner of this pull-down menu (the pull-down menu or the pop-up menu).

panel

protected VirtualPanel panel

The virtual panel.

menuItem

protected PhantomMenuItem menuItem

The menu item data.

hostScreen

protected HostScreen hostScreen

The host screen.

hostField

protected PhantomHostField hostField

The virtual host field where e.g. the send string is placed.

connectedControlIndex

protected int connectedControlIndex

The connected control index.

parent

protected VirtualInterface parent

The parent VirtualPullDownMenu, VirtualMenuItem, VirtualPopupMenu or VirtualPopupMenuItem.

Constructor Detail

VirtualMenuItem

public VirtualMenuItem(VirtualPanel vp,
                       VirtualChangeEvent owner,
                       PhantomMenuItem menuItem)

Creates the pull-down menu with all associated sub-menus and menu items.

Method Detail

getParent

public VirtualInterface getParent()

Gets the parent VirtualPullDownMenu or VirtualMenuItem, always null for pop-up menus.

getPullDownMenu

public VirtualPullDownMenu getPullDownMenu()

Gets the pull-down menu that is the owner of this menu item.

Returns:

null if the menu item is not inside a pull-down menu. For a pop-up menu this is always null. Use the method getPopupMenu instead.

getPopupMenu

public VirtualPopupMenu getPopupMenu()

Gets the pop-up menu that is the owner of this menu item.

Returns:

null if the menu item is not inside a pop-up menu. For a pull-down menu this is always null. Use the method getPullDownMenu instead.

getSubMenuCount

public int getSubMenuCount()

Gets the count of menu items in this sub-menu.

Returns:

zero if the menu item doesn't have children.

getBasicData

public PhantomMenuItem getBasicData()

Gets the menu item basic data.

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.

textFileChanged

public void textFileChanged()

The application text file has been changed, resulting in the need to reformat text strings (such as text prompts or send strings from a text ID) in order to reflect the new text file content.

Specified by:

textFileChanged in interface VirtualClientMessages

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.

A menu item is disabled if the connected host field is protected or non-display, unless the "Do not disable" option is set.

Specified by:

refresh in interface VirtualClientMessages

refreshTextPrompts

public void refreshTextPrompts()

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.

Specified by:

refreshTextPrompts in interface VirtualClientMessages

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.

Specified by:

areTextPromptsAlwaysRefreshed in interface VirtualClientMessages

fireCreate

public void fireCreate(Transaction trans)

Fires the create transaction to the client.

The following data is sent to the client:

 + STRING    textPrompt
 + BYTE      subMenuCount
 + BYTE      bit0=hasSeparator, bit1=isEnabled, bit2=isChecked
 + SHORT     actionKey (if subMenuCount is zero)
 + SHORT     connectedControlIndex (if subMenuCount is zero)
 

Specified by:

fireCreate in interface VirtualClientMessages

fireCreate

protected void fireCreate(Transaction trans,
                          boolean isPopupMenu)

Fires the create transaction to the client.

The following data is sent to the client:

 + STRING    textPrompt
 + BYTE      subMenuCount
 + BYTE      bit0=hasSeparator, bit1=isEnabled, bit2=isChecked
 + SHORT     actionKey (if subMenuCount is zero and isPopupMenu is false)
 + SHORT     connectedControlIndex (if subMenuCount is zero)
 

fireUpdate

public void fireUpdate(Transaction trans)

Fires the update transaction to the client.

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

The following data is sent to the client if the menu item text or state (checked/enabled) has changed.

 + SHORT     index of menu item
 + BYTE      bit0=isTextChanged, bit1=isEnabled, bit2=isChecked
 + STRING    if bit0=isTextChanged is set, nothing otherwise
 

Specified by:

fireUpdate in interface VirtualClientMessages

fireUpdate

protected void fireUpdate(Transaction trans,
                          boolean isPopupMenu)

Fires the update transaction to the client.

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

The following data is sent to the client if the menu item text or state (checked/enabled) has changed.

 + SHORT     index of menu item
 + BYTE      bit0=isTextChanged, bit1=isEnabled, bit2=isChecked
 + STRING    if bit0=isTextChanged is set, nothing otherwise
 + SHORT     connectedControlIndex (if subMenuCount is zero and isPopupMenu is false)
 

issueAction

public void issueAction(Transaction trans)

This method is invoked by the server kernel whenever this menu item is selected on the client side. Every updateable control (in the VirtualNnnn classes) are set to reflect the changes made on the client side.

callObject

public String callObject(int action,
                         String argString)

Calls the control's object (if defined).

Returns:

null if no object exist.

getObject

public PhantomObject getObject()

Gets the object of the menu item.

Returns:

null if no object is assigned.

getID

public String getID()

Gets the ID of this menu item.

setProperty

public boolean setProperty(String propertyName,
                           Object property)

Sets a property of a virtual component. Supported property is currently only TOOLTIP_TEXT.

Specified by:

setProperty in interface VirtualInterface

Returns:

true for successful operation.
false for failure.

setTooltipText

public boolean setTooltipText(String text)

Sets the tooltip text to a value for this component.

Specified by:

setTooltipText in interface VirtualTooltipInterface

Returns:

true for successful operation.

getTooltipText

public String getTooltipText()

Gets the tool tip text of this component.

Specified by:

getTooltipText in interface VirtualTooltipInterface

Returns:

Empty string for no tool tip (or empty), otherwise the string.

getProperty

public Object getProperty(String propertyName)

Gets a property of a virtual component. Supported property is currently only TOOLTIP_TEXT.

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:

true for successful operation.

setEnabled

public boolean setEnabled(boolean state,
                          boolean isProgramatic)

Sets the enabled state of an item.

Returns:

true for successful operation.

isEnabled

public boolean isEnabled()

Gets the enabled state of an item.

Specified by:

isEnabled in interface VirtualInterface

Returns:

true item is enabled.
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:

true for successful operation.

isVisible

public boolean isVisible()

Gets the visibility state of an item.

Specified by:

isVisible in interface VirtualInterface

Returns:

true item is visible,
false item is hidden.

setColor

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

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. See NPPColorItemManager for indexes.

Specified by:

setForegroundColor in interface VirtualInterface

Returns:

false for failure.

getForegroundColor

public int getForegroundColor()

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

Specified by:

getForegroundColor in interface VirtualInterface

Returns:

-1 for failure.

setBackgroundColor

public boolean setBackgroundColor(int colorIndex)

Sets the background color of an item. See NPPColorItemManager for indexes.

Specified by:

setBackgroundColor in interface VirtualInterface

Returns:

false for failure.

getBackgroundColor

public int getBackgroundColor()

Gets the background color of an item. See NPPColorItemManager for 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:

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:

true for success,
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:

0 unchecked,
1 checked.

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:

true success.

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()

Checks if the base control data with possible text data has changed. If this has been changed, an update transaction is required. This transaction will occur at a later point in time, by the ClientWorker thread.

The text change flag is not checked in this method, the control subclassing this class is responsible to call "setChanged()" whenever any child component of the virtual control has changed. This will guarantee that the entire chane of components, even upwards in the tree will synchronize the client panels and components.

Specified by:

hasChanged in interface VirtualChangeEvent