Gridarta Editor
GoLocationAction.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;
32 import net.sf.japi.swing.action.ActionMethod;
33 import org.jetbrains.annotations.NotNull;
34 import org.jetbrains.annotations.Nullable;
35 
40 public class GoLocationAction<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractMapCursorAction<G, A, R> implements EditorAction {
41 
46  @NotNull
48 
53  @Nullable
54  private Action action;
55 
60  public GoLocationAction(@NotNull final MapViewManager<G, A, R> mapViewManager) {
62  }
63 
64  @Override
65  public void setAction(@NotNull final Action action, @NotNull final String name) {
66  this.action = action;
67  updateAction();
68  }
69 
73  @ActionMethod
74  public void goLocation() {
75  doGoLocation(true);
76  }
77 
78  @Override
79  protected void updateAction() {
80  if (action != null) {
81  action.setEnabled(doGoLocation(false));
82  }
83  }
84 
90  private boolean doGoLocation(final boolean performAction) {
91  final MapView<G, A, R> mapView = getActiveMapView();
92  if (mapView == null) {
93  return false;
94  }
95 
96  if (performAction) {
98  }
99 
100  return true;
101  }
102 
103 }
name
name
Definition: ArchetypeTypeSetParserTest-ignoreDefaultAttribute1-result.txt:2
net.sf.gridarta.gui.map.AbstractPerMapDialogManager.showDialog
void showDialog(final MapView< G, A, R > mapView)
Show a dialog for positioning the cursor of a map.
Definition: AbstractPerMapDialogManager.java:80
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.gui.map.mapview.MapViewManager
Maintains all map views.
Definition: MapViewManager.java:38
net.sf
net.sf.gridarta.action.GoLocationAction.setAction
void setAction(@NotNull final Action action, @NotNull final String name)
Sets the Action instance for this editor action.
Definition: GoLocationAction.java:65
net.sf.gridarta.gui.dialog.golocation.GoLocationDialogManager
Manager for GoLocationDialog instances.
Definition: GoLocationDialogManager.java:35
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
Graphical User Interface of Gridarta.
net.sf.gridarta.action.AbstractMapCursorAction< G, A, R >::getActiveMapView
MapView< G, A, R > getActiveMapView()
Return the current map view.
Definition: AbstractMapCursorAction.java:62
net.sf.gridarta.action.GoLocationAction.updateAction
void updateAction()
Definition: GoLocationAction.java:79
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.action.GoLocationAction.doGoLocation
boolean doGoLocation(final boolean performAction)
Executes the "go location" action.
Definition: GoLocationAction.java:90
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.map.AbstractPerMapDialogManager
Maintains (dialog) instance associated to map view instances.
Definition: AbstractPerMapDialogManager.java:39
net.sf.gridarta.action.AbstractMapCursorAction
Abstract base class for actions that have to track the current map cursor.
Definition: AbstractMapCursorAction.java:38
net.sf.gridarta.gui.dialog
net.sf.gridarta.action.GoLocationAction.GoLocationAction
GoLocationAction(@NotNull final MapViewManager< G, A, R > mapViewManager)
Creates a new instance.
Definition: GoLocationAction.java:60
net.sf.gridarta.action.GoLocationAction.action
Action action
The Action associated with this editor action.
Definition: GoLocationAction.java:54
net.sf.gridarta.action.GoLocationAction.goLocationDialogManager
final AbstractPerMapDialogManager< G, A, R, GoLocationDialog< G, A, R > > goLocationDialogManager
The AbstractPerMapDialogManager to track go location dialog instances.
Definition: GoLocationAction.java:47
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.gui.dialog.golocation.GoLocationDialog
A dialog to ask the user for coordinates to move the cursor to.
Definition: GoLocationDialog.java:60
net.sf.gridarta.gui.map
Base classes for rendering maps.
Definition: AbstractPerMapDialogManager.java:20
net.sf.gridarta.gui.dialog.golocation
Definition: GoLocationDialog.java:20
net.sf.gridarta.action.GoLocationAction
An EditorAction that openes the "go location" dialog.
Definition: GoLocationAction.java:40
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.action.GoLocationAction.goLocation
void goLocation()
Opens the "go location" dialog.
Definition: GoLocationAction.java:74
net.sf.gridarta.utils.EditorAction
A global editor action.
Definition: EditorAction.java:29
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20