/* File: MenuSupport.java */
 
package O2PlibSS.gui;

import java.util.*;
import java.awt.*;
import java.awt.event.*;

/** 
 * Class MenuSupport contains various Menu support
 * functions for helping implement and support dynamic submenus
 * of MenuItem or CheckboxMenuItem types. It tracks both entities
 * in separate hash tables by either their associated command string
 * or their MenuItem or CheckboxMenuItem instances. It supports
 * radio groups using a common command name prefix ending in ':'.
 * E.g., "Open:Sample:" with  "Open:Sample:a1" "Open:Sample:a2"
 * and "Open:Sample:a2" being in the same radio group. The event
 * handler is in the parent calling these methods.
 *<P>
 * NOTE: event handlers are in the parent.
 *<P>
 * <P> 
 * This code is available at the HTMLtools project on SourceForge at
 * <A HREF="http://htmltools.sourceforge.org/">http://htmltools.sourceforge.org/</A>
 * under the "Common Public License Version 1.0" 
 * <A HREF="http://www.opensource.org/licenses/cpl1.0.php">
 * http://www.opensource.org/licenses/cpl1.0.php</A>.<P></P>
 * <P>
 * It was derived and refactored from the open source
 * MAExplorer (http://maexplorer.sourceforge.org/), and
 * Open2Dprot (http://Open2Dprot.sourceforge.net/) Table modules.
 * <P>
 * $Date: 2009/07/03 11:45:56 $ $Revision: 1.28 $
 * <BR> 
 * Copyright 2008, 2009 by Peter Lemkin 
 * E-Mail: lemkin@users.sourceforge.net 
 * <A HREF="http://lemkingroup.com/">http://lemkingroup.com/</A>
 */

public class MenuSupport 
{  
  
  /** Initial max number of menu items allowed. */
  final public static  int
    MAX_CMDS= 101;                      /* was 101, 3001, 1001, 501 */
  /** max number of menu checkbox items allowed */
  final public static  int
    MAX_CHKBOX_CMDS= 501;  
  
  /** Initial max number of menu items allowed. */
   public int
     maxMenuItems= MAX_CMDS;
  /** initial max number of menu checkbox items allowed */
   public int
     maxCheckboxMenuItems= MAX_CHKBOX_CMDS;
               
  /** Name of this MenuSupport instance */ 
  public String
    name;
               
  /** Hashtable of ALL menu items. The key is the MenuItem.
   * The value is the MenuCmdData.
   */ 
  public Hashtable
    menuItemDataHT;
  /** Hashtable of ALL menu items. The key is the command.
   * The value is the MenuCmdData.
   */ 
  public Hashtable  
    menuItemCmdHT;
               
  /** Hashtable of ALL checkboxItem menu items.
   * The key is the CheckboxMenuItem.
   * The value is the ChkBoxMenuData intance.
   */ 
  public Hashtable  
    chkBoxMenuItemDataHT;
  /** Hashtable of ALL checkboxItem menu items.
   * The key is the command.
   * The value is the ChkBoxMenuData intance.
   */ 
  public Hashtable  
    chkBoxMenuItemCmdHT;
  
    
  /**
   * MenuSupport() - Constructor. use default hash table sizes.
   */
  public MenuSupport()
  { /* MenuSupport */
    maxMenuItems= MAX_CMDS;
    maxCheckboxMenuItems= MAX_CHKBOX_CMDS;
    init("none", maxMenuItems, maxCheckboxMenuItems);
  } /* MenuSupport */
  
