Gridarta Editor
MiscPreferences.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.prefs;
21 
22 import java.awt.Component;
23 import java.awt.GridBagLayout;
24 import javax.swing.AbstractButton;
25 import javax.swing.Box;
26 import javax.swing.JCheckBox;
27 import javax.swing.JComponent;
28 import javax.swing.JPanel;
29 import javax.swing.JTextField;
30 import javax.swing.border.Border;
31 import javax.swing.border.CompoundBorder;
32 import javax.swing.border.TitledBorder;
33 import javax.swing.text.JTextComponent;
40 import net.sf.japi.swing.action.ActionBuilder;
41 import net.sf.japi.swing.action.ActionBuilderFactory;
42 import net.sf.japi.swing.prefs.AbstractPrefs;
43 import org.jetbrains.annotations.NotNull;
44 
50 public class MiscPreferences extends AbstractPrefs {
51 
55  private static final long serialVersionUID = 1L;
56 
60  @NotNull
61  private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
62 
66  @NotNull
68 
72  @NotNull
74 
78  @NotNull
80 
84  private JTextComponent userField;
85 
89  @NotNull
90  private AbstractButton checkMaps;
91 
96  @NotNull
97  private AbstractButton pasteExitName;
98 
102  @NotNull
103  private AbstractButton autoCreateExit;
104 
108  @NotNull
109  private JTextComponent exitArchetypeName;
110 
118  this.exitConnectorModel = exitConnectorModel;
119  this.projectSettings = projectSettings;
120  this.editorSettings = editorSettings;
121 
122  setListLabelText(ActionBuilderUtils.getString(ACTION_BUILDER, "prefsMisc.title"));
123  setListLabelIcon(ACTION_BUILDER.getIcon("prefsMisc.icon"));
124 
125  add(createUserPanel());
126  add(createCheckMapsPanel());
128  add(Box.createVerticalGlue());
129  }
130 
136  @NotNull
137  private static Border createTitledBorder(@NotNull final String title) {
138  return new CompoundBorder(new TitledBorder(title), GUIConstants.DIALOG_BORDER);
139  }
140 
141  @Override
142  public void apply() {
148  }
149 
150  @Override
151  public void revert() {
157  }
158 
159  @Override
160  public void defaults() {
162  checkMaps.setSelected(true);
166  }
167 
168  @Override
169  public boolean isChanged() {
171  }
172 
177  @NotNull
178  private Component createUserPanel() {
179  final JComponent panel = new JPanel(new GridBagLayout());
180  final PreferencesHelper preferencesHelper = new PreferencesHelper(panel);
181  panel.setBorder(createTitledBorder(ActionBuilderUtils.getString(ACTION_BUILDER, "optionsUser")));
182  userField = new JTextField(projectSettings.getUserName());
183  preferencesHelper.addComponent(userField);
184  return panel;
185  }
186 
191  @NotNull
192  private Component createCheckMapsPanel() {
193  final JComponent panel = new JPanel(new GridBagLayout());
194  final PreferencesHelper preferencesHelper = new PreferencesHelper(panel);
195  panel.setBorder(createTitledBorder(ActionBuilderUtils.getString(ACTION_BUILDER, "optionsMisc")));
196  checkMaps = new JCheckBox(ACTION_BUILDER.createAction(false, "optionsCheckMaps"));
198  preferencesHelper.addComponent(checkMaps);
199  return panel;
200  }
201 
206  @NotNull
207  private Component createExitConnectorPanel() {
208  final JComponent panel = new JPanel(new GridBagLayout());
209  final PreferencesHelper preferencesHelper = new PreferencesHelper(panel);
210  panel.setBorder(createTitledBorder(ActionBuilderUtils.getString(ACTION_BUILDER, "optionsExitConnector")));
211 
212  pasteExitName = new JCheckBox(ACTION_BUILDER.createAction(false, "optionsExitConnectorPasteExitName"));
214  preferencesHelper.addComponent(pasteExitName);
215 
216  autoCreateExit = new JCheckBox(ACTION_BUILDER.createAction(false, "optionsExitConnectorAutoCreateExit"));
218  preferencesHelper.addComponent(autoCreateExit);
219 
220  preferencesHelper.addComponent(ActionBuilderUtils.newLabel(ACTION_BUILDER, "optionsExitConnectorExitArchetypeName.text"));
222  preferencesHelper.addComponent(exitArchetypeName);
223 
224  autoCreateExit.addChangeListener(e -> exitArchetypeName.setEnabled(autoCreateExit.isSelected()));
225  exitArchetypeName.setEnabled(autoCreateExit.isSelected());
226 
227  return panel;
228  }
229 
230 }
net.sf.gridarta.utils.MapFileFilter
Swing FileFilter implementation that filters map files.
Definition: MapFileFilter.java:38
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.exitArchetypeName
JTextComponent exitArchetypeName
The archetype name for auto-creating exits.
Definition: MiscPreferences.java:109
net.sf.gridarta.model.exitconnector.ExitConnectorModel.AUTO_CREATE_EXIT_DEFAULT
boolean AUTO_CREATE_EXIT_DEFAULT
The default value for isAutoCreateExit().
Definition: ExitConnectorModel.java:39
net.sf.gridarta.model.exitconnector.ExitConnectorModel.setExitArchetypeName
void setExitArchetypeName(@NotNull String exitArchetypeName)
Sets the archetype name for creating exit game objects.
net.sf.gridarta.utils.MapFileFilter.isPerformingRealChecks
static boolean isPerformingRealChecks()
Get whether to actually perform real checks or just file endings.
Definition: MapFileFilter.java:80
net.sf.gridarta.gui.dialog.prefs.PreferencesHelper
Helper class for preference panes.
Definition: PreferencesHelper.java:31
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.pasteExitName
AbstractButton pasteExitName
Check box to set whether the map name should be pasted into exit game objects.
Definition: MiscPreferences.java:97
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.gui.utils.GUIConstants
Defines common UI constants used in different dialogs.
Definition: GUIConstants.java:33
net.sf.gridarta.model.exitconnector.ExitConnectorModel.setPasteExitName
void setPasteExitName(boolean pasteExitName)
Sets whether the exit name should be updated.
net.sf.gridarta.model.exitconnector.ExitConnectorModel.PASTE_EXIT_NAME_DEFAULT
boolean PASTE_EXIT_NAME_DEFAULT
The default value for isPasteExitName().
Definition: ExitConnectorModel.java:34
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.projectSettings
final ProjectSettings projectSettings
The ProjectSettings to affect.
Definition: MiscPreferences.java:73
net.sf
net.sf.gridarta.model.settings.ProjectSettings.setUserName
void setUserName(@NotNull String userName)
Sets the user name.
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.MiscPreferences
MiscPreferences(@NotNull final ExitConnectorModel exitConnectorModel, @NotNull final ProjectSettings projectSettings, @NotNull final EditorSettings editorSettings)
Creates a new instance.
Definition: MiscPreferences.java:117
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.createTitledBorder
static Border createTitledBorder(@NotNull final String title)
Creates a titled border.
Definition: MiscPreferences.java:137
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.dialog.prefs.MiscPreferences.editorSettings
final EditorSettings editorSettings
The EditorSettings to affect.
Definition: MiscPreferences.java:79
net.sf.gridarta.gui
Graphical User Interface of Gridarta.
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.serialVersionUID
static final long serialVersionUID
The serial version UID.
Definition: MiscPreferences.java:55
net.sf.gridarta.model.settings.EditorSettings
Settings that apply to the editor.
Definition: EditorSettings.java:29
net
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.defaults
void defaults()
Definition: MiscPreferences.java:160
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.userField
JTextComponent userField
TextField for user / artist name.
Definition: MiscPreferences.java:84
net.sf.gridarta.model.settings.ProjectSettings.getUserName
String getUserName()
Returns the user name.
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.createCheckMapsPanel
Component createCheckMapsPanel()
Creates the sub-panel with the check maps settings.
Definition: MiscPreferences.java:192
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.createUserPanel
Component createUserPanel()
Creates the sub-panel with the user settings.
Definition: MiscPreferences.java:178
net.sf.gridarta.model.exitconnector.ExitConnectorModel.EXIT_ARCHETYPE_NAME_DEFAULT
String EXIT_ARCHETYPE_NAME_DEFAULT
The default value for getExitArchetypeName().
Definition: ExitConnectorModel.java:44
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.ACTION_BUILDER
static final ActionBuilder ACTION_BUILDER
Action Builder.
Definition: MiscPreferences.java:61
net.sf.gridarta.model.exitconnector.ExitConnectorModel.setAutoCreateExit
void setAutoCreateExit(boolean autoCreateExit)
Sets whether exit game objects should be auto-created when needed.
net.sf.gridarta.gui.dialog.prefs.MiscPreferences
Preferences Module for miscellaneous preferences.
Definition: MiscPreferences.java:50
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.model.exitconnector
Definition: AbstractExitConnectorModel.java:20
net.sf.gridarta.model.exitconnector.ExitConnectorModel.getExitArchetypeName
String getExitArchetypeName()
Returns the archetype name when creating exit game objects.
net.sf.gridarta.model.settings.ProjectSettings
Settings that apply to a project.
Definition: ProjectSettings.java:29
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.checkMaps
AbstractButton checkMaps
Check box to set whether map files should be really checked.
Definition: MiscPreferences.java:90
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.createExitConnectorPanel
Component createExitConnectorPanel()
Creates the sub-panel with the exit connector settings.
Definition: MiscPreferences.java:207
net.sf.gridarta.model
net.sf.gridarta.utils.MapFileFilter.setPerformingRealChecks
static void setPerformingRealChecks(final boolean performingRealChecks)
Set whether to actually perform real checks or just file endings.
Definition: MapFileFilter.java:70
net.sf.gridarta.model.exitconnector.ExitConnectorModel.isAutoCreateExit
boolean isAutoCreateExit()
Returns whether exit game objects should be auto-created when needed.
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.revert
void revert()
Definition: MiscPreferences.java:151
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.isChanged
boolean isChanged()
Definition: MiscPreferences.java:169
net.sf.gridarta.utils.ActionBuilderUtils
Utility class for ActionBuilder related functions.
Definition: ActionBuilderUtils.java:31
net.sf.gridarta.gui.utils
Definition: AnimationComponent.java:20
net.sf.gridarta.model.exitconnector.ExitConnectorModel
Stores information needed by the exit connector.
Definition: ExitConnectorModel.java:29
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.apply
void apply()
Definition: MiscPreferences.java:142
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.autoCreateExit
AbstractButton autoCreateExit
Check box to set whether exit game objects should be auto-created.
Definition: MiscPreferences.java:103
net.sf.gridarta.model.settings.EditorSettings.getUserNameDefault
String getUserNameDefault()
Returns the default user name.
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20
net.sf.gridarta.model.exitconnector.ExitConnectorModel.isPasteExitName
boolean isPasteExitName()
Returns whether the exit name should be updated.
net.sf.gridarta.model.settings
Definition: AbstractDefaultProjectSettings.java:20
net.sf.gridarta.gui.utils.GUIConstants.DIALOG_BORDER
Border DIALOG_BORDER
The Border object to be used when creating dialogs.
Definition: GUIConstants.java:38
net.sf.gridarta.gui.dialog.prefs.PreferencesHelper.addComponent
void addComponent(@NotNull final Component component)
Adds a component to the container.
Definition: PreferencesHelper.java:61
net.sf.gridarta.gui.dialog.prefs.MiscPreferences.exitConnectorModel
final ExitConnectorModel exitConnectorModel
The ExitConnectorModel to affect.
Definition: MiscPreferences.java:67