source: josm/trunk/src/org/openstreetmap/josm/gui/dialogs/OsmIdSelectionDialog.java@ 18173

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

fix #20690 - fix #21240 - Refactoring of UploadDialog, HistoryComboBox and AutoCompletingComboBox (patch by marcello)
  • Property svn:eol-style set to native
File size: 11.8 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.dialogs;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5import static org.openstreetmap.josm.tools.I18n.trc;
6
7import java.awt.Component;
8import java.awt.Dimension;
9import java.awt.event.KeyEvent;
10import java.awt.event.WindowEvent;
11import java.awt.event.WindowListener;
12import java.util.Arrays;
13import java.util.Collection;
14import java.util.Collections;
15import java.util.EnumSet;
16import java.util.List;
17import java.util.stream.Collectors;
18
19import javax.swing.BorderFactory;
20import javax.swing.GroupLayout;
21import javax.swing.JLabel;
22import javax.swing.JOptionPane;
23import javax.swing.JPanel;
24import javax.swing.KeyStroke;
25import javax.swing.border.EtchedBorder;
26import javax.swing.plaf.basic.BasicComboBoxEditor;
27
28import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
29import org.openstreetmap.josm.data.osm.PrimitiveId;
30import org.openstreetmap.josm.data.osm.SimplePrimitiveId;
31import org.openstreetmap.josm.gui.ExtendedDialog;
32import org.openstreetmap.josm.gui.datatransfer.ClipboardUtils;
33import org.openstreetmap.josm.gui.widgets.HistoryComboBox;
34import org.openstreetmap.josm.gui.widgets.HtmlPanel;
35import org.openstreetmap.josm.gui.widgets.JosmTextField;
36import org.openstreetmap.josm.gui.widgets.OsmIdTextField;
37import org.openstreetmap.josm.gui.widgets.OsmPrimitiveTypesComboBox;
38import org.openstreetmap.josm.spi.preferences.Config;
39import org.openstreetmap.josm.tools.Logging;
40import org.openstreetmap.josm.tools.Utils;
41
42/**
43 * Dialog prompt to user to let him choose OSM primitives by specifying their type and IDs.
44 * @since 6448, split from DownloadObjectDialog
45 */
46public class OsmIdSelectionDialog extends ExtendedDialog implements WindowListener {
47
48 protected final JPanel panel = new JPanel();
49 protected final OsmPrimitiveTypesComboBox cbType = new OsmPrimitiveTypesComboBox();
50 protected final OsmIdTextField tfId = new OsmIdTextField();
51 protected final HistoryComboBox cbId = new HistoryComboBox();
52 protected final transient GroupLayout layout = new GroupLayout(panel);
53
54 /**
55 * Creates a new OsmIdSelectionDialog
56 * @param parent The parent element that will be used for position and maximum size
57 * @param title The text that will be shown in the window titlebar
58 * @param buttonTexts String Array of the text that will appear on the buttons. The first button is the default one.
59 */
60 public OsmIdSelectionDialog(Component parent, String title, String... buttonTexts) {
61 super(parent, title, buttonTexts);
62 }
63
64 /**
65 * Creates a new OsmIdSelectionDialog
66 * @param parent The parent element that will be used for position and maximum size
67 * @param title The text that will be shown in the window titlebar
68 * @param buttonTexts String Array of the text that will appear on the buttons. The first button is the default one.
69 * @param modal Set it to {@code true} if you want the dialog to be modal
70 */
71 public OsmIdSelectionDialog(Component parent, String title, String[] buttonTexts, boolean modal) {
72 super(parent, title, buttonTexts, modal);
73 }
74
75 /**
76 * Creates a new OsmIdSelectionDialog
77 * @param parent The parent element that will be used for position and maximum size
78 * @param title The text that will be shown in the window titlebar
79 * @param buttonTexts String Array of the text that will appear on the buttons. The first button is the default one.
80 * @param modal Set it to {@code true} if you want the dialog to be modal
81 * @param disposeOnClose whether to call {@link #dispose} when closing the dialog
82 */
83 public OsmIdSelectionDialog(Component parent, String title, String[] buttonTexts, boolean modal, boolean disposeOnClose) {
84 super(parent, title, buttonTexts, modal, disposeOnClose);
85 }
86
87 protected void init() {
88 panel.setLayout(layout);
89 layout.setAutoCreateGaps(true);
90 layout.setAutoCreateContainerGaps(true);
91
92 JLabel lbl1 = new JLabel(tr("Object type:"));
93 lbl1.setLabelFor(cbType);
94
95 cbType.addItem(trc("osm object types", "mixed"));
96 cbType.setToolTipText(tr("Choose the OSM object type"));
97 JLabel lbl2 = new JLabel(tr("Object ID:"));
98 lbl2.setLabelFor(cbId);
99
100 cbId.setEditor(new BasicComboBoxEditor() {
101 @Override
102 protected JosmTextField createEditorComponent() {
103 return tfId;
104 }
105 });
106 cbId.setToolTipText(tr("Enter the ID of the object that should be downloaded"));
107 restorePrimitivesHistory(cbId);
108
109 // forward the enter key stroke to the download button
110 tfId.getKeymap().removeKeyStrokeBinding(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, 0, false));
111 tfId.setPreferredSize(new Dimension(400, tfId.getPreferredSize().height));
112
113 final String help1 = /* I18n: {0} and contains example strings not meant for translation. */
114 tr("Object IDs can be separated by comma or space, for instance: {0}",
115 "<b>" + Utils.joinAsHtmlUnorderedList(Arrays.asList("1 2 5", "1,2,5")) + "</b>");
116 final String help2 = /* I18n: {0} and contains example strings not meant for translation. {1}=n, {2}=w, {3}=r. */
117 tr("In mixed mode, specify objects like this: {0}<br/>"
118 + "({1} stands for <i>node</i>, {2} for <i>way</i>, and {3} for <i>relation</i>)",
119 "<b>w123, n110, w12, r15</b>", "<b>n</b>", "<b>w</b>", "<b>r</b>");
120 final String help3 = /* I18n: {0} and contains example strings not meant for translation. */
121 tr("Ranges of object IDs are specified with a hyphen, for instance: {0}",
122 "<b>" + Utils.joinAsHtmlUnorderedList(Arrays.asList("w1-5", "n30-37", "r501-5")) + "</b>");
123 HtmlPanel help = new HtmlPanel(help1 + "<br/>" + help2 + "<br/><br/>" + help3);
124 help.setBorder(BorderFactory.createEtchedBorder(EtchedBorder.LOWERED));
125
126 cbType.addItemListener(e -> {
127 tfId.setType(cbType.getType());
128 tfId.performValidation();
129 });
130
131 final GroupLayout.SequentialGroup sequentialGroup = layout.createSequentialGroup()
132 .addGroup(layout.createParallelGroup()
133 .addComponent(lbl1)
134 .addComponent(cbType, GroupLayout.PREFERRED_SIZE, GroupLayout.PREFERRED_SIZE, GroupLayout.PREFERRED_SIZE))
135 .addGroup(layout.createParallelGroup()
136 .addComponent(lbl2)
137 .addComponent(cbId, GroupLayout.PREFERRED_SIZE, GroupLayout.PREFERRED_SIZE, GroupLayout.PREFERRED_SIZE));
138
139 final GroupLayout.ParallelGroup parallelGroup = layout.createParallelGroup()
140 .addGroup(layout.createSequentialGroup()
141 .addGroup(layout.createParallelGroup()
142 .addComponent(lbl1)
143 .addComponent(lbl2)
144 )
145 .addGroup(layout.createParallelGroup()
146 .addComponent(cbType)
147 .addComponent(cbId))
148 );
149
150 for (Component i : getComponentsBeforeHelp()) {
151 sequentialGroup.addComponent(i);
152 parallelGroup.addComponent(i);
153 }
154
155 layout.setVerticalGroup(sequentialGroup.addComponent(help));
156 layout.setHorizontalGroup(parallelGroup.addComponent(help));
157 }
158
159 /**
160 * Let subclasses add custom components between the id input field and the help text
161 * @return the collections to add
162 */
163 protected Collection<Component> getComponentsBeforeHelp() {
164 return Collections.emptySet();
165 }
166
167 /**
168 * Allows subclasses to specify a different continue button index. If this button is pressed, the history is updated.
169 * @return the button index
170 */
171 public int getContinueButtonIndex() {
172 return 1;
173 }
174
175 /**
176 * Restore the current history from the preferences
177 *
178 * @param cbHistory the {@link HistoryComboBox} to which the history is restored to
179 */
180 protected void restorePrimitivesHistory(HistoryComboBox cbHistory) {
181 cbHistory.getModel().prefs().load(getClass().getName() + ".primitivesHistory");
182 }
183
184 /**
185 * Remind the current history in the preferences
186 *
187 * @param cbHistory the {@link HistoryComboBox} of which to restore the history
188 */
189 protected void remindPrimitivesHistory(HistoryComboBox cbHistory) {
190 cbHistory.addCurrentItemToHistory();
191 cbHistory.getModel().prefs().save(getClass().getName() + ".primitivesHistory");
192 }
193
194 /**
195 * Gets the requested OSM object IDs.
196 *
197 * @return The list of requested OSM object IDs
198 */
199 public final List<PrimitiveId> getOsmIds() {
200 return tfId.getIds();
201 }
202
203 @Override
204 public void setupDialog() {
205 setContent(panel, false);
206 try {
207 cbType.setSelectedIndex(Config.getPref().getInt("downloadprimitive.lasttype", 0));
208 } catch (IllegalArgumentException e) {
209 cbType.setSelectedIndex(0);
210 Logging.warn(e);
211 }
212 tfId.setType(cbType.getType());
213 if (Config.getPref().getBoolean("downloadprimitive.autopaste", true)) {
214 tryToPasteFromClipboard(tfId, cbType);
215 }
216 setDefaultButton(getContinueButtonIndex());
217 addWindowListener(this);
218 super.setupDialog();
219 }
220
221 protected void tryToPasteFromClipboard(OsmIdTextField tfId, OsmPrimitiveTypesComboBox cbType) {
222 String buf = ClipboardUtils.getClipboardStringContent();
223 if (buf == null || buf.isEmpty()) return;
224 if (buf.length() > Config.getPref().getInt("downloadprimitive.max-autopaste-length", 2000)) return;
225 final List<SimplePrimitiveId> ids = SimplePrimitiveId.fuzzyParse(buf);
226 if (!ids.isEmpty()) {
227 final String parsedText = ids.stream().map(x -> x.getType().getAPIName().charAt(0) + String.valueOf(x.getUniqueId()))
228 .collect(Collectors.joining(", "));
229 tfId.tryToPasteFrom(parsedText);
230 final EnumSet<OsmPrimitiveType> types = ids.stream().map(SimplePrimitiveId::getType).collect(
231 Collectors.toCollection(() -> EnumSet.noneOf(OsmPrimitiveType.class)));
232 if (types.size() == 1) {
233 // select corresponding type
234 cbType.setSelectedItem(types.iterator().next());
235 } else {
236 // select "mixed"
237 cbType.setSelectedIndex(3);
238 }
239 } else if (buf.matches("[\\d,v\\s]+")) {
240 //fallback solution for id1,id2,id3 format
241 tfId.tryToPasteFrom(buf);
242 }
243 }
244
245 @Override public void windowClosed(WindowEvent e) {
246 if (e != null && e.getComponent() == this && getValue() == getContinueButtonIndex()) {
247 Config.getPref().putInt("downloadprimitive.lasttype", cbType.getSelectedIndex());
248
249 if (!tfId.readIds()) {
250 JOptionPane.showMessageDialog(getParent(),
251 tr("Invalid ID list specified\n"
252 + "Cannot continue."),
253 tr("Information"),
254 JOptionPane.INFORMATION_MESSAGE
255 );
256 return;
257 }
258
259 remindPrimitivesHistory(cbId);
260 }
261 }
262
263 @Override public void windowOpened(WindowEvent e) {
264 // Do nothing
265 }
266
267 @Override public void windowClosing(WindowEvent e) {
268 // Do nothing
269 }
270
271 @Override public void windowIconified(WindowEvent e) {
272 // Do nothing
273 }
274
275 @Override public void windowDeiconified(WindowEvent e) {
276 // Do nothing
277 }
278
279 @Override public void windowActivated(WindowEvent e) {
280 // Do nothing
281 }
282
283 @Override public void windowDeactivated(WindowEvent e) {
284 // Do nothing
285 }
286}
Note: See TracBrowser for help on using the repository browser.