Gridarta Editor
StartStopDragAction.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;
29 import net.sf.japi.swing.action.ActionMethod;
30 import org.jetbrains.annotations.NotNull;
31 import org.jetbrains.annotations.Nullable;
32 
37 public class StartStopDragAction<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractMapCursorAction<G, A, R> implements EditorAction {
38 
43  @Nullable
44  private Action action;
45 
46  @Override
47  public void setAction(@NotNull final Action action, @NotNull final String name) {
48  this.action = action;
49  updateAction();
50  }
51 
55  @ActionMethod
56  public void startStopDrag() {
57  doStartStopDrag(true);
58  }
59 
65  private boolean doStartStopDrag(final boolean performAction) {
66  final MapCursor<G, A, R> mapCursor = getActiveMapCursor();
67  if (mapCursor == null) {
68  return false;
69  }
70 
71  if (performAction) {
72  if (mapCursor.isDragging()) {
73  mapCursor.dragSelect(SelectionMode.FLIP, true);
74  } else {
75  mapCursor.dragStart();
76  }
77  }
78 
79  return true;
80  }
81 
82  @Override
83  protected void updateAction() {
84  if (action != null) {
85  action.setEnabled(doStartStopDrag(false));
86  }
87  }
88 
89 }
name
name
Definition: ArchetypeTypeSetParserTest-ignoreDefaultAttribute1-result.txt:2
net.sf.gridarta.action.StartStopDragAction.action
Action action
The Action associated with this editor action.
Definition: StartStopDragAction.java:44
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.mapcursor.MapCursor.dragSelect
void dragSelect(@NotNull final SelectionMode selectionMode, final boolean forceSelect)
Leave drag mode and select pre-selection using selectionMode.
Definition: MapCursor.java:338
net.sf.gridarta.model.mapcursor.MapCursor.dragStart
final Point dragStart
Position where dragging has started.
Definition: MapCursor.java:71
net.sf
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.mapgrid.SelectionMode.FLIP
FLIP
All squares that are preselected change state of selection.
Definition: SelectionMode.java:41
net.sf.gridarta.model.gameobject.GameObject
Reflects a game object (object on a map).
Definition: GameObject.java:36
net.sf.gridarta.action.StartStopDragAction.doStartStopDrag
boolean doStartStopDrag(final boolean performAction)
Executes the "start stop drag" action.
Definition: StartStopDragAction.java:65
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.action.StartStopDragAction.startStopDrag
void startStopDrag()
Action method for "start stop drag".
Definition: StartStopDragAction.java:56
net.sf.gridarta.model.mapcursor.MapCursor.isDragging
boolean isDragging()
Returns whether the cursor is currently being dragged.
Definition: MapCursor.java:411
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.mapgrid.SelectionMode
Modes that describe how squares get selected.
Definition: SelectionMode.java:26
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.action.StartStopDragAction.updateAction
void updateAction()
Definition: StartStopDragAction.java:83
net.sf.gridarta.model.mapgrid
Definition: MapGrid.java:20
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.action.StartStopDragAction.setAction
void setAction(@NotNull final Action action, @NotNull final String name)
Sets the Action instance for this editor action.
Definition: StartStopDragAction.java:47
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.utils
Definition: ActionBuilderUtils.java:20
net.sf.gridarta.action.StartStopDragAction
An EditorAction that toggles a selection process.
Definition: StartStopDragAction.java:37