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.


Variable Index

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

Constructor Index

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

Method Index

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

Verify that this node is correct (ie.

Variables

 o TheMenu
 protected JMenu TheMenu
The menu created by this element.

 o RegisteredName
 public static final String RegisteredName
The element type name normally used in XML for this sort of element.

 o SeparatorTypeName
 public static final String SeparatorTypeName
The element type name used in XML for a menu separator.

 o LabelAttName
 public static final String LabelAttName
The name of the attribute which holds the label to put on this menu.

Constructors

 o xu_MenuElement
 public xu_MenuElement()
Construct a menu element with no name.

 o xu_MenuElement
 public xu_MenuElement(String InputNodeName)
Construct a menu with a name.

Parameters:
InputNodeName - The name of the element

Methods

 o 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
 o 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
 o getMenu
 public JMenu getMenu()
Get the menu created by this element.

Returns:
The menu itself.
 o 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
 o 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