]> git.mxchange.org Git - addressbook-swing.git/blob - Addressbook/src/org/mxchange/addressbook/menu/BaseMenu.java
A lot refacturings ...
[addressbook-swing.git] / Addressbook / src / org / mxchange / addressbook / menu / BaseMenu.java
1 /*
2  * Copyright (C) 2015 Roland Haeder
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17 package org.mxchange.addressbook.menu;
18
19 import java.text.MessageFormat;
20 import java.util.ArrayList;
21 import java.util.Iterator;
22 import java.util.List;
23 import org.mxchange.addressbook.BaseFrameworkSystem;
24 import org.mxchange.addressbook.client.Client;
25 import org.mxchange.addressbook.menu.item.SelectableMenuItem;
26
27 /**
28  *
29  * @author Roland Haeder
30  */
31 public class BaseMenu extends BaseFrameworkSystem {
32
33         /**
34          * Menu list
35          */
36         private List<SelectableMenuItem> menuList;
37
38         /**
39          * No instance from this object
40          */
41         protected BaseMenu () {
42         }
43
44         /**
45          * Size of menu items
46          *
47          * @return Count of menu items
48          */
49         public int getMenuItemsCount () {
50                 return this.menuList.size();
51         }
52
53         /**
54          * "Getter" for an iterator of this menu's items
55          *
56          * @return An iterator of all menu items
57          */
58         public Iterator<SelectableMenuItem> getMenuItemsIterator () {
59                 return this.menuList.iterator();
60         }
61
62         /**
63          * Shows this menu
64          *
65          * @param client Client instance to call back
66          */
67         public void show (final Client client) {
68                 // Trace message
69                 this.getLogger().trace(MessageFormat.format("client={0} CALLED!", client)); //NOI18N
70
71                 // Client must not be null
72                 if (client == null) {
73                         // Abort here
74                         throw new NullPointerException("client is null"); //NOI18N
75                 }
76
77                 // Get values
78                 Iterator<SelectableMenuItem> iterator = this.menuList.iterator();
79
80                 // Debug message
81                 this.getLogger().debug("Showing menu with '" + this.menuList.size() + "' entries.");
82
83                 // Output all menus
84                 while (iterator.hasNext()) {
85                         // Get item
86                         SelectableMenuItem item = iterator.next();
87
88                         // Show this item
89                         item.show(client);
90                 }
91
92                 // Trace message
93                 this.getLogger().trace("EXIT!"); //NOI18N
94         }
95
96         /**
97          * Getter for menu list
98          *
99          * @return      menuList List of menu entries
100          */
101         protected final List<SelectableMenuItem> getMenuList () {
102                 return this.menuList;
103         }
104
105         /**
106          * Initializes menu
107          *
108          * @param menuType      Menu type to initialize
109          * @param client CLient to call back
110          */
111         protected void initMenu (final String menuType, final Client client) {
112                 // Trace message
113                 this.getLogger().trace(MessageFormat.format("menuType={0},client={1} - CALLED!", menuType, client)); //NOI18N
114
115                 // Init menu list
116                 this.menuList = new ArrayList<>(5);
117
118                 // Trace message
119                 this.getLogger().trace("EXIT!"); //NOI18N
120         }
121 }