  /**
   * MenuSupport() - Constructor. use default hash table sizes.
   * @param name of this menu support instance
   */
  public MenuSupport(String name)
  { /* MenuSupport */
    maxMenuItems= MAX_CMDS;
    maxCheckboxMenuItems= MAX_CHKBOX_CMDS;
    init(name, maxMenuItems, maxCheckboxMenuItems);
  } /* MenuSupport */
 
    
  /**
   * MenuSupport() - Constructor. 
   * @param name of this menu support instance
   * @param maxMenuItems - initial maximum size of Menu Items in menubar
   * @param maxCheckboxMenuItems - initial maximum size of Checkbox Menu
   *    Items in menubar
   */
  public MenuSupport(String name, int maxMenuItems, int maxCheckboxMenuItems)
  { /* MenuSupport */ 
    init(name, maxMenuItems, maxCheckboxMenuItems);
  } /* MenuSupport */  
  
  
  /**
   * init() - create empty hash tables. 
   * @param name of this menu support instance 
   * @param maxMenuItems - initial maximum size of Menu Items in menubar
   * @param maxCheckboxMenuItems - initial maximum size of Checkbox Menu
   *    Items in menubar
   */
  public void init(String name, int maxMenuItems, int maxCheckboxMenuItems)
  { /* init */
    this.name= name;
    this.maxMenuItems= maxMenuItems;
    this.maxCheckboxMenuItems= maxCheckboxMenuItems;   
    
    /* setup menu item and checkbox menu item hash boxes */
    menuItemDataHT= new Hashtable(MAX_CMDS);
    menuItemCmdHT= new Hashtable(MAX_CMDS);
    chkBoxMenuItemDataHT= new Hashtable(MAX_CHKBOX_CMDS);
    chkBoxMenuItemCmdHT= new Hashtable(MAX_CHKBOX_CMDS);
  } /* init */
  
  
  /**
   * makeMenuItem() - make menuItem entry in menu list.
   * Setup action command and listener call back.
   * If the command name is null, set the command name to label name.
   * if shortCut is <0, then gray-out the item. i.e. not available and
   * do not add to event handler.
   * @param fm is the frame that contains Action listener for this item
   * @param pm is the menu to install new MenuItem
   * @param sLabel is the visible label
   * @param sCmd is the opt Cmd name (uses sLabel if null)
   * @param shortcut is the opt short cut
   * @return the menu item
   */
  public MenuItem makeMenuItem(Frame fm, Menu pm, String sLabel, String sCmd, 
                                int shortcut )
  { /*makeMenuItem */
    MenuItem mi= new MenuItem(sLabel);
    if(sCmd==null)
      sCmd= sLabel;		                   /* use same string for both */
    mi.setActionCommand(sCmd);           /* separate string for CMD & LABEL*/
    
    if(shortcut>=0)
    { /* actionListener in this class */
      mi.addActionListener((ActionListener)fm);
    }
    else
      mi.setEnabled(false);
        
    /* Put menu item into MenuCmdData hash tables */
    menuItemDataHT.put((Object)mi, 
                       (Object)(new MenuCmdData(sLabel,sCmd,mi)));
    menuItemCmdHT.put(sCmd, 
                      (Object)(new MenuCmdData(sLabel,sCmd,mi)));
    
    if(shortcut>0)
    {
      MenuShortcut
      msc= new MenuShortcut(shortcut);
      mi.setShortcut(msc);	              /* optional shortcut */
    }
    
    pm.add(mi);
        
    return(mi);
  } /* makeMenuItem */

  
  /**
   * makeSubMenu() - make submenu entry in menu list.
   * Setup action command and listener call back.
   * If the command name is null, set the command name to label name.
   * @param fm is the frame 
   * @param pm is the menu to install new submenu in
   * @param sLabel is the visible label
   * @param sCmd is the opt Cmd name (uses sLabel if null)
   * @param shortcut is the opt short cut
   */
  public Menu makeSubMenu(Frame fm, Menu pm, String sLabel, String sCmd,
                           int shortcut)
  { /* makeSubMenu*/
    Menu mi= new Menu(sLabel);
    if(shortcut!=0)
    {
      MenuShortcut msc= new MenuShortcut(shortcut);
      mi.setShortcut(msc);	       /* optional shortcut */
    }
    pm.add(mi);
    return(mi);
  } /* makeSubMenu*/
  
  
  /**
   * makeChkBoxMenuItem() - make CheckboxMenuItem entry in popup menu list.
   * Setup action command and listener call back.
   * If the command name is null, set the command name to label name.
   * if shortCut is <0, then gray-out the item. i.e. not available and
   * do not add to event handler.
   * @param fm is the frame that contains Item listener for this item
   * @param pm is the menu to install new CheckboxMenuItem in
   * @param sLabel is the visible label
   * @param sCmd is the opt Cmd name (uses sLabel if null)
   * @param shortcut is the opt short cut
   * @param value is the initial value of the checkbox
   */
  public CheckboxMenuItem makeChkBoxMenuItem(Frame fm, Menu pm, String sLabel, 
                                              String sCmd, int shortcut, 
                                              boolean value )
  { /* makeChkBoxMenuItem */
    CheckboxMenuItem cbmi= new CheckboxMenuItem(sLabel,value);
    
    cbmi.setState(value);
    if(sCmd==null)
      sCmd= sLabel;		             /* use same string for both */
    cbmi.setActionCommand(sCmd);     /* separate string for CMD and  LABEL */
    if(shortcut>=0)
    { /* actionListener in this class */
      cbmi.addItemListener((ItemListener)fm);    
    }
    else
      cbmi.setEnabled(false);
    
    if(shortcut>0)
    {
      MenuShortcut  msc= new MenuShortcut(shortcut);
      cbmi.setShortcut(msc);	      /* optional shortcut */
    }
    
    /* Put menu item into ChkBoxMenuData hash tables */
    chkBoxMenuItemDataHT.put((Object)cbmi, 
                             (Object)(new ChkBoxMenuData(sLabel,sCmd,cbmi)));
    chkBoxMenuItemCmdHT.put(sCmd, 
                            (Object)(new ChkBoxMenuData(sLabel,sCmd,cbmi)));
    
    pm.add(cbmi);
    
    return(cbmi);
  } /* makeChkBoxMenuItem*/
 
      
  /**
   * lookupMenuItem() - lookup MenuItem entry in menu list.
   * @param sCmd is the opt Cmd name to search the hash table
   * for (key,value)=(cmd,MenuCmdData) and returning the MenuItem
   * if found.
   * @return the MenuItem instance if found, else null
   */
  public MenuItem lookupMenuItem(String sCmd)
  { /* lookupMenuItem */
    if(sCmd==null)
      return(null);
    
    MenuCmdData mcd= (MenuCmdData)menuItemCmdHT.get(sCmd);
    if(mcd==null)
      return(null);
    
    MenuItem mi= mcd.mi;
    
    return(mi);
  } /* lookupMenuItem */
 
      
  /**
   * lookupMenuItem() - lookup MenuItem entry by MenuItem in menu list.
   * @param mi is the MenuItem instance to searching the hash table
   * for (key,value)=(MenuItem,MenuCmdData) and returning the command
   * if found.
   * @param miDataHT is the hash table storing
   * @return the menu item command name if found, else null
   */
  public String lookupMenuItem(MenuItem mi)
  { /* lookupMenuItem */
    if(mi==null)
      return(null);
    
    MenuCmdData mcd= (MenuCmdData)menuItemDataHT.get(mi);
    if(mcd==null)
      return(null);
    
    String cmd= mcd.cmd;
    
    return(cmd);
  } /* lookupMenuItem */
 
      
  /**
   * lookupChkboxMenuItem() - lookup CheckboxMenuItem entry in menu list
   * by searching (key,value)=(cmd,ChkBoxMenuData) and returning the 
   * CheckboxMenuItem if found.
   * @param sCmd is the opt Cmd name to search for
   * @param cbmiCmdHT is the hash table storing
   * @return the CheckboxMenuItem item instance if found, else null
   */
  public CheckboxMenuItem lookupChkboxMenuItem(String sCmd)
  { /* lookupChkboxMenuItem */
    if(sCmd==null)
      return(null);
    
    ChkBoxMenuData cbmd= (ChkBoxMenuData)chkBoxMenuItemCmdHT.get(sCmd);
    if(cbmd==null)
      return(null);  
    
   CheckboxMenuItem cbmi= cbmd.cbmi;
    
    return(cbmi);
  } /* lookupChkboxMenuItem */
 
      
  /**
   * lookupChkboxMenuItem() - lookup String command entry in 
   * checkbox menu item list by searching 
   * (key,value)=(CheckboxMenuItem,ChkBoxMenuData) and returning
   * the command if found.
   * @param cbmi is the CheckboxMenuItem to search for
   * @return the string command name of the checkbox menu item if 
   *  found, else null
   */
  public String lookupChkboxMenuItem(CheckboxMenuItem cbmi)
  { /* lookupChkboxMenuItem */
    if(cbmi==null)
      return(null);
    
    ChkBoxMenuData cbmd= (ChkBoxMenuData)chkBoxMenuItemDataHT.get(cbmi);
    if(cbmd==null)
      return(null);  
    
   String cmd= cbmd.cmd;
    
    return(cmd);
  } /* lookupChkboxMenuItem */ 
  
  
  /**
   * lookupMenuItemLabel() - lookup CheckboxMenuItem entry label
   * in menu list by searching (key,value)=(cmd,MenuCmdData) and
   * returning the menu label if found.
   * @param sCmd is the opt Cmd name to search for
   * @return the MenuItem item instance menu label if found, else null
   */
  public String lookupMenuItemLabel(String sCmd)
  { /* lookupMenuItemLabel */
    if(sCmd==null)
      return(null);
    
    MenuCmdData mcd= (MenuCmdData)menuItemCmdHT.get(sCmd);
    if(mcd==null)
      return(null);
        
   String menuLabel= mcd.menuLabel;
    
    return(menuLabel);
  } /* lookupMenuItemLabel */
  
  
  /**
   * lookupChkboxMenuItemLabel() - lookup CheckboxMenuItem entry label
   * in menu list by searching (key,value)=(cmd,ChkBoxMenuData) and
   * returning the menu label if found.
   * @param sCmd is the opt Cmd name to search for
   * @return the CheckboxMenuItem item instance menu label if found,
   *       else null
   */
  public String lookupChkboxMenuItemLabel(String sCmd)
  { /* lookupChkboxMenuItemLabel */
    if(sCmd==null)
      return(null);
    
    ChkBoxMenuData cbmd= (ChkBoxMenuData)chkBoxMenuItemCmdHT.get(sCmd);
    if(cbmd==null)
      return(null);  
    
   String menuLabel= cbmd.menuLabel;
    
    return(menuLabel);
  } /* lookupChkboxMenuItemLabel */
 
  
  /**
   * clearSublistChkMenuItemStates() -  clear all of the checkbox menu items
   * in the radio group. The members of the radio
   * group are determined by the command prefix up to the last ':' in the 
   * command name for the checkbox menu item.
   * @param cbmi is the CheckboxMenuItem that is part of a radio group.
   * @return true if succeed
   */
  public boolean clearSublistChkMenuItemStates(String preface)
  { /* clearSublistChkMenuItemStates */
    String entryList[]= getCmdListCBMIbyPreface(preface);
    if(entryList==null)
      return(false);
    
    for(int i=0; i<entryList.length;i++)
    { /* clear entries with same prefix */
      String sCmd= entryList[i];
      CheckboxMenuItem cbmi= lookupChkboxMenuItem(sCmd);
      if(cbmi!=null)
        cbmi.setState(false);
    }
    
    return(true);
  }/* clearSublistChkMenuItemStates */
  
          
  /**
   * clearSublistChkMenuItemStates() -  clear all of the checkbox menu items
   * in the radio group. The members of the radio group are determined by 
   * the same command prefix up to the last ':' in the command name for 
   * the checkbox menu item.
   * @param cbmi is the CheckboxMenuItem that is part of a radio group.
   * @return true if succeed
   */
  public boolean clearSublistChkMenuItemStates(CheckboxMenuItem cbmi)
  { /* clearSublistChkMenuItemStates */
    String sCmd= lookupChkboxMenuItem(cbmi);
    int idx= sCmd.lastIndexOf(":");
    if(idx==-1)
      return(false);
    String preface= sCmd.substring(0,idx+1);  /* upto and including ':' */
    
    Enumeration keyList= chkBoxMenuItemCmdHT.keys();
    if(keyList==null)
      return(false);
    int maxSize= chkBoxMenuItemCmdHT.size();  /* Worst case */
    String
      key,
      subList[]= new String[maxSize];
    int nList= 0;
    for(Enumeration e= keyList; e.hasMoreElements();)
    { /* get list of keys with same prefix */
      key= (String)e.nextElement();
      if(key==null)
        continue;
      if(!key.startsWith(preface))
        continue;
      subList[nList++]= key;
    }
    
    if(nList==0)
      return(false);
    
    for(int i=0; i<nList;i++)
    { /* Remove entires in list with the same prefix */
      String cmd= subList[i];
      CheckboxMenuItem cbmk= lookupChkboxMenuItem(cmd);
      if(cbmk!=null)
        cbmk.setState(false);
    }
    
    return(true);
  } /* clearSublistChkMenuItemStates */
 
          
  /**
   * setRadioSublistChkMenuItemStates() - Do radio function by clearing
   * all of the checkbox menu items except the one mentioned which is 
   * set to true. The members of the radio group are determined by the 
   * same command prefix up to the last ':' in the command name for the 
   * checkbox menu item.
   * @param sCmd is the command string for theCheckboxMenuItem that is 
   *        part of a radio group.
   * @return true if succeed
   */
  public boolean setRadioSublistChkMenuItemStates(String sCmd)
  { /* setRadioSublistChkMenuItemStates */
    CheckboxMenuItem cbmi= lookupChkboxMenuItem(sCmd);
    return(setRadioSublistChkMenuItemStates(cbmi));
  } /* setRadioSublistChkMenuItemStates */
 
          
  /**
   * setRadioSublistChkMenuItemStates() - Do radio function by clearing
   * all of the checkbox menu items except the one mentioned which is 
   * set to true. The members of the radio group are determined by the 
   * same command prefix up to the last ':' in the command name for the 
   * checkbox menu item.
   * @param cbmi is the CheckboxMenuItem that is part of a radio group.
   * @return true if succeed
   */
  public boolean setRadioSublistChkMenuItemStates(CheckboxMenuItem cbmi)
  { /* setRadioSublistChkMenuItemStates */
    if(!clearSublistChkMenuItemStates(cbmi))
      return(false);
    
    /* force this entry to be true */
    cbmi.setState(true);
    
    return(true);
  } /* setRadioSublistChkMenuItemStates */
 
          
  /**
   * getRadioSublistChkMenuItemStates() - Do radio function by clearing
   * all of the checkbox menu items except the one mentioned which is 
   * set to true. The members of the radio group are determined by the 
   * command prefix up to the last ':' in the command name for the same
   * checkbox menu item. It returns the command for the checkbox.
   * @param cbmi is the CheckboxMenuItem that is part of a radio group.
   * @return command of the checkbox item, null if a problem
   */
  public String getRadioSublistChkMenuItemStates(CheckboxMenuItem cbmi)
  { /* getRadioSublistChkMenuItemStates */
    if(!clearSublistChkMenuItemStates(cbmi))
      return(null);
    
    /* force this entry to be true */
    cbmi.setState(true);
    String sCmd= lookupChkboxMenuItem(cbmi);
    
    return(sCmd);
  } /* getRadioSublistChkMenuItemStates */
 
          
  /**
   * getCmdListCBMIbyPreface() -  get list of all of the commands
   * in the checkbox menu items with a common command prefix ending with
   * a ':'.
   * @param cbmi is the CheckboxMenuItem that is part of a radio group.
   * @return true if succeed
   */
  public String[] getCmdListCBMIbyPreface(String preface)
  { /* getCmdListCBMIbyPreface */
    if(preface==null)
      return(null);
    
    Enumeration keyList= chkBoxMenuItemCmdHT.keys();
    if(keyList==null)
      return(null);
    int maxSize= chkBoxMenuItemCmdHT.size();  /* Worst case */
    String
      key,
      subList[]= new String[maxSize];
    int nList= 0;
    for(Enumeration e= keyList; e.hasMoreElements();)
    { /* get list of keys with same prefix */
      key= (String)e.nextElement();
      if(key==null)
        continue;
      if(!key.startsWith(preface))
        continue;
      subList[nList++]= key;
    }
    
    if(nList==0)
      return(null);
    
    /* Make list exact size */
    String tmp[]= new String[nList];
    for(int i=0;i<nList;i++)
      tmp[i]= subList[i];
    subList= tmp;             /* use shortened list */
    
    return(subList);
  } /* getCmdListCBMIbyPreface */
 
          
  /**
   * getMenuLabelListCBMIbyPreface() - get list of all of the menu labels
   * in the checkbox menu items with a common command prefix endinting with
   * a ':'.
   * @param cbmi is the CheckboxMenuItem that is part of a radio group.
   * @return true if succeed
   */
  public String[] getMenuLabelListCBMIbyPreface(String preface)
  { /* getMenuLabelListCBMIbyPreface */
    if(preface==null)
      return(null);
    
    Enumeration keyList= chkBoxMenuItemCmdHT.keys();
    if(keyList==null)
      return(null);
    int maxSize= chkBoxMenuItemCmdHT.size();  /* Worst case */
    String
      key,
      subList[]= new String[maxSize];
    int nList= 0;
    for(Enumeration e= keyList; e.hasMoreElements();)
    { /* get list of keys with same prefix */
      key= (String)e.nextElement();
      if(key==null)
        continue;
      if(!key.startsWith(preface))
        continue;
      
      ChkBoxMenuData cbmd= (ChkBoxMenuData)chkBoxMenuItemCmdHT.get(key);
      if(cbmd!=null)
        continue;
      subList[nList++]= cbmd.menuLabel;
    }
    
    if(subList==null)
      return(null);
    
    return(subList);
  } /* getMenuLabelListCBMIbyPreface */
  
  
  /**
   * rebuildChkBoxSubmenu() - rebuild a submenu with a new entry list
   * indicated by menu labels from entryList[], the commands are
   * preface+entryList[]. 
   * First all entries are removed from the subMenu before
   * new entries being added. Then the new entries are added. It also
   * maintains the hash tables.
   * @param fm is the frame that contains this submenu
   * @param submenu to change contents
   * @param preface is added to each entry's command string
   * @param entryList of entries menu labels to add
   * @param activeEntry (if not null) to set true
   * @return true if suceed
   */
  public boolean rebuildChkBoxSubmenu(Frame fm, Menu submenu, 
                                      String preface, String entryList[],
                                      String activeEntry)
  { /* rebuildChkBoxSubmenu */
    if(entryList==null || preface==null)
      return(false);
    //int nEntries= entryList.length;          /* for debugging ... */
    
    String
      sEntry,
      sCmd,
      origEntryList[]= getCmdListCBMIbyPreface(preface);
    
    /* Remove original entries list if exists */
    if(origEntryList!=null)
    { /* remove old hash table entries */
      int nOrigEntryList= origEntryList.length;
      ChkBoxMenuData cbmd;
      for(int i=0; i<nOrigEntryList;i++)
      { /* Remove old entries from hash table and submenu  */
        sCmd= origEntryList[i];
        cbmd= (ChkBoxMenuData)chkBoxMenuItemCmdHT.get(sCmd);
        if(cbmd!=null)
        { /* remove associated entry from hash table and submenu */
          CheckboxMenuItem cbmi= cbmd.cbmi;
          cbmd= (ChkBoxMenuData)chkBoxMenuItemDataHT.get(cbmi);
          chkBoxMenuItemCmdHT.remove(sCmd);
          chkBoxMenuItemDataHT.remove(cbmi);
          
         /* Remove it from the submenu */
         submenu.remove(cbmd.cbmi);  
        }
      } /* Remove old entries from hash table and submenu */
    } /* remove old hash table entries */
        
    /* Create Sample menu items */ 
    for(int i= 0;i<entryList.length;i++)
    {  /* Rebuild the menu with new entries*/  
      sEntry= entryList[i];
      if(sEntry==null || sEntry.length()==0)
        continue;                      /* ignore null or "" entries */
      sCmd= preface+sEntry;
      boolean 
        isActive= (activeEntry!=null && activeEntry.equals(sEntry));
      makeChkBoxMenuItem(fm, submenu, sEntry, sCmd, 0, isActive);
    }
    
    return(true);
  } /* rebuildChkBoxSubmenu */
  

  
  /* @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ */
  /*   MenuCmdData to hold all data associated with Menu command     */
  /* @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ */
  
