Gridarta Editor
MapMenuManager.java
Go to the documentation of this file.
1 /*
2  * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
3  * Copyright (C) 2000-2023 The Gridarta Developers.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 package net.sf.gridarta.gui.mapmenu;
21 
22 import javax.swing.JMenu;
23 import javax.swing.event.PopupMenuEvent;
24 import javax.swing.event.PopupMenuListener;
25 import javax.swing.tree.DefaultMutableTreeNode;
26 import javax.swing.tree.TreeNode;
34 import org.jetbrains.annotations.NotNull;
35 import org.jetbrains.annotations.Nullable;
36 
41 public class MapMenuManager<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
42 
47  @Nullable
48  private JMenu recentMenu;
49 
53  @NotNull
54  private final MapMenu mapMenu;
55 
60  @NotNull
62 
67  @NotNull
68  private final PopupMenuListener popupMenuListener = new PopupMenuListener() {
69 
70  @Override
71  public void popupMenuWillBecomeVisible(final PopupMenuEvent e) {
72  final TreeNode treeNode = mapMenu.getRoot();
73  if (recentMenu != null) {
74  updateMenu(recentMenu, treeNode);
75  }
76  }
77 
78  @Override
79  public void popupMenuWillBecomeInvisible(final PopupMenuEvent e) {
80  // ignore
81  }
82 
83  @Override
84  public void popupMenuCanceled(final PopupMenuEvent e) {
85  // ignore
86  }
87 
88  };
89 
97  public MapMenuManager(@NotNull final MapMenu mapMenu, @NotNull final MapViewsManager<?, ?, ?> mapViewsManager, @NotNull final FileControl<?, ?, ?> fileControl, @NotNull final MapImageCache<?, ?, ?> mapImageCache) {
98  this.mapMenu = mapMenu;
99  actionFactory = new ActionFactory(mapViewsManager, fileControl, mapImageCache);
100  }
101 
106  public void setMenu(@Nullable final JMenu recentMenu) {
107  if (this.recentMenu != null) {
108  this.recentMenu.getPopupMenu().removePopupMenuListener(popupMenuListener);
109  }
110  this.recentMenu = recentMenu;
111  if (this.recentMenu != null) {
112  this.recentMenu.getPopupMenu().addPopupMenuListener(popupMenuListener);
113  }
114  }
115 
119  public void initRecent() {
120  mapMenu.load();
121  }
122 
128  private void updateMenu(@NotNull final JMenu menu, @NotNull final TreeNode root) {
131  for (int i = 0; i < root.getChildCount(); i++) {
132  final DefaultMutableTreeNode treeNode2 = (DefaultMutableTreeNode) root.getChildAt(i);
133  final MapMenuEntryVisitor mapMenuEntryVisitor = new MapMenuEntryVisitor() {
134 
135  @Override
136  public void visit(@NotNull final MapMenuEntryDir mapMenuEntry) {
137  final JMenu subMenu = new JMenu(mapMenuEntry.getTitle());
138  updateMenu(subMenu, treeNode2);
139  menu.add(subMenu);
140  }
141 
142  @Override
143  public void visit(@NotNull final MapMenuEntryMap mapMenuEntry) {
144  menu.add(actionFactory.getAction(mapMenuEntry));
145  }
146 
147  };
148  ((MapMenuEntry) treeNode2.getUserObject()).visit(mapMenuEntryVisitor);
149  }
150  actionFactory.end();
151  }
152 
153 }
net.sf.gridarta.gui.mapimagecache
Definition: ImageType.java:20
net.sf.gridarta.model.mapmanager
Definition: AbstractMapManager.java:20
net.sf.gridarta.gui.mapmenu.MapMenuManager
Manages the recent menu entries.
Definition: MapMenuManager.java:41
net.sf.gridarta.gui.mapmenu.MapMenuEntry
Abstract base class for recent and bookmark menu entries.
Definition: MapMenuEntry.java:29
net.sf.gridarta.gui.mapmenu.MapMenuManager.actionFactory
final ActionFactory actionFactory
The ActionFactory for creating MapMenuActions.
Definition: MapMenuManager.java:61
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.gui.mapmenu.MapMenuManager.popupMenuListener
final PopupMenuListener popupMenuListener
The PopupMenuListener for updating recentMenu when it opens.
Definition: MapMenuManager.java:68
net.sf
net.sf.gridarta.model.mapmanager.FileControl
Definition: FileControl.java:30
net.sf.gridarta.gui.mapmenu.MapMenuManager.MapMenuManager
MapMenuManager(@NotNull final MapMenu mapMenu, @NotNull final MapViewsManager<?, ?, ?> mapViewsManager, @NotNull final FileControl<?, ?, ?> fileControl, @NotNull final MapImageCache<?, ?, ?> mapImageCache)
Creates a new instance.
Definition: MapMenuManager.java:97
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.gameobject.GameObject
Reflects a game object (object on a map).
Definition: GameObject.java:36
net.sf.gridarta.gui.mapmenu.MapMenuManager.initRecent
void initRecent()
Initializes the recent state.
Definition: MapMenuManager.java:119
net.sf.gridarta.gui.mapmenu.ActionFactory.end
void end()
Ends a lookup sequence.
Definition: ActionFactory.java:93
net.sf.gridarta.gui
Graphical User Interface of Gridarta.
net.sf.gridarta.gui.mapmenu.MapMenu
Manages the contents of a recent or bookmark menu.
Definition: MapMenu.java:46
net.sf.gridarta.gui.mapimagecache.MapImageCache
Caches icon and preview images for map files.
Definition: MapImageCache.java:53
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.gui.mapmenu.MapMenuManager.recentMenu
JMenu recentMenu
The menu to update.
Definition: MapMenuManager.java:48
net.sf.gridarta.gui.mapmenu.MapMenuManager.mapMenu
final MapMenu mapMenu
The MapMenu to use.
Definition: MapMenuManager.java:54
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.gui.mapmenu.MapMenu.load
void load()
Loads the contents from preferences.
Definition: MapMenu.java:129
net.sf.gridarta.gui.map.mapview
Definition: AbstractMapView.java:20
net.sf.gridarta.gui.mapmenu.MapMenuManager.setMenu
void setMenu(@Nullable final JMenu recentMenu)
Sets the menu to update.
Definition: MapMenuManager.java:106
net.sf.gridarta.gui.mapmenu.ActionFactory.getAction
Action getAction(@NotNull final MapMenuEntryMap mapMenuEntryMap)
Returns an Action for a MapMenuEntryMap instance.
Definition: ActionFactory.java:106
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.gui.mapmenu.MapMenu.getRoot
DefaultMutableTreeNode getRoot()
Returns the root node.
Definition: MapMenu.java:389
net.sf.gridarta.gui.map
Base classes for rendering maps.
Definition: AbstractPerMapDialogManager.java:20
net.sf.gridarta.gui.mapmenu.MapMenuEntryVisitor
Interface for classes operating on MapMenuEntry instances.
Definition: MapMenuEntryVisitor.java:28
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.gui.mapmenu.MapMenuManager.updateMenu
void updateMenu(@NotNull final JMenu menu, @NotNull final TreeNode root)
Updates a JMenu from a menu instance.
Definition: MapMenuManager.java:128
net.sf.gridarta.gui.mapmenu.MapMenuEntryMap
A MapMenuEntry that represents a map.
Definition: MapMenuEntryMap.java:29
net.sf.gridarta.gui.utils
Definition: AnimationComponent.java:20
net.sf.gridarta.gui.mapmenu.MapMenuEntryDir
A MapMenuEntry that represents a directory.
Definition: MapMenuEntryDir.java:28
net.sf.gridarta.gui.utils.MenuUtils
Utility class implementing menu related functions.
Definition: MenuUtils.java:39
net.sf.gridarta.gui.map.mapview.MapViewsManager
Stores all existing MapViews.
Definition: MapViewsManager.java:47
net.sf.gridarta.gui.mapmenu.ActionFactory
A factory for creating MapMenuAction instances.
Definition: ActionFactory.java:34
net.sf.gridarta.gui.utils.MenuUtils.removeAllFromSeparator
static void removeAllFromSeparator(@NotNull final JMenu menu)
Remove all menu entries from (but not including) the last separator.
Definition: MenuUtils.java:100
net.sf.gridarta.gui.mapmenu.ActionFactory.begin
void begin()
Begins a lookup sequence.
Definition: ActionFactory.java:82