jv.project

## Class PgGeometry_Menu

- java.lang.Object
- - java.util.AbstractCollection<E>
  - - java.util.AbstractList<E>
    - - java.util.Vector
      - - jv.objectGui.PsMethodMenu
        - - jv.project.PgGeometry_Menu

- All Implemented Interfaces:
    java.awt.event.ActionListener, java.awt.event.ItemListener, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.EventListener, java.util.List, java.util.RandomAccess, PsUpdateIf
  Direct Known Subclasses:
    PgPointSet_Menu, PgPointSet_Menu

      public class PgGeometry_Menu
      extends PsMethodMenu

  Add specific menu items to 'method' menu in control panel to invoke methods from menu. For example, each geometry may have a menu class derived `PgGeometry_Menu` which adds additional menu items and sub menus. When the geometry is the current geometry in the viewer, then its set of method menus is added to the menu bar of the control window.

  Each geometry may add a set of menu items to submenus of the 'method' menu.

  Usage:
  In the `init()` method add new menu entries as follows:

                      addMenu("Menu-Name");
                      addMenuItem("Menu-Name", "Menu-Item-Name");

  The submenu is created if it does not exist. Catch menu events in the `applyMethod(String name)` using:

                      if (name.equals("Menu-Item-Name"))
                              // invoke method related with "Menu-Item-Name".

  See Also:
    `PsMethodMenu`, Serialized Form

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `java.lang.String[]` | `m_geometryMethod`
    `static int` | `MTHD_PRINT_ALL`
    `static int` | `MTHD_PRINT_BNDBOX`
    `static int` | `MTHD_PRINT_CENTER`
    `static int` | `MTHD_SHOW_BNDBOX`
    `static int` | `MTHD_SHOW_CENTER`
    `static int` | `MTHD_SHOW_NAME`
    `static int` | `MTHD_UPDATE`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `PgGeometry_Menu()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `applyMethod(java.lang.String aMethod)` Invoke action determined by current string.
    `PvViewerIf` | `getViewer()` Get viewer which enables access to displays and inspectors.
    `void` | `init(PsObject anObject)` Register the target geometry, and subclasses should register all menu items and submenus.
    `void` | `setViewer(PvViewerIf viewer)` Set viewer enable access to displays and inspectors.
    `boolean` | `update(java.lang.Object event)` Update this menu if the parent object has changed.

    - ### Methods inherited from class jv.objectGui.PsMethodMenu

      `actionPerformed, addMenu, addMenu, addMenuItem, addMenuItem, addMenuItem, clone, getFather, getLanguage, getMenu, getMenuItem, getName, getPanelVersion, hasMenu, hasMenuItem, itemStateChanged, removeMenu, removeMenuItem, setName, setParent`

    - ### Methods inherited from class java.util.Vector

      `add, add, addAll, addAll, addElement, capacity, clear, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, retainAll, set, setElementAt, setSize, size, subList, toArray, toArray, toString, trimToSize`

    - ### Methods inherited from class java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### MTHD_UPDATE

          public static final int MTHD_UPDATE

      See Also:
        Constant Field Values

    - #### MTHD_PRINT_ALL

          public static final int MTHD_PRINT_ALL

      See Also:
        Constant Field Values

    - #### MTHD_PRINT_CENTER

          public static final int MTHD_PRINT_CENTER

      See Also:
        Constant Field Values

    - #### MTHD_PRINT_BNDBOX

          public static final int MTHD_PRINT_BNDBOX

      See Also:
        Constant Field Values

    - #### MTHD_SHOW_NAME

          public static final int MTHD_SHOW_NAME

      See Also:
        Constant Field Values

    - #### MTHD_SHOW_BNDBOX

          public static final int MTHD_SHOW_BNDBOX

      See Also:
        Constant Field Values

    - #### MTHD_SHOW_CENTER

          public static final int MTHD_SHOW_CENTER

      See Also:
        Constant Field Values

    - #### m_geometryMethod

          public java.lang.String[] m_geometryMethod

  - ### Constructor Detail

    - #### PgGeometry_Menu

          public PgGeometry_Menu()

  - ### Method Detail

    - #### init

          public void init(PsObject anObject)

      Description copied from class: `PsMethodMenu`
      Register the target geometry, and subclasses should register all menu items and submenus.
      Overrides:
        `init` in class `PsMethodMenu`
      Parameters:
        `anObject` - argument used by subclasses to specify object on which action shall be executed.

    - #### update

          public boolean update(java.lang.Object event)

      Update this menu if the parent object has changed. Set the state of CheckboxMenuItems depending on the states of the parent geometry.
      Specified by:
        `update` in interface `PsUpdateIf`
      Overrides:
        `update` in class `PsMethodMenu`
      Parameters:
        `event` - carries a lot of information
      Returns:
        true if event has been handled, otherwise false
      See Also:
        `PsMethodMenu.setParent(PsUpdateIf)`, `PsMethodMenu.getFather()`

    - #### applyMethod

          public boolean applyMethod(java.lang.String aMethod)

      Description copied from class: `PsMethodMenu`
      Invoke action determined by current string. This method returns `false`, and should be overwritten by subclasses.
      Overrides:
        `applyMethod` in class `PsMethodMenu`

    - #### getViewer

          public PvViewerIf getViewer()

      Get viewer which enables access to displays and inspectors.
      Since:
        JavaView 2.45
      See Also:
        `setViewer(PvViewerIf)`

    - #### setViewer

          public void setViewer(PvViewerIf viewer)

      Set viewer enable access to displays and inspectors.
      Since:
        JavaView 2.45
      See Also:
        `getViewer()`

"

The software JavaView? is copyright protected. All Rights Reserved.
"