Gridarta Editor
ActionFactory.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 java.util.IdentityHashMap;
23 import java.util.Map;
24 import javax.swing.Action;
28 import org.jetbrains.annotations.NotNull;
29 
34 public class ActionFactory {
35 
39  @NotNull
41 
45  @NotNull
47 
51  @NotNull
53 
58  @NotNull
59  private final Map<MapMenuEntryMap, MapMenuAction> actions = new IdentityHashMap<>();
60 
64  @NotNull
65  private final Map<MapMenuEntryMap, Void> keysToDelete = new IdentityHashMap<>();
66 
74  this.mapViewsManager = mapViewsManager;
75  this.fileControl = fileControl;
76  this.mapImageCache = mapImageCache;
77  }
78 
82  public void begin() {
83  keysToDelete.clear();
84  for (final MapMenuEntryMap mapMenuEntryMap : actions.keySet()) {
85  keysToDelete.put(mapMenuEntryMap, null);
86  }
87  }
88 
93  public void end() {
94  for (final MapMenuEntryMap mapMenuEntryMap : keysToDelete.keySet()) {
95  actions.remove(mapMenuEntryMap);
96  }
97  keysToDelete.clear();
98  }
99 
105  @NotNull
106  public Action getAction(@NotNull final MapMenuEntryMap mapMenuEntryMap) {
107  keysToDelete.remove(mapMenuEntryMap);
108  final MapMenuAction existingAction = actions.get(mapMenuEntryMap);
109  final MapMenuAction action;
110  if (existingAction == null) {
111  action = new MapMenuAction(mapMenuEntryMap, mapViewsManager, fileControl);
112  actions.put(mapMenuEntryMap, action);
113  } else {
114  action = existingAction;
115  }
116  action.update(mapImageCache);
117  return action;
118  }
119 
120 }
net.sf.gridarta.gui.mapimagecache
Definition: ImageType.java:20
net.sf.gridarta.model.mapmanager
Definition: AbstractMapManager.java:20
net.sf.gridarta.gui.mapmenu.ActionFactory.fileControl
final FileControl<?, ?, ?> fileControl
The FileControl for reporting errors.
Definition: ActionFactory.java:46
net.sf.gridarta
Base package of all Gridarta classes.
net.sf
net.sf.gridarta.model.mapmanager.FileControl
Definition: FileControl.java:30
net.sf.gridarta.gui.mapmenu.ActionFactory.keysToDelete
final Map< MapMenuEntryMap, Void > keysToDelete
Keys of actions to delete when end() is called.
Definition: ActionFactory.java:65
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.mapimagecache.MapImageCache
Caches icon and preview images for map files.
Definition: MapImageCache.java:53
net
net.sf.gridarta.gui.map.mapview
Definition: AbstractMapView.java:20
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.gui.mapmenu.MapMenuAction.update
void update(@NotNull final MapImageCache<?, ?, ?> mapImageCache)
Updates properties.
Definition: MapMenuAction.java:96
net.sf.gridarta.gui.mapmenu.ActionFactory.ActionFactory
ActionFactory(@NotNull final MapViewsManager<?, ?, ?> mapViewsManager, @NotNull final FileControl<?, ?, ?> fileControl, @NotNull final MapImageCache<?, ?, ?> mapImageCache)
Creates a new instance.
Definition: ActionFactory.java:73
net.sf.gridarta.gui.mapmenu.ActionFactory.mapViewsManager
final MapViewsManager<?, ?, ?> mapViewsManager
The MapViewsManager for opening map files.
Definition: ActionFactory.java:40
net.sf.gridarta.gui.mapmenu.ActionFactory.actions
final Map< MapMenuEntryMap, MapMenuAction > actions
Maps MapMenuEntryMap instance to associated {}.
Definition: ActionFactory.java:59
net.sf.gridarta.model
net.sf.gridarta.gui.map
Base classes for rendering maps.
Definition: AbstractPerMapDialogManager.java:20
net.sf.gridarta.gui.mapmenu.MapMenuAction
An AbstractAction for a MapMenuEntryMap instance.
Definition: MapMenuAction.java:39
net.sf.gridarta.gui.mapmenu.MapMenuEntryMap
A MapMenuEntry that represents a map.
Definition: MapMenuEntryMap.java:29
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.mapmenu.ActionFactory.mapImageCache
final MapImageCache<?, ?, ?> mapImageCache
The MapImageCache to query.
Definition: ActionFactory.java:52
net.sf.gridarta.gui.mapmenu.ActionFactory.begin
void begin()
Begins a lookup sequence.
Definition: ActionFactory.java:82