View Javadoc
1   package edu.asu.cri.MirkE.menu;
2   
3   import java.util.ArrayList;
4   import java.util.List;
5   
6   /***
7    * This class represents a menu list containing child menu items/menu lists
8    * 
9    * @author Siva B.S.D.S
10   * @version $Id: MenuList.java,v 1.2 2004/12/31 21:15:31 smenor Exp $
11   */
12  public class MenuList
13  {
14      /***
15       * Menu item name key (if name key is null/empty string, that means, this
16       * list object is root menu list)
17       */
18      private String nameKey = null;
19      
20      /***
21       * Menu item name
22       */
23      private String name = null;
24  
25      /***
26       * Access key stroke
27       */
28      private String accessKeyStroke = null;
29      
30      /***
31       * Child items under this menu
32       */
33      private List childItems = null;
34  
35      /***
36       * returns item name
37       * 
38       * @return item name
39       */
40      public String getName()
41      {
42          return name;
43      }
44  
45      /***
46       * returns item name key
47       * 
48       * @return item name key
49       */
50      public String getNameKey()
51      {
52          return nameKey;
53      }
54  
55      /***
56       * Returns access key stroke
57       * 
58       * @return access key stroke
59       */
60      public String getAccessKeyStroke()
61      {
62          return accessKeyStroke;
63      }
64  
65      /***
66       * sets access key stroke
67       * 
68       * @param accessKeyStrokeArg access key stroke
69       */
70      public void setAccessKeyStroke(String accessKeyStrokeArg)
71      {
72          accessKeyStroke = accessKeyStrokeArg;
73      }
74  
75      /***
76       * sets item name
77       * @param nameArg item name
78       */
79      public void setName(String nameArg)
80      {
81          name = nameArg;
82      }
83  
84      /***
85       * sets item name key
86       * @param nameKeyArg item name key
87       */
88      public void setNameKey(String nameKeyArg)
89      {
90          nameKey = nameKeyArg;
91      }
92  
93      /***
94       * Returns all the client items
95       * 
96       * @return all the client items
97       */
98      public List getChildItems()
99      {
100         return childItems;
101     }
102 
103     /***
104      * Adds new child menu item
105      * 
106      * @param menuItem
107      */
108     public void addChildItem(MenuItem menuItem)
109     {
110         if (childItems == null)
111         {
112             childItems = new ArrayList();
113         }
114         childItems.add(menuItem);
115     }
116 
117     /***
118      * Adds new child menu list
119      * 
120      * @param menuList
121      */
122     public void addChildItem(MenuList menuList)
123     {
124         if (childItems == null)
125         {
126             childItems = new ArrayList();
127         }
128         childItems.add(menuList);
129     }
130     
131 }