Gridarta Editor
InsertArchAction.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;
31 import net.sf.japi.swing.action.ActionMethod;
32 import org.jetbrains.annotations.NotNull;
33 import org.jetbrains.annotations.Nullable;
34 
39 public class InsertArchAction<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractMapCursorAction<G, A, R> implements EditorAction {
40 
44  @NotNull
46 
50  @NotNull
52 
57  @Nullable
58  private Action action;
59 
67  this.objectChooser = objectChooser;
68  this.mapViewSettings = mapViewSettings;
69  }
70 
71  @Override
72  public void setAction(@NotNull final Action action, @NotNull final String name) {
73  this.action = action;
74  updateAction();
75  }
76 
80  @ActionMethod
81  public void insertArch() {
82  doInsertArch(true);
83  }
84 
90  private boolean doInsertArch(final boolean performAction) {
91  final MapCursor<G, A, R> mapCursor = getActiveMapCursor();
93  return mapCursor != null && gameObject != null && mapCursor.insertGameObject(performAction, gameObject, false, mapViewSettings.isAutojoin());
94  }
95 
96  @Override
97  protected void updateAction() {
98  if (action != null) {
99  action.setEnabled(doInsertArch(false));
100  }
101  }
102 
103 }
name
name
Definition: ArchetypeTypeSetParserTest-ignoreDefaultAttribute1-result.txt:2
net.sf.gridarta.gui.panel
net.sf.gridarta.action.InsertArchAction.setAction
void setAction(@NotNull final Action action, @NotNull final String name)
Sets the Action instance for this editor action.
Definition: InsertArchAction.java:72
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.mapviewsettings
Definition: AbstractMapViewSettings.java:20
net.sf
net.sf.gridarta.model.mapviewsettings.MapViewSettings.isAutojoin
boolean isAutojoin()
Returns whether "autojoin" is enabled.
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.mapviewsettings.MapViewSettings
Container for settings that affect the rendering of maps.
Definition: MapViewSettings.java:30
net.sf.gridarta.gui
Graphical User Interface of Gridarta.
net.sf.gridarta.action.InsertArchAction.updateAction
void updateAction()
Definition: InsertArchAction.java:97
net.sf.gridarta.gui.panel.objectchooser
Definition: DefaultObjectChooser.java:20
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.action.InsertArchAction
An EditorAction that inserts a new game object into the current map.
Definition: InsertArchAction.java:39
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.mapcursor.MapCursor.insertGameObject
boolean insertGameObject(final boolean performAction, @NotNull final BaseObject< G, A, R, ?> gameObject, final boolean insertAtEnd, final boolean join)
Inserts a GameObject before the selected game object.
Definition: MapCursor.java:631
net.sf.gridarta.action.InsertArchAction.InsertArchAction
InsertArchAction(@NotNull final ObjectChooser< G, A, R > objectChooser, @NotNull final MapViewSettings mapViewSettings)
Creates a new instance.
Definition: InsertArchAction.java:66
net.sf.gridarta.gui.panel.objectchooser.ObjectChooser.getSelection
BaseObject< G, A, R, ?> getSelection()
Returns the active arch in the left-side panel.
net.sf.gridarta.model.mapcursor.MapCursor
MapCursor provides methods to move and drag on map.
Definition: MapCursor.java:58
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.action.AbstractMapCursorAction< G, A, R >::getActiveMapCursor
MapCursor< G, A, R > getActiveMapCursor()
Return the map cursor of the current map view if it is active.
Definition: AbstractMapCursorAction.java:52
net.sf.gridarta.model.baseobject.BaseObject
Definition: BaseObject.java:34
net.sf.gridarta.gui.panel.objectchooser.ObjectChooser
Common base interface for ObjectChoosers.
Definition: ObjectChooser.java:34
net.sf.gridarta.action.InsertArchAction.objectChooser
final ObjectChooser< G, A, R > objectChooser
The object chooser.
Definition: InsertArchAction.java:45
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.baseobject
Definition: AbstractBaseObject.java:20
net.sf.gridarta.action.InsertArchAction.insertArch
void insertArch()
Action method for "insert arch".
Definition: InsertArchAction.java:81
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.model.mapcursor
Definition: MapCursor.java:20
net.sf.gridarta.action.InsertArchAction.mapViewSettings
final MapViewSettings mapViewSettings
The MapViewSettings instance for looking up options.
Definition: InsertArchAction.java:51
net.sf.gridarta.action.InsertArchAction.action
Action action
The Action associated with this editor action.
Definition: InsertArchAction.java:58
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20
net.sf.gridarta.action.InsertArchAction.doInsertArch
boolean doInsertArch(final boolean performAction)
Executes the "insert arch" action.
Definition: InsertArchAction.java:90