  class MenuCmdData
  {
    /** Menu label */
    String
      menuLabel;
    /** Menu command */
    String
      cmd;
    /** Menu item */
    MenuItem
      mi;
    
    /**
     * MenuCmdData() - create menu data instance
     * @param menuLabel 
     * @param cmd 
     * @param mi is MenuItem
     */
    MenuCmdData(String menuLabel, String cmd, MenuItem mi)
    {
      this.menuLabel= menuLabel;
      this.cmd= cmd;
      this.mi= mi;
    }
    
  } /* end of MenuCmdData */ 
  
  
  /* @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ */
  /*   ChkBoxMenuData to hold data associated with CheckboxMenuItem  */
  /* @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ */
  
  class ChkBoxMenuData
  {
    /** CheckboxMenuItem label */
    String
      menuLabel;
    /** CheckboxMenuItem command */
    String
      cmd;
    /** Menu item */
    CheckboxMenuItem
      cbmi;
    
    /**
     * ChkBoxMenuData() - create menu data instance
     * @param menuLabel 
     * @param cmd 
     * @param cbmi is CheckboxMenuItem instance
     */
    ChkBoxMenuData(String menuLabel, String cmd, CheckboxMenuItem cbmi)
    {
      this.menuLabel= menuLabel;
      this.cmd= cmd;
      this.cbmi= cbmi;
    }
    
  } /* end of ChkBoxMenuData */
      
  
} /* end of MenuSupport class */