Gridarta Editor
AbstractMoveSquareAction.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 java.util.Set;
23 import javax.swing.Action;
38 import net.sf.gridarta.utils.Size2D;
39 import org.jetbrains.annotations.NotNull;
40 import org.jetbrains.annotations.Nullable;
41 
47 public abstract class AbstractMoveSquareAction<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements EditorAction {
48 
52  @NotNull
54 
58  @Nullable
60 
64  @Nullable
65  private Action action;
66 
70  @NotNull
72 
73  @Override
74  public void currentMapChanged(@Nullable final MapControl<G, A, R> mapControl) {
75  setMapModel(mapControl == null ? null : mapControl.getMapModel());
76  }
77 
78  @Override
79  public void mapCreated(@NotNull final MapControl<G, A, R> mapControl, final boolean interactive) {
80  }
81 
82  @Override
83  public void mapClosing(@NotNull final MapControl<G, A, R> mapControl) {
84  }
85 
86  @Override
87  public void mapClosed(@NotNull final MapControl<G, A, R> mapControl) {
88  }
89 
90  };
91 
95  @NotNull
97 
98  @Override
99  public void mapSizeChanged(@NotNull final Size2D newSize) {
100  updateAction();
101  }
102 
103  @Override
104  public void mapSquaresChanged(@NotNull final Set<MapSquare<G, A, R>> mapSquares) {
105  if (selectedSquareModel.isSelectedMapSquares(mapSquares)) {
106  updateAction();
107  }
108  }
109 
110  @Override
111  public void mapObjectsChanged(@NotNull final Set<G> gameObjects, @NotNull final Set<G> transientGameObjects) {
112  if (selectedSquareModel.isSelectedGameObjects(gameObjects) || selectedSquareModel.isSelectedGameObjects(transientGameObjects)) {
113  updateAction();
114  }
115  }
116 
117  @Override
118  public void errorsChanged(@NotNull final ErrorCollector<G, A, R> errors) {
119  }
120 
121  @Override
122  public void mapFileChanged(@Nullable final MapFile oldMapFile) {
123  }
124 
125  @Override
126  public void modifiedChanged() {
127  }
128 
129  };
130 
135  @NotNull
137 
144  this.selectedSquareModel = selectedSquareModel;
146  if (mapManager != null) {
147  mapManager.addMapManagerListener(mapManagerListener);
148  }
149  }
150 
156  public boolean doAction(final boolean performAction) {
157  return doAction(performAction, selectedSquareModel.getSelectedGameObject());
158  }
159 
167  protected abstract boolean doAction(boolean performAction, @Nullable G gameObject);
168 
169  @Override
170  public void setAction(@NotNull final Action action, @NotNull final String name) {
171  this.action = action;
172  updateAction();
173  }
174 
178  private void updateAction() {
179  if (action != null) {
180  action.setEnabled(doAction(false));
181  }
182  }
183 
189  private void setMapModel(@Nullable final MapModel<G, A, R> mapModel) {
190  if (this.mapModel != null) {
191  this.mapModel.removeMapModelListener(mapModelListener);
192  }
193  this.mapModel = mapModel;
194  if (this.mapModel != null) {
195  this.mapModel.addMapModelListener(mapModelListener);
196  }
197 
198  updateAction();
199  }
200 
201 }
name
name
Definition: ArchetypeTypeSetParserTest-ignoreDefaultAttribute1-result.txt:2
net.sf.gridarta.model.mapmanager
Definition: AbstractMapManager.java:20
net.sf.gridarta.model.mapmodel.MapModel
A MapModel reflects the data of a map.
Definition: MapModel.java:75
net.sf.gridarta.gui.panel
net.sf.gridarta.model.mapmanager.MapManager
A MapManager manages all opened maps.
Definition: MapManager.java:37
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.action.AbstractMoveSquareAction
Abstract base class for actions that move the selected game object in the SelectedSquareModel.
Definition: AbstractMoveSquareAction.java:47
net.sf.gridarta.model.mapmodel.MapSquare
A single Map Square.
Definition: MapSquare.java:45
net.sf.gridarta.action.AbstractMoveSquareAction.mapManagerListener
final MapManagerListener< G, A, R > mapManagerListener
The map manager listener.
Definition: AbstractMoveSquareAction.java:71
net.sf.gridarta.action.AbstractMoveSquareAction.action
Action action
The Action for this instance.
Definition: AbstractMoveSquareAction.java:65
net.sf.gridarta.action.AbstractMoveSquareAction.selectedSquareModel
final SelectedSquareModel< G, A, R > selectedSquareModel
The SelectedSquareModel that is updated.
Definition: AbstractMoveSquareAction.java:53
net.sf
net.sf.gridarta.model.mapmanager.MapManagerListener
Interface for listeners listening to MapManager changes.
Definition: MapManagerListener.java:42
net.sf.gridarta.model.mapmodel
Definition: AboveFloorInsertionMode.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.model.mapmodel.MapModel.addMapModelListener
void addMapModelListener(@NotNull MapModelListener< G, A, R > listener)
Register a map listener.
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel.isSelectedGameObjects
boolean isSelectedGameObjects(@NotNull final Iterable< G > gameObjects)
Definition: SelectedSquareModel.java:117
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.action.AbstractMoveSquareAction.AbstractMoveSquareAction
AbstractMoveSquareAction(@NotNull final SelectedSquareModel< G, A, R > selectedSquareModel, @Nullable final MapManager< G, A, R > mapManager)
Creates a new instance.
Definition: AbstractMoveSquareAction.java:143
errors
errors
Definition: ArchetypeTypeSetParserTest-ignoreDefaultAttribute1-result.txt:1
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModelListener
Interface for listeners interested in events of SelectedSquareModel instances.
Definition: SelectedSquareModelListener.java:34
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel
The model component of the selected square control.
Definition: SelectedSquareModel.java:35
net.sf.gridarta.model.validation.ErrorCollector
An interface for classes that collect errors.
Definition: ErrorCollector.java:33
net.sf.gridarta.action.AbstractMoveSquareAction.doAction
boolean doAction(final boolean performAction)
Executes the action.
Definition: AbstractMoveSquareAction.java:156
net.sf.gridarta.action.AbstractMoveSquareAction.setAction
void setAction(@NotNull final Action action, @NotNull final String name)
Sets the Action instance for this editor action.
Definition: AbstractMoveSquareAction.java:170
net.sf.gridarta.model.validation
This package contains the framework for validating maps.
Definition: AbstractValidator.java:20
net.sf.gridarta.model.mapmodel.MapFile
The location of a map file with a map directory.
Definition: MapFile.java:31
net.sf.gridarta.action.AbstractMoveSquareAction.mapModelListener
final MapModelListener< G, A, R > mapModelListener
The MapModelListener attached to mapModel.
Definition: AbstractMoveSquareAction.java:96
net.sf.gridarta.model.mapmodel.MapModelListener
Interface for listeners listening on MapModel events.
Definition: MapModelListener.java:36
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel.addSelectedSquareListener
void addSelectedSquareListener(@NotNull final SelectedSquareModelListener< G, A, R > listener)
Adds a SelectedSquareModelListener to be notified.
Definition: SelectedSquareModel.java:79
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.action.AbstractMoveSquareAction.mapModel
MapModel< G, A, R > mapModel
The currently active MapModel.
Definition: AbstractMoveSquareAction.java:59
net.sf.gridarta.model.mapcontrol.MapControl
Currently nothing more than a marker interface for unification.
Definition: MapControl.java:35
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel.isSelectedMapSquares
boolean isSelectedMapSquares(@NotNull final Iterable< MapSquare< G, A, R >> mapSquares)
Definition: SelectedSquareModel.java:102
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel.getSelectedGameObject
G getSelectedGameObject()
Returns the currently selected GameObject within this list (currently selected MapSquare).
Definition: SelectedSquareModel.java:71
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.utils.EditorAction
A global editor action.
Definition: EditorAction.java:29
net.sf.gridarta.gui.panel.selectedsquare
Displays the contents of the currently selected map square.
Definition: CellRenderer.java:20
net.sf.gridarta.action.AbstractMoveSquareAction.setMapModel
void setMapModel(@Nullable final MapModel< G, A, R > mapModel)
Called whether the current map has changed.
Definition: AbstractMoveSquareAction.java:189
net.sf.gridarta.action.AbstractMoveSquareAction.selectedSquareModelListener
final SelectedSquareModelListener< G, A, R > selectedSquareModelListener
The SelectedSquareModelListener attached to {}.
Definition: AbstractMoveSquareAction.java:136
net.sf.gridarta.utils.Size2D
The class Size2D represents a 2d rectangular area.
Definition: Size2D.java:30
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20
net.sf.gridarta.action.AbstractMoveSquareAction.updateAction
void updateAction()
Updates the enabled state of action.
Definition: AbstractMoveSquareAction.java:178