Gridarta Editor
NewPickmapDialog.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.io.IOException;
25 import javax.swing.JPanel;
26 import javax.swing.JTextField;
27 import javax.swing.text.JTextComponent;
35 import net.sf.gridarta.utils.Size2D;
36 import net.sf.japi.swing.action.ActionBuilder;
37 import net.sf.japi.swing.action.ActionBuilderFactory;
38 import org.jetbrains.annotations.NotNull;
39 import org.jetbrains.annotations.Nullable;
40 
45 public class NewPickmapDialog<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractMapsizeNewMapDialog<G, A, R> {
46 
50  private static final long serialVersionUID = 1L;
51 
55  @NotNull
56  private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
57 
61  @NotNull
63 
67  @NotNull
69 
74  @NotNull
75  private final JTextComponent pickmapNameField = new JTextField(16);
76 
85  public NewPickmapDialog(@NotNull final ObjectChooser<G, A, R> objectChooser, @NotNull final Component parentComponent, final int defaultWidth, final int defaultHeight, @NotNull final PickmapChooserView<G, A, R> pickmapChooserView) {
86  super(null, null, defaultWidth, defaultHeight);
87  this.objectChooser = objectChooser;
88  this.pickmapChooserView = pickmapChooserView;
89  init1(parentComponent, ActionBuilderUtils.getString(ACTION_BUILDER, "newPickmap.title"));
90  init2();
91  addDocumentListener(pickmapNameField);
92  updateOkButton();
93  }
94 
95  @NotNull
96  @Override
97  protected JPanel createMapNamePanel() {
98  final JPanel panel = new JPanel(new FlowLayout(FlowLayout.RIGHT));
99  panel.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "newMapPickmapName"));
100  panel.add(pickmapNameField);
101  return panel;
102  }
103 
104  @Override
105  protected boolean createNew() {
106  final Size2D mapSize = getMapSize();
107  if (mapSize == null) {
108  return false;
109  }
110 
111  final String pickmapName = getPickmapName();
112  if (pickmapName == null) {
113  return false;
114  }
115 
116  try {
117  pickmapChooserView.newPickmap(mapSize, pickmapName);
118  } catch (final DuplicatePickmapException ex) {
119  ACTION_BUILDER.showMessageDialog(this, "pickmapExists", pickmapName);
120  return false;
121  } catch (final IOException ex) {
122  ACTION_BUILDER.showMessageDialog(this, "pickmapIOError", pickmapName, ex.getMessage());
123  return false;
124  }
125 
127  return true;
128  }
129 
130  @Override
131  protected boolean isOkButtonEnabled() {
132  return super.isOkButtonEnabled() && getMapWidth() >= 0 && getMapHeight() >= 0 && getPickmapName() != null;
133  }
134 
139  @Nullable
140  private String getPickmapName() {
141  final String folderName = pickmapNameField.getText();
142  return folderName.length() <= 0 ? null : folderName;
143  }
144 
145 }
net.sf.gridarta.gui.dialog.newmap.NewPickmapDialog.pickmapChooserView
final PickmapChooserView< G, A, R > pickmapChooserView
The pickmap chooser view.
Definition: NewPickmapDialog.java:68
net.sf.gridarta.gui.dialog.newmap.NewPickmapDialog.serialVersionUID
static final long serialVersionUID
Serial Version UID.
Definition: NewPickmapDialog.java:50
net.sf.gridarta.gui.panel
net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView
A View for choosing pickmaps.
Definition: PickmapChooserView.java:58
net.sf.gridarta.gui.panel.pickmapchooser
Classes implementing the pickmap chooser.
Definition: package-info.java:24
net.sf.gridarta.gui.dialog.newmap.NewPickmapDialog.pickmapNameField
final JTextComponent pickmapNameField
Textfield for the name of the map.
Definition: NewPickmapDialog.java:75
net.sf.gridarta.gui.dialog.newmap.NewPickmapDialog.ACTION_BUILDER
static final ActionBuilder ACTION_BUILDER
Action Builder.
Definition: NewPickmapDialog.java:56
net.sf.gridarta
Base package of all Gridarta classes.
net.sf
net.sf.gridarta.gui.dialog.newmap.NewPickmapDialog.createNew
boolean createNew()
Definition: NewPickmapDialog.java:105
net.sf.gridarta.gui.dialog.newmap.AbstractMapsizeNewMapDialog< G, A, R >::defaultHeight
final int defaultHeight
The default height for new maps.
Definition: AbstractMapsizeNewMapDialog.java:74
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.mapfiles.DuplicatePickmapException
Indicates that a pickmap name is not unique within its folder.
Definition: DuplicatePickmapException.java:28
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.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.sf.gridarta.gui.dialog.newmap.NewPickmapDialog.createMapNamePanel
JPanel createMapNamePanel()
Definition: NewPickmapDialog.java:97
net
net.sf.gridarta.gui.dialog.newmap.NewPickmapDialog
Dialog to create a new pickmap file.
Definition: NewPickmapDialog.java:45
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.gui.dialog.newmap.NewPickmapDialog.NewPickmapDialog
NewPickmapDialog(@NotNull final ObjectChooser< G, A, R > objectChooser, @NotNull final Component parentComponent, final int defaultWidth, final int defaultHeight, @NotNull final PickmapChooserView< G, A, R > pickmapChooserView)
Creates a "new pickmap" dialog.
Definition: NewPickmapDialog.java:85
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.NewPickmapDialog.getPickmapName
String getPickmapName()
Returns the current pickmap name value.
Definition: NewPickmapDialog.java:140
net.sf.gridarta.gui.panel.objectchooser.ObjectChooser
Common base interface for ObjectChoosers.
Definition: ObjectChooser.java:34
net.sf.gridarta.gui.dialog.newmap.AbstractMapsizeNewMapDialog< G, A, R >::defaultWidth
final int defaultWidth
The default width for new maps.
Definition: AbstractMapsizeNewMapDialog.java:69
net.sf.gridarta.gui.dialog.newmap.NewPickmapDialog.isOkButtonEnabled
boolean isOkButtonEnabled()
Definition: NewPickmapDialog.java:131
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.gui.dialog.newmap.AbstractMapsizeNewMapDialog< G, A, R >::getMapSize
Size2D getMapSize()
Validate the map size fields and return the result.
Definition: AbstractMapsizeNewMapDialog.java:126
net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView.newPickmap
void newPickmap(@NotNull final Size2D mapSize, @NotNull final String pickmapName)
Add a new pickmap.
Definition: PickmapChooserView.java:324
net.sf.gridarta.gui.dialog.newmap.NewPickmapDialog.objectChooser
final ObjectChooser< G, A, R > objectChooser
The object chooser instance to use.
Definition: NewPickmapDialog.java:62
net.sf.gridarta.gui.panel.objectchooser.ObjectChooser.movePickmapChooserToFront
void movePickmapChooserToFront()
Move the Pickmap Chooser in front of the Archetype Chooser.
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.AbstractMapsizeNewMapDialog< G, A, R >::getMapWidth
int getMapWidth()
Returns the current map width value.
Definition: AbstractMapsizeNewMapDialog.java:151
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.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.mapfiles
Definition: DuplicateMapFolderException.java:20