source: josm/trunk/src/org/openstreetmap/josm/gui/preferences/server/OsmApiUrlInputPanel.java@ 10137

Last change on this file since 10137 was 10137, checked in by Don-vip, 8 years ago

sonar, javadoc
  • Property svn:eol-style set to native
File size: 11.1 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.preferences.server;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.Font;
7import java.awt.GridBagConstraints;
8import java.awt.GridBagLayout;
9import java.awt.Insets;
10import java.awt.event.ActionEvent;
11import java.awt.event.ActionListener;
12import java.awt.event.FocusAdapter;
13import java.awt.event.FocusEvent;
14import java.awt.event.ItemEvent;
15import java.awt.event.ItemListener;
16import java.net.MalformedURLException;
17import java.net.URL;
18import java.util.Arrays;
19
20import javax.swing.AbstractAction;
21import javax.swing.JCheckBox;
22import javax.swing.JComponent;
23import javax.swing.JLabel;
24import javax.swing.JPanel;
25import javax.swing.SwingUtilities;
26import javax.swing.event.DocumentEvent;
27import javax.swing.event.DocumentListener;
28import javax.swing.text.JTextComponent;
29
30import org.openstreetmap.josm.Main;
31import org.openstreetmap.josm.data.preferences.CollectionProperty;
32import org.openstreetmap.josm.gui.SideButton;
33import org.openstreetmap.josm.gui.help.HelpUtil;
34import org.openstreetmap.josm.gui.widgets.AbstractTextComponentValidator;
35import org.openstreetmap.josm.gui.widgets.HistoryComboBox;
36import org.openstreetmap.josm.gui.widgets.SelectAllOnFocusGainedDecorator;
37import org.openstreetmap.josm.io.OsmApi;
38import org.openstreetmap.josm.tools.ImageProvider;
39import org.openstreetmap.josm.tools.Utils;
40
41/**
42 * Component allowing input os OSM API URL.
43 */
44public class OsmApiUrlInputPanel extends JPanel {
45
46 /**
47 * OSM API URL property key.
48 */
49 public static final String API_URL_PROP = OsmApiUrlInputPanel.class.getName() + ".apiUrl";
50
51 private JLabel lblValid;
52 private JLabel lblApiUrl;
53 private HistoryComboBox tfOsmServerUrl;
54 private transient ApiUrlValidator valOsmServerUrl;
55 private SideButton btnTest;
56 /** indicates whether to use the default OSM URL or not */
57 private JCheckBox cbUseDefaultServerUrl;
58 private final transient CollectionProperty SERVER_URL_HISTORY = new CollectionProperty("osm-server.url-history", Arrays.asList(
59 "http://api06.dev.openstreetmap.org/api", "http://master.apis.dev.openstreetmap.org/api"));
60
61 private transient ApiUrlPropagator propagator;
62
63 /**
64 * Constructs a new {@code OsmApiUrlInputPanel}.
65 */
66 public OsmApiUrlInputPanel() {
67 build();
68 HelpUtil.setHelpContext(this, HelpUtil.ht("/Preferences/Connection#ApiUrl"));
69 }
70
71 protected JComponent buildDefaultServerUrlPanel() {
72 cbUseDefaultServerUrl = new JCheckBox(tr("<html>Use the default OSM server URL (<strong>{0}</strong>)</html>", OsmApi.DEFAULT_API_URL));
73 cbUseDefaultServerUrl.addItemListener(new UseDefaultServerUrlChangeHandler());
74 cbUseDefaultServerUrl.setFont(cbUseDefaultServerUrl.getFont().deriveFont(Font.PLAIN));
75 return cbUseDefaultServerUrl;
76 }
77
78 protected final void build() {
79 setLayout(new GridBagLayout());
80 GridBagConstraints gc = new GridBagConstraints();
81
82 // the checkbox for the default UL
83 gc.fill = GridBagConstraints.HORIZONTAL;
84 gc.anchor = GridBagConstraints.NORTHWEST;
85 gc.weightx = 1.0;
86 gc.insets = new Insets(0, 0, 0, 0);
87 gc.gridwidth = 4;
88 add(buildDefaultServerUrlPanel(), gc);
89
90
91 // the input field for the URL
92 gc.gridx = 0;
93 gc.gridy = 1;
94 gc.gridwidth = 1;
95 gc.weightx = 0.0;
96 gc.insets = new Insets(0, 0, 0, 3);
97 add(lblApiUrl = new JLabel(tr("OSM Server URL:")), gc);
98
99 gc.gridx = 1;
100 gc.weightx = 1.0;
101 add(tfOsmServerUrl = new HistoryComboBox(), gc);
102 lblApiUrl.setLabelFor(tfOsmServerUrl);
103 SelectAllOnFocusGainedDecorator.decorate(tfOsmServerUrl.getEditorComponent());
104 valOsmServerUrl = new ApiUrlValidator(tfOsmServerUrl.getEditorComponent());
105 valOsmServerUrl.validate();
106 propagator = new ApiUrlPropagator();
107 tfOsmServerUrl.addActionListener(propagator);
108 tfOsmServerUrl.addFocusListener(propagator);
109
110 gc.gridx = 2;
111 gc.weightx = 0.0;
112 add(lblValid = new JLabel(), gc);
113
114 gc.gridx = 3;
115 gc.weightx = 0.0;
116 ValidateApiUrlAction actTest = new ValidateApiUrlAction();
117 tfOsmServerUrl.getEditorComponent().getDocument().addDocumentListener(actTest);
118 add(btnTest = new SideButton(actTest), gc);
119 }
120
121 /**
122 * Initializes the configuration panel with values from the preferences
123 */
124 public void initFromPreferences() {
125 String url = OsmApi.getOsmApi().getServerUrl();
126 tfOsmServerUrl.setPossibleItems(SERVER_URL_HISTORY.get());
127 if (OsmApi.DEFAULT_API_URL.equals(url.trim())) {
128 cbUseDefaultServerUrl.setSelected(true);
129 propagator.propagate(OsmApi.DEFAULT_API_URL);
130 } else {
131 cbUseDefaultServerUrl.setSelected(false);
132 tfOsmServerUrl.setText(url);
133 propagator.propagate(url);
134 }
135 }
136
137 /**
138 * Saves the values to the preferences
139 */
140 public void saveToPreferences() {
141 String oldUrl = OsmApi.getOsmApi().getServerUrl();
142 String hmiUrl = getStrippedApiUrl();
143 if (cbUseDefaultServerUrl.isSelected()) {
144 Main.pref.put("osm-server.url", null);
145 } else if (OsmApi.DEFAULT_API_URL.equals(hmiUrl)) {
146 Main.pref.put("osm-server.url", null);
147 } else {
148 Main.pref.put("osm-server.url", hmiUrl);
149 tfOsmServerUrl.addCurrentItemToHistory();
150 SERVER_URL_HISTORY.put(tfOsmServerUrl.getHistory());
151 }
152 String newUrl = OsmApi.getOsmApi().getServerUrl();
153
154 // When API URL changes, re-initialize API connection so we may adjust server-dependent settings.
155 if (!oldUrl.equals(newUrl)) {
156 try {
157 OsmApi.getOsmApi().initialize(null);
158 } catch (Exception x) {
159 Main.warn(x);
160 }
161 }
162 }
163
164 /**
165 * Returns the entered API URL, stripped of leading and trailing white characters.
166 * @return the entered API URL, stripped of leading and trailing white characters.
167 * May be an empty string if nothing has been entered. In this case, it means the user wants to use {@link OsmApi#DEFAULT_API_URL}.
168 * @see Utils#strip(String)
169 * @since 6602
170 */
171 public final String getStrippedApiUrl() {
172 return Utils.strip(tfOsmServerUrl.getText());
173 }
174
175 class ValidateApiUrlAction extends AbstractAction implements DocumentListener {
176 private String lastTestedUrl;
177
178 ValidateApiUrlAction() {
179 putValue(NAME, tr("Validate"));
180 putValue(SHORT_DESCRIPTION, tr("Test the API URL"));
181 updateEnabledState();
182 }
183
184 @Override
185 public void actionPerformed(ActionEvent arg0) {
186 final String url = getStrippedApiUrl();
187 final ApiUrlTestTask task = new ApiUrlTestTask(OsmApiUrlInputPanel.this, url);
188 Main.worker.submit(task);
189 Runnable r = new Runnable() {
190 @Override
191 public void run() {
192 if (task.isCanceled())
193 return;
194 Runnable r = new Runnable() {
195 @Override
196 public void run() {
197 if (task.isSuccess()) {
198 lblValid.setIcon(ImageProvider.get("dialogs", "valid"));
199 lblValid.setToolTipText(tr("The API URL is valid."));
200 lastTestedUrl = url;
201 updateEnabledState();
202 } else {
203 lblValid.setIcon(ImageProvider.get("warning-small"));
204 lblValid.setToolTipText(tr("Validation failed. The API URL seems to be invalid."));
205 }
206 }
207 };
208 SwingUtilities.invokeLater(r);
209 }
210 };
211 Main.worker.submit(r);
212 }
213
214 protected final void updateEnabledState() {
215 String url = getStrippedApiUrl();
216 boolean enabled = !url.isEmpty() && !url.equals(lastTestedUrl);
217 if (enabled) {
218 lblValid.setIcon(null);
219 }
220 setEnabled(enabled);
221 }
222
223 @Override
224 public void changedUpdate(DocumentEvent arg0) {
225 updateEnabledState();
226 }
227
228 @Override
229 public void insertUpdate(DocumentEvent arg0) {
230 updateEnabledState();
231 }
232
233 @Override
234 public void removeUpdate(DocumentEvent arg0) {
235 updateEnabledState();
236 }
237 }
238
239 /**
240 * Enables or disables the API URL input.
241 * @param enabled {@code true} to enable input, {@code false} otherwise
242 */
243 public void setApiUrlInputEnabled(boolean enabled) {
244 lblApiUrl.setEnabled(enabled);
245 tfOsmServerUrl.setEnabled(enabled);
246 lblValid.setEnabled(enabled);
247 btnTest.setEnabled(enabled);
248 }
249
250 private static class ApiUrlValidator extends AbstractTextComponentValidator {
251 ApiUrlValidator(JTextComponent tc) {
252 super(tc);
253 }
254
255 @Override
256 public boolean isValid() {
257 if (getComponent().getText().trim().isEmpty())
258 return false;
259
260 try {
261 new URL(getComponent().getText().trim());
262 return true;
263 } catch (MalformedURLException e) {
264 return false;
265 }
266 }
267
268 @Override
269 public void validate() {
270 if (getComponent().getText().trim().isEmpty()) {
271 feedbackInvalid(tr("OSM API URL must not be empty. Please enter the OSM API URL."));
272 return;
273 }
274 if (!isValid()) {
275 feedbackInvalid(tr("The current value is not a valid URL"));
276 } else {
277 feedbackValid(tr("Please enter the OSM API URL."));
278 }
279 }
280 }
281
282 /**
283 * Handles changes in the default URL
284 */
285 class UseDefaultServerUrlChangeHandler implements ItemListener {
286 @Override
287 public void itemStateChanged(ItemEvent e) {
288 switch(e.getStateChange()) {
289 case ItemEvent.SELECTED:
290 setApiUrlInputEnabled(false);
291 propagator.propagate(OsmApi.DEFAULT_API_URL);
292 break;
293 case ItemEvent.DESELECTED:
294 setApiUrlInputEnabled(true);
295 valOsmServerUrl.validate();
296 tfOsmServerUrl.requestFocusInWindow();
297 propagator.propagate();
298 break;
299 }
300 }
301 }
302
303 class ApiUrlPropagator extends FocusAdapter implements ActionListener {
304 protected void propagate() {
305 propagate(getStrippedApiUrl());
306 }
307
308 protected void propagate(String url) {
309 firePropertyChange(API_URL_PROP, null, url);
310 }
311
312 @Override
313 public void actionPerformed(ActionEvent e) {
314 propagate();
315 }
316
317 @Override
318 public void focusLost(FocusEvent arg0) {
319 propagate();
320 }
321 }
322}
Note: See TracBrowser for help on using the repository browser.