Gridarta Editor
NewMapDialog.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.gui.dialog.newmap;
21 
22 import java.awt.Component;
23 import java.awt.FlowLayout;
24 import java.awt.GridBagConstraints;
25 import javax.swing.AbstractButton;
26 import javax.swing.JCheckBox;
27 import javax.swing.JPanel;
28 import javax.swing.JTextField;
29 import javax.swing.text.JTextComponent;
37 import net.sf.gridarta.utils.Size2D;
38 import net.sf.japi.swing.action.ActionBuilder;
39 import net.sf.japi.swing.action.ActionBuilderFactory;
40 import net.sf.japi.swing.action.ActionMethod;
41 import org.jetbrains.annotations.NotNull;
42 import org.jetbrains.annotations.Nullable;
43 
48 public class NewMapDialog<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractMapsizeNewMapDialog<G, A, R> {
49 
53  @NotNull
54  private static final String DEFAULT_LEVEL_WIDTH_KEY = "NewMapDialog.mapWidth";
55 
59  @NotNull
60  private static final String DEFAULT_LEVEL_HEIGHT_KEY = "NewMapDialog.mapHeight";
61 
65  @NotNull
66  private static final String DEFAULT_DIFFICULTY_KEY = "NewMapDialog.difficulty";
67 
71  private static final long serialVersionUID = 1L;
72 
76  @NotNull
77  private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
78 
82  @NotNull
84 
88  @NotNull
90 
94  private final boolean showMapSizeDefault;
95 
102  private boolean mapSizeDefault;
103 
107  private final boolean showMapDifficulty;
108 
112  private final int defaultWidth;
113 
117  private final int defaultHeight;
118 
122  private final int defaultDifficulty;
123 
128  @NotNull
129  private final JTextComponent mapNameField = new JTextField(16);
130 
134  @NotNull
135  private final AbstractButton mapSizeDefaultCheckbox = new JCheckBox(ACTION_BUILDER.createToggle(false, "mapSizeDefault", this));
136 
140  @NotNull
141  private final JTextField mapDifficultyField = new JTextField();
142 
154  public NewMapDialog(@NotNull final MapViewsManager<G, A, R> mapViewsManager, @NotNull final MapArchObjectFactory<A> mapArchObjectFactory, @NotNull final Component parentComponent, final boolean showMapSizeDefault, final boolean showMapDifficulty, final int defaultWidth, final int defaultHeight, final int defaultDifficulty) {
156  this.mapViewsManager = mapViewsManager;
157  this.mapArchObjectFactory = mapArchObjectFactory;
158  this.showMapSizeDefault = showMapSizeDefault;
159  this.showMapDifficulty = showMapDifficulty;
160  this.defaultWidth = defaultWidth;
161  this.defaultHeight = defaultHeight;
162  this.defaultDifficulty = defaultDifficulty;
164 
165  init1(parentComponent, ActionBuilderUtils.getString(ACTION_BUILDER, "newMap.title"));
166  init2();
167  mapNameField.selectAll();
168 
169  addDocumentListener(mapNameField);
170  addDocumentListener(mapDifficultyField);
171  updateOkButton();
172  }
173 
174  @Override
175  protected void init2() {
176  if (showMapSizeDefault) {
177  setMapSizeDefault(true);
178  }
179  super.init2();
180  }
181 
182  @NotNull
183  @Override
184  protected JPanel createMapNamePanel() {
185  final JPanel panel = new JPanel(new FlowLayout(FlowLayout.RIGHT));
186  panel.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "newMapMapName"));
187  panel.add(mapNameField);
188  return panel;
189  }
190 
191  @Override
192  protected void addFields(@NotNull final JPanel panel, @NotNull final GridBagConstraints gbcLabel, @NotNull final GridBagConstraints gbcField) {
193  if (showMapSizeDefault) {
194  panel.add(mapSizeDefaultCheckbox, gbcField);
195  }
196  super.addFields(panel, gbcLabel, gbcField);
197  if (showMapDifficulty) {
198  mapDifficultyField.setText(Integer.toString(PREFERENCES.getInt(DEFAULT_DIFFICULTY_KEY, defaultDifficulty)));
199  panel.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "mapDifficulty"), gbcLabel);
200  mapDifficultyField.setColumns(3);
201  panel.add(mapDifficultyField, gbcField);
202  }
203  }
204 
205  @Override
206  protected boolean createNew() {
207  final A mapArchObject = mapArchObjectFactory.newMapArchObject(true);
208 
209  final Size2D mapSize = getMapSize();
210  if (mapSize == null) {
211  return false;
212  }
213  mapArchObject.setMapSize(mapSize);
214 
215  final String mapName = getMapName();
216  if (mapName == null) {
217  return false;
218  }
219 
220  mapArchObject.setMapName(mapName);
221  if (showMapDifficulty) {
222  final int difficulty = getDifficulty();
223  if (difficulty < 0) {
224  return false;
225  }
226  mapArchObject.setDifficulty(difficulty);
227  }
228 
229  mapViewsManager.newMapWithView(null, mapArchObject, null, null);
230  return true;
231  }
232 
233  @Override
234  protected boolean isOkButtonEnabled() {
235  return super.isOkButtonEnabled() && (mapSizeDefault || (getMapWidth() >= 0 && getMapHeight() >= 0)) && getMapName() != null && (!showMapDifficulty || getDifficulty() >= 0);
236  }
237 
242  @Nullable
243  private String getMapName() {
244  final String mapName = mapNameField.getText();
245  return mapName.isEmpty() ? null : mapName;
246  }
247 
252  private int getDifficulty() {
253  final String text = mapDifficultyField.getText();
254  final int difficulty = NumberUtils.parseInt(text);
255  return difficulty >= 1 ? difficulty : -1;
256  }
257 
263  @ActionMethod
264  public boolean isMapSizeDefault() {
265  return mapSizeDefault;
266  }
267 
273  @ActionMethod
274  public void setMapSizeDefault(final boolean mapSizeDefault) {
276  this.mapSizeDefault = mapSizeDefault;
278  updateOkButton();
279  }
280 
285  @Nullable
286  @Override
287  protected Size2D getMapSize() {
288  return mapSizeDefault ? new Size2D(defaultWidth, defaultHeight) : super.getMapSize();
289  }
290 
291 }
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.getDifficulty
int getDifficulty()
Returns the current difficulty value.
Definition: NewMapDialog.java:252
net.sf.gridarta.utils.NumberUtils.parseInt
static int parseInt(@NotNull final String s)
Parses an integer string.
Definition: NumberUtils.java:41
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.mapSizeDefault
boolean mapSizeDefault
Whether to use the default map size.
Definition: NewMapDialog.java:102
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.mapSizeDefaultCheckbox
final AbstractButton mapSizeDefaultCheckbox
Checkbox to set whether the default width / height should be overridden.
Definition: NewMapDialog.java:135
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.defaultDifficulty
final int defaultDifficulty
The default height for new maps.
Definition: NewMapDialog.java:122
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.DEFAULT_LEVEL_HEIGHT_KEY
static final String DEFAULT_LEVEL_HEIGHT_KEY
The key used to store the last used map height in preferences.
Definition: NewMapDialog.java:60
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.createNew
boolean createNew()
Definition: NewMapDialog.java:206
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.isMapSizeDefault
boolean isMapSizeDefault()
Set whether to override the default map size.
Definition: NewMapDialog.java:264
net.sf
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.getMapName
String getMapName()
Returns the current map name value.
Definition: NewMapDialog.java:243
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.utils.ActionBuilderUtils.newLabel
static JLabel newLabel(@NotNull final ActionBuilder actionBuilder, @NotNull final String key)
Creates a new JLabel from a resource key.
Definition: ActionBuilderUtils.java:117
net.sf.gridarta.gui
Graphical User Interface of Gridarta.
net.sf.gridarta.gui.dialog.newmap.AbstractMapsizeNewMapDialog< G, A, R >::getMapHeight
int getMapHeight()
Returns the current map height value.
Definition: AbstractMapsizeNewMapDialog.java:162
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.ACTION_BUILDER
static final ActionBuilder ACTION_BUILDER
Action Builder.
Definition: NewMapDialog.java:77
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.setMapSizeDefault
void setMapSizeDefault(final boolean mapSizeDefault)
Set whether to override the default map size.
Definition: NewMapDialog.java:274
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.DEFAULT_DIFFICULTY_KEY
static final String DEFAULT_DIFFICULTY_KEY
The key used to store the last used difficulty in preferences.
Definition: NewMapDialog.java:66
net
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.mapDifficultyField
final JTextField mapDifficultyField
Textfield for the difficulty of the new map.
Definition: NewMapDialog.java:141
net.sf.gridarta.gui.map.mapview.MapViewsManager.newMapWithView
void newMapWithView(@Nullable final List< G > objects, @NotNull final A mapArchObject, @Nullable final Point viewPosition, @Nullable final MapFile mapFile)
Creates a new map control and an initial map view.
Definition: MapViewsManager.java:294
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.dialog.newmap.NewMapDialog.showMapSizeDefault
final boolean showMapSizeDefault
Whether to show the "mapSizeDefault" checkbox.
Definition: NewMapDialog.java:94
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.isOkButtonEnabled
boolean isOkButtonEnabled()
Definition: NewMapDialog.java:234
net.sf.gridarta.utils.ActionBuilderUtils.getString
static String getString(@NotNull final ActionBuilder actionBuilder, @NotNull final String key, @NotNull final String defaultValue)
Returns the value of a key.
Definition: ActionBuilderUtils.java:71
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.showMapDifficulty
final boolean showMapDifficulty
Whether to show the "mapDifficulty" field.
Definition: NewMapDialog.java:107
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.DEFAULT_LEVEL_WIDTH_KEY
static final String DEFAULT_LEVEL_WIDTH_KEY
The key used to store the last used map width in preferences.
Definition: NewMapDialog.java:54
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.createMapNamePanel
JPanel createMapNamePanel()
Definition: NewMapDialog.java:184
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.serialVersionUID
static final long serialVersionUID
Serial Version UID.
Definition: NewMapDialog.java:71
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.defaultHeight
final int defaultHeight
The default height for new maps.
Definition: NewMapDialog.java:117
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.defaultWidth
final int defaultWidth
The default width for new maps.
Definition: NewMapDialog.java:112
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.gui.map
Base classes for rendering maps.
Definition: AbstractPerMapDialogManager.java:20
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.addFields
void addFields(@NotNull final JPanel panel, @NotNull final GridBagConstraints gbcLabel, @NotNull final GridBagConstraints gbcField)
Definition: NewMapDialog.java:192
net.sf.gridarta.gui.dialog.newmap.NewMapDialog
Dialog to create a new map file.
Definition: NewMapDialog.java:48
net.sf.gridarta.gui.dialog.newmap.AbstractMapsizeNewMapDialog
An abstract base class implementing a AbstractNewMapDialog supporting map size input fields.
Definition: AbstractMapsizeNewMapDialog.java:41
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.NewMapDialog
NewMapDialog(@NotNull final MapViewsManager< G, A, R > mapViewsManager, @NotNull final MapArchObjectFactory< A > mapArchObjectFactory, @NotNull final Component parentComponent, final boolean showMapSizeDefault, final boolean showMapDifficulty, final int defaultWidth, final int defaultHeight, final int defaultDifficulty)
Creates a "new map" dialog.
Definition: NewMapDialog.java:154
net.sf.gridarta.gui.dialog.newmap.AbstractMapsizeNewMapDialog< G, A, R >::getMapWidth
int getMapWidth()
Returns the current map width value.
Definition: AbstractMapsizeNewMapDialog.java:151
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.mapViewsManager
final MapViewsManager< G, A, R > mapViewsManager
The MapViewsManager to use.
Definition: NewMapDialog.java:83
net.sf.gridarta.utils.ActionBuilderUtils
Utility class for ActionBuilder related functions.
Definition: ActionBuilderUtils.java:31
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.gui.dialog.newmap.AbstractMapsizeNewMapDialog< G, A, R >::setMapSizeEnabled
void setMapSizeEnabled(final boolean enabled)
Enables or disables the map size input fields.
Definition: AbstractMapsizeNewMapDialog.java:173
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.getMapSize
Size2D getMapSize()
Validate the map size fields and return the result.
Definition: NewMapDialog.java:287
net.sf.gridarta.model.maparchobject.MapArchObjectFactory.newMapArchObject
A newMapArchObject(boolean addDefaultAttributes)
Creates a new MapArchObject instance.
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.mapArchObjectFactory
final MapArchObjectFactory< A > mapArchObjectFactory
The map arch object factory instance.
Definition: NewMapDialog.java:89
net.sf.gridarta.gui.map.mapview.MapViewsManager
Stores all existing MapViews.
Definition: MapViewsManager.java:47
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.gui.dialog.newmap.NewMapDialog.init2
void init2()
Definition: NewMapDialog.java:175
net.sf.gridarta.model.maparchobject.MapArchObjectFactory
Factory for creating MapArchObject instances.
Definition: MapArchObjectFactory.java:28
net.sf.gridarta.utils.NumberUtils
Utility class for parsing strings into numbers.
Definition: NumberUtils.java:28
net.sf.gridarta.gui.dialog.newmap.NewMapDialog.mapNameField
final JTextComponent mapNameField
Textfield for the name of the map.
Definition: NewMapDialog.java:129