VirtualPullDownMenu (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.VirtualPullDownMenu

All Implemented Interfaces:

VirtualChangeEvent, VirtualInterface, VirtualTooltipInterface
```
public class VirtualPullDownMenu
extends Object
implements VirtualInterface, VirtualTooltipInterface, VirtualChangeEvent
```
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 pull-down menu that can have up to (theoretical) 64 KB menu items, but because of a Phantom Hurricane bug, this class only handles 999 items (for compatibility).

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`index` The index of this pull-down menu within the menu.
`protected VirtualMenuItem[]`	`menuItems` The menu items.
`protected VirtualChangeEvent`	`owner` The owner of this pull-down menu (the menu bar or the pop-up menu).
`protected VirtualTextPrompt`	`textData` The virtual text data.

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

Constructor Summary

Constructors
Constructor and Description
`VirtualPullDownMenu(VirtualPanel vp, PhantomMenu menuData, VirtualChangeEvent owner)` Creates the pull-down menu with all associated sub-menus and menu items.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`void`	`fireUpdate(Transaction trans)` Fires the update transaction to the client.
`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.
`VirtualMenuItem`	`getMenuItem(int index)` Gets the menu item by index (zero based).
`int`	`getMenuItemCount()` Gets the menu item by index (zero based).
`VirtualInterface`	`getMenuItemFromIndex(int menuIndex)` 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.
`String`	`getTooltipText()` Gets the tool tip text of this component.
`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 this pull-down menu.
`boolean`	`isEnabled()` Gets the enabled state of an item.
`void`	`issueAction(Transaction trans, int menuIndex)` 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 colorIndex)` Sets the background color of an item (range 1-30).
`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`	`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 (range 1-30).
`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 tool tip text to a value for this component.
`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
  - owner
```
protected VirtualChangeEvent owner
```
    The owner of this pull-down menu (the menu bar or the pop-up menu).
  - menuItems
```
protected VirtualMenuItem[] menuItems
```
    The menu items.
  - textData
```
protected VirtualTextPrompt textData
```
    The virtual text data.
  - index
```
protected int index
```
    The index of this pull-down menu within the menu.
- Constructor Detail
  - VirtualPullDownMenu
```
public VirtualPullDownMenu(VirtualPanel vp,
                           PhantomMenu menuData,
                           VirtualChangeEvent owner)
```
    Creates the pull-down menu with all associated sub-menus and menu items.
- Method Detail
  - 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.
  - fireCreate
```
public void fireCreate(Transaction trans)
```
    Fires the create transaction to the client.
    The following data is sent to the client:
```
 + STRING    textPrompt
 + BYTE      menuItemCount
 + BYTE      bit0=reserved, bit1=isEnabled, bit2=isChecked
 
```
  - fireUpdate
```
public void fireUpdate(Transaction trans)
```
    Fires the update transaction to the client.
    The following data is sent to the client if the pull-down menu text or state (checked/enabled) has changed.
```
 + SHORT     index of pull-down menu
 + BYTE      bit0=isTextChanged, bit1=isEnabled, bit2=isChecked
 + STRING    if bit0=isTextChanged is set, nothing otherwise
 
```
  - 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.
  - issueAction
```
public void issueAction(Transaction trans,
                        int menuIndex)
```
    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 pull-down menu is responsible to direct the action to the appropriate menu item.
  - getMenuItemCount
```
public int getMenuItemCount()
```
    Gets the menu item by index (zero based).
  - getMenuItem
```
public VirtualMenuItem getMenuItem(int index)
```
    Gets the menu item by index (zero based).
  - getMenuItemFromIndex
```
public VirtualInterface getMenuItemFromIndex(int menuIndex)
```
    Gets a menu item VirtualInterface from a menu index.
    
    Returns:
    
    null for invalid menu index.
  - 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 tool tip 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 pop-up menus
  - setEnabled
```
public boolean setEnabled(boolean state)
```
    Sets the enabled state of an item.
    
    Specified by:
    
    setEnabled in interface VirtualInterface
    
    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.
  - 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 (range 1-30).
    
    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 (range 1-30).
    
    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 failure.
  - isChecked
```
public int isChecked()
```
    Gets the check state of this pull-down menu.
    
    Specified by:
    
    isChecked in interface VirtualInterface
    
    Returns:
    
    0 unchecked.
  - 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 succesful 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.
    If a control supports being called, it must override this method and return true.
    
    Specified by:
    
    callControl in interface VirtualInterface
    
    Returns:
    
    false the control doesn't support being "called".
  - 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

Class VirtualPullDownMenu

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

owner

menuItems

textData

index

Constructor Detail

VirtualPullDownMenu

Method Detail

textFileChanged

refresh

refreshTextPrompts

areTextPromptsAlwaysRefreshed

fireCreate

fireUpdate

hostScreenChanged

issueAction

getMenuItemCount

getMenuItem

getMenuItemFromIndex

setProperty

setTooltipText

getTooltipText

getProperty

setText

getText

setEnabled

isEnabled

setVisible

isVisible

setColor

getColor

setForegroundColor

getForegroundColor

setBackgroundColor

getBackgroundColor

setFont

getFont

setFocus

setFocus

selectField

getLength

setLength

setChecked

isChecked

getLineCount

insertLine

setLine

getLine

deleteLine

deleteAll

setCell

getCell

setSelection

getNextSelection

setFileFromList

setListFromFile

callControl

setChanged

hasChanged