    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class xu.xu_MenuElement

    java.lang.Object
       |
       +----com.sun.java.swing.tree.DefaultMutableTreeNode
               |
               +----xg.xg_Node
                       |
                       +----xg.xg_Element
                               |
                               +----xu.xu_MenuElement

public class xu_MenuElement
extends xg_Element

An XML element to represent a Swing menu.

##

LabelAttName
  The name of the attribute which holds the label to put on this menu.
RegisteredName
  The element type name normally used in XML for this sort of element.
SeparatorTypeName
  The element type name used in XML for a menu separator.
TheMenu
  The menu created by this element.

##

xu_MenuElement()
  Construct a menu element with no name.
xu_MenuElement(String)
  Construct a menu with a name.

##

addButtonGroupContents(xu_MenuButtonGroupElement)
  Add the members of the button group in this element to the Menu.
getMenu()
  Get the menu created by this element.
getSummaryString()
  Get a summary descriptive string suitable for display in the tree view or elsewhere.
toString()
  Return a string representation of the element (intended for use as debug output).
verify()

  Verify that this node is correct (ie.

##

TheMenu

     protected JMenu TheMenu

  The menu created by this element.

RegisteredName

     public static final String RegisteredName

  The element type name normally used in XML for this sort of element.

SeparatorTypeName

     public static final String SeparatorTypeName

  The element type name used in XML for a menu separator.

LabelAttName

     public static final String LabelAttName

  The name of the attribute which holds the label to put on this menu.

##

xu_MenuElement

     public xu_MenuElement()

  Construct a menu element with no name.

xu_MenuElement

     public xu_MenuElement(String InputNodeName)

  Construct a menu with a name.

  Parameters:
    InputNodeName - The name of the element

##

verify

     public void verify() throws xg_VerificationException

  Verify that this node is correct (ie. internally correct and/or consistent with other nodes - such as its parent). The node is OK if each of its children is an xu_MenuItemElement, an xu_MenuElement, an xg_Element of type "Separator" or not an xg_Element.

  Throws: xg_VerificationException
    Description of verification problem
  Overrides:
    verify in class xg_Node

addButtonGroupContents

     public void addButtonGroupContents(xu_MenuButtonGroupElement InputMenuButtonGroupElement) throws xg_VerificationException

  Add the members of the button group in this element to the Menu.

  Throws: xg_VerificationException
    Description of verification problem

getMenu

     public JMenu getMenu()

  Get the menu created by this element.

  Returns:
    The menu itself.

getSummaryString

     public String getSummaryString()

  Get a summary descriptive string suitable for display in the tree view or elsewhere.

  Returns:
    A description suitable for display in the tree view
  Overrides:
    getSummaryString in class xg_Node

toString

     public String toString()

  Return a string representation of the element (intended for use as debug output).

  Returns:
    String representing the node'name.
  Overrides:
    toString in class xg_Element

    All Packages  Class Hierarchy  This Package  Previous  Next  Index