Gridarta Editor
UpdatePreferences.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 java.util.prefs.Preferences;
25 import javax.swing.AbstractButton;
26 import javax.swing.Box;
27 import javax.swing.JCheckBox;
28 import javax.swing.JComboBox;
29 import javax.swing.JComponent;
30 import javax.swing.JPanel;
31 import javax.swing.border.Border;
32 import javax.swing.border.CompoundBorder;
33 import javax.swing.border.TitledBorder;
34 import net.sf.gridarta.MainControl;
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 net.sf.japi.swing.prefs.AbstractPrefs;
42 import org.jetbrains.annotations.NotNull;
43 
49 public class UpdatePreferences extends AbstractPrefs {
50 
54  private static final long serialVersionUID = 1L;
55 
59  @NotNull
60  private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
61 
65  @NotNull
66  private static final Preferences PREFERENCES = Preferences.userNodeForPackage(MainControl.class);
67 
71  @NotNull
72  private AbstractButton autoUpdate;
73 
77  @NotNull
78  private JComboBox<String> interval;
79 
83  public UpdatePreferences() {
84  setListLabelText(ActionBuilderUtils.getString(ACTION_BUILDER, "prefsUpdate.title"));
85  setListLabelIcon(ACTION_BUILDER.getIcon("prefsUpdate.icon"));
86 
87  add(createUpdatePanel());
88  add(Box.createVerticalGlue());
89  }
90 
96  @NotNull
97  private static Border createTitledBorder(@NotNull final String titleKey) {
98  return new CompoundBorder(new TitledBorder(ActionBuilderUtils.getString(ACTION_BUILDER, titleKey)), GUIConstants.DIALOG_BORDER);
99  }
100 
101  @Override
102  public void apply() {
103  PREFERENCES.putBoolean(UpdaterManager.AUTO_CHECK_KEY, autoUpdate.isSelected());
104  PREFERENCES.putInt(UpdaterManager.INTERVAL_KEY, interval.getSelectedIndex());
105  }
106 
107  @Override
108  public void revert() {
111  }
112 
113  @Override
114  public void defaults() {
116  interval.setSelectedIndex(UpdaterManager.INTERVAL_DEFAULT);
117  }
118 
119  @Override
120  public boolean isChanged() {
122  }
123 
128  @NotNull
129  private Component createUpdatePanel() {
130  final JComponent panel = new JPanel(new GridBagLayout());
131  final PreferencesHelper preferencesHelper = new PreferencesHelper(panel);
132  panel.setBorder(createTitledBorder("optionsUpdate"));
133  autoUpdate = new JCheckBox(ACTION_BUILDER.createToggle(false, "autoUpdate", this));
135  preferencesHelper.addComponent(autoUpdate);
136  preferencesHelper.addComponent(createComboBox());
137  return panel;
138  }
139 
144  @ActionMethod
145  public void setAutoUpdate(final boolean autoUpdate) {
146  interval.setEnabled(autoUpdate);
147  }
148 
153  @ActionMethod
154  public boolean isAutoUpdate() {
155  return interval.isEnabled();
156  }
157 
162  @NotNull
163  private Component createComboBox() {
164  final String[] items = { ActionBuilderUtils.getString(ACTION_BUILDER, "prefsUpdateAuto0.text"), ActionBuilderUtils.getString(ACTION_BUILDER, "prefsUpdateAuto1.text"), ActionBuilderUtils.getString(ACTION_BUILDER, "prefsUpdateAuto2.text"), ActionBuilderUtils.getString(ACTION_BUILDER, "prefsUpdateAuto3.text"), };
165  interval = new JComboBox<>(items);
166  interval.setEditable(false);
169  return interval;
170  }
171 
172 }
net.sf.gridarta.updater
Definition: Updater.java:20
net.sf.gridarta.gui.dialog.prefs.UpdatePreferences
Preferences Module for update preferences.
Definition: UpdatePreferences.java:49
net.sf.gridarta.gui.dialog.prefs.UpdatePreferences.PREFERENCES
static final Preferences PREFERENCES
Preferences.
Definition: UpdatePreferences.java:66
net.sf.gridarta.gui.dialog.prefs.PreferencesHelper
Helper class for preference panes.
Definition: PreferencesHelper.java:31
net.sf.gridarta.gui.dialog.prefs.UpdatePreferences.createTitledBorder
static Border createTitledBorder(@NotNull final String titleKey)
Creates a titled border.
Definition: UpdatePreferences.java:97
net.sf.gridarta.gui.dialog.prefs.UpdatePreferences.apply
void apply()
Definition: UpdatePreferences.java:102
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.updater.UpdaterManager.INTERVAL_KEY
static final String INTERVAL_KEY
Preferences key for selected update interval.
Definition: UpdaterManager.java:67
net.sf
net.sf.gridarta.gui.dialog.prefs.UpdatePreferences.defaults
void defaults()
Definition: UpdatePreferences.java:114
net.sf.gridarta.gui.dialog.prefs.UpdatePreferences.ACTION_BUILDER
static final ActionBuilder ACTION_BUILDER
Action Builder.
Definition: UpdatePreferences.java:60
net.sf.gridarta.gui.dialog.prefs.UpdatePreferences.createUpdatePanel
Component createUpdatePanel()
Creates the sub-panel with the update settings.
Definition: UpdatePreferences.java:129
net.sf.gridarta.gui
Graphical User Interface of Gridarta.
net.sf.gridarta.gui.dialog.prefs.UpdatePreferences.isChanged
boolean isChanged()
Definition: UpdatePreferences.java:120
net.sf.gridarta.gui.dialog.prefs.UpdatePreferences.isAutoUpdate
boolean isAutoUpdate()
Returns the auto-update state.
Definition: UpdatePreferences.java:154
net
net.sf.gridarta.gui.dialog.prefs.UpdatePreferences.UpdatePreferences
UpdatePreferences()
Creates a new instance.
Definition: UpdatePreferences.java:83
net.sf.gridarta.gui.dialog.prefs.UpdatePreferences.setAutoUpdate
void setAutoUpdate(final boolean autoUpdate)
Sets the auto-update state.
Definition: UpdatePreferences.java:145
net.sf.gridarta.updater.UpdaterManager.AUTO_CHECK_DEFAULT
static final boolean AUTO_CHECK_DEFAULT
Preferences default value for AUTO_CHECK_KEY.
Definition: UpdaterManager.java:61
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.prefs.UpdatePreferences.serialVersionUID
static final long serialVersionUID
The serial version UID.
Definition: UpdatePreferences.java:54
net.sf.gridarta.updater.UpdaterManager
This class handles updating the map editor.
Definition: UpdaterManager.java:38
net.sf.gridarta.updater.UpdaterManager.AUTO_CHECK_KEY
static final String AUTO_CHECK_KEY
Preferences key whether to automatically check for updates.
Definition: UpdaterManager.java:56
net.sf.gridarta.updater.UpdaterManager.INTERVAL_DEFAULT
static final int INTERVAL_DEFAULT
Preferences default value for INTERVAL_KEY.
Definition: UpdaterManager.java:72
net.sf.gridarta.gui.dialog.prefs.UpdatePreferences.createComboBox
Component createComboBox()
Creates the component with update choices.
Definition: UpdatePreferences.java:163
net.sf.gridarta.gui.dialog.prefs.UpdatePreferences.revert
void revert()
Definition: UpdatePreferences.java:108
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.gui.dialog.prefs.UpdatePreferences.autoUpdate
AbstractButton autoUpdate
Checkbox whether to automatically check for updates on startup.
Definition: UpdatePreferences.java:72
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20
net.sf.gridarta.gui.dialog.prefs.UpdatePreferences.interval
JComboBox< String > interval
ComboBox with selected interval.
Definition: UpdatePreferences.java:78
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.MainControl
Interface used as preferences location.
Definition: MainControl.java:27