Gridarta Editor
AddBookmarkAction.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.action;
21 
22 import javax.swing.Action;
35 import net.sf.japi.swing.action.ActionMethod;
36 import org.jetbrains.annotations.NotNull;
37 import org.jetbrains.annotations.Nullable;
38 
43 public class AddBookmarkAction<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements EditorAction, MapViewManagerListener<G, A, R> {
44 
48  @NotNull
50 
54  @Nullable
56 
61  @Nullable
62  private Action action;
63 
70  this.bookmarksMapMenuPreferences = bookmarksMapMenuPreferences;
71  }
72 
77  @ActionMethod
78  public void addBookmark() {
79  doAddBookmark(true);
80  }
81 
82  @Override
83  public void setAction(@NotNull final Action action, @NotNull final String name) {
84  this.action = action;
85  updateAction();
86  }
87 
91  private void updateAction() {
92  if (action != null) {
93  action.setEnabled(doAddBookmark(false));
94  }
95  }
96 
102  private boolean doAddBookmark(final boolean performAction) {
103  final MapView<G, A, R> mapView = currentMapView;
104  if (mapView == null) {
105  return false;
106  }
107 
108  final MapControl<G, A, R> mapControl = mapView.getMapControl();
109  final MapModel<G, A, R> mapModel = mapControl.getMapModel();
110  final MapFile mapFile = mapModel.getMapFile();
111  if (mapFile == null) {
112  return false;
113  }
114 
115  if (performAction) {
116  final A mapArchObject = mapModel.getMapArchObject();
117  final EditBookmarkDialog editBookmarkDialog = new EditBookmarkDialog(mapView.getInternalFrame(), mapArchObject.getMapName());
118  if (editBookmarkDialog.showDialog()) {
119  final MapMenuEntryMap mapMenuEntry = new MapMenuEntryMap(mapFile, editBookmarkDialog.getDescription());
121  }
122  }
123 
124  return true;
125  }
126 
127  @Override
128  public void activeMapViewChanged(@Nullable final MapView<G, A, R> mapView) {
129  currentMapView = mapView;
130  updateAction();
131  }
132 
133  @Override
134  public void mapViewCreated(@NotNull final MapView<G, A, R> mapView) {
135  }
136 
137  @Override
138  public void mapViewClosing(@NotNull final MapView<G, A, R> mapView) {
139  }
140 
141 }
net.sf.gridarta.gui.dialog.bookmarks.EditBookmarkDialog.getDescription
String getDescription()
Returns the description.
Definition: EditBookmarkDialog.java:181
name
name
Definition: ArchetypeTypeSetParserTest-ignoreDefaultAttribute1-result.txt:2
net.sf.gridarta.model.mapmodel.MapModel
A MapModel reflects the data of a map.
Definition: MapModel.java:75
net.sf.gridarta.action.AddBookmarkAction.AddBookmarkAction
AddBookmarkAction(@NotNull final AbstractMapMenuPreferences bookmarksMapMenuPreferences)
Creates a new instance.
Definition: AddBookmarkAction.java:69
net.sf.gridarta.gui.mapmenu.AbstractMapMenuPreferences
Abstract base class for MapMenuPreferences implementations.
Definition: AbstractMapMenuPreferences.java:29
net.sf.gridarta.model.mapmodel.MapModel.getMapArchObject
A getMapArchObject()
Returns the Map Arch Object with the meta information about the map.
net.sf.gridarta.gui.dialog.bookmarks.EditBookmarkDialog
A dialog that displays one bookmark and allows to edit the values.
Definition: EditBookmarkDialog.java:46
net.sf.gridarta.action.AddBookmarkAction.addBookmark
void addBookmark()
Action method for "addBookmark".
Definition: AddBookmarkAction.java:78
net.sf.gridarta.action.AddBookmarkAction.updateAction
void updateAction()
Updates the enabled state of all actions.
Definition: AddBookmarkAction.java:91
net.sf.gridarta.gui.map.mapview.MapView.getMapControl
MapControl< G, A, R > getMapControl()
Return the controller of this view.
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.action.AddBookmarkAction.bookmarksMapMenuPreferences
final AbstractMapMenuPreferences bookmarksMapMenuPreferences
The AbstractMapMenuPreferences for adding new bookmarks.
Definition: AddBookmarkAction.java:49
net.sf
net.sf.gridarta.model.mapmodel
Definition: AboveFloorInsertionMode.java:20
net.sf.gridarta.gui.map.mapview.MapViewManagerListener
Interface for listeners interested in events related to {} instances.
Definition: MapViewManagerListener.java:33
net.sf.gridarta.gui.dialog.bookmarks
Definition: BookmarkDirectoryDialog.java:20
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.model.mapcontrol
Definition: DefaultMapControl.java:20
net.sf.gridarta.gui.mapmenu.MapMenuPreferences.addEntry
void addEntry(@NotNull MapMenuEntryMap mapMenuEntry)
Adds a new entry to the menu.
net.sf.gridarta.action.AddBookmarkAction.currentMapView
MapView< G, A, R > currentMapView
The currently active MapView or.
Definition: AddBookmarkAction.java:55
net.sf.gridarta.gui
Graphical User Interface of Gridarta.
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.gui.dialog.bookmarks.EditBookmarkDialog.showDialog
boolean showDialog()
Opens the dialog.
Definition: EditBookmarkDialog.java:133
net.sf.gridarta.action.AddBookmarkAction
An EditorAction that creates a new bookmark for the current map.
Definition: AddBookmarkAction.java:43
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.gui.map.mapview
Definition: AbstractMapView.java:20
net.sf.gridarta.gui.map.mapview.MapView
A map view consists of a map grid and a map cursor, and is attached to a map control.
Definition: MapView.java:43
net.sf.gridarta.gui.mapmenu
Definition: AbstractMapMenuPreferences.java:20
net.sf.gridarta.action.AddBookmarkAction.action
Action action
The action associated with this editor action.
Definition: AddBookmarkAction.java:62
net.sf.gridarta.gui.dialog
net.sf.gridarta.model.mapmodel.MapFile
The location of a map file with a map directory.
Definition: MapFile.java:31
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.gui.map.mapview.MapView.getInternalFrame
JInternalFrame getInternalFrame()
Returns the JInternalFrame instance for this map view.
net.sf.gridarta.gui.map
Base classes for rendering maps.
Definition: AbstractPerMapDialogManager.java:20
net.sf.gridarta.action.AddBookmarkAction.mapViewCreated
void mapViewCreated(@NotNull final MapView< G, A, R > mapView)
This event handler is called when a map view was created.
Definition: AddBookmarkAction.java:134
net.sf.gridarta.model.mapcontrol.MapControl
Currently nothing more than a marker interface for unification.
Definition: MapControl.java:35
net.sf.gridarta.model.mapcontrol.MapControl.getMapModel
MapModel< G, A, R > getMapModel()
Returns the map model.
net.sf.gridarta.action.AddBookmarkAction.mapViewClosing
void mapViewClosing(@NotNull final MapView< G, A, R > mapView)
This event handler is called when a map view is to be closed.
Definition: AddBookmarkAction.java:138
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.gui.mapmenu.MapMenuEntryMap
A MapMenuEntry that represents a map.
Definition: MapMenuEntryMap.java:29
net.sf.gridarta.action.AddBookmarkAction.activeMapViewChanged
void activeMapViewChanged(@Nullable final MapView< G, A, R > mapView)
This event handler is called when the current map view has changed.
Definition: AddBookmarkAction.java:128
net.sf.gridarta.model.mapmodel.MapModel.getMapFile
MapFile getMapFile()
Returns the map file.
net.sf.gridarta.utils.EditorAction
A global editor action.
Definition: EditorAction.java:29
net.sf.gridarta.action.AddBookmarkAction.doAddBookmark
boolean doAddBookmark(final boolean performAction)
Preforms the action "add bookmark".
Definition: AddBookmarkAction.java:102
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20
net.sf.gridarta.action.AddBookmarkAction.setAction
void setAction(@NotNull final Action action, @NotNull final String name)
Sets the Action instance for this editor action.
Definition: AddBookmarkAction.java:83