001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.gui.dialogs; 003 004import static org.openstreetmap.josm.tools.I18n.tr; 005import static org.openstreetmap.josm.tools.I18n.trc; 006 007import java.awt.Component; 008import java.awt.Dimension; 009import java.awt.event.KeyEvent; 010import java.awt.event.WindowEvent; 011import java.awt.event.WindowListener; 012import java.util.Arrays; 013import java.util.Collection; 014import java.util.Collections; 015import java.util.EnumSet; 016import java.util.LinkedList; 017import java.util.List; 018import java.util.stream.Collectors; 019 020import javax.swing.BorderFactory; 021import javax.swing.GroupLayout; 022import javax.swing.JLabel; 023import javax.swing.JOptionPane; 024import javax.swing.JPanel; 025import javax.swing.KeyStroke; 026import javax.swing.border.EtchedBorder; 027import javax.swing.plaf.basic.BasicComboBoxEditor; 028 029import org.openstreetmap.josm.data.osm.OsmPrimitiveType; 030import org.openstreetmap.josm.data.osm.PrimitiveId; 031import org.openstreetmap.josm.data.osm.SimplePrimitiveId; 032import org.openstreetmap.josm.gui.ExtendedDialog; 033import org.openstreetmap.josm.gui.datatransfer.ClipboardUtils; 034import org.openstreetmap.josm.gui.widgets.HistoryComboBox; 035import org.openstreetmap.josm.gui.widgets.HtmlPanel; 036import org.openstreetmap.josm.gui.widgets.JosmTextField; 037import org.openstreetmap.josm.gui.widgets.OsmIdTextField; 038import org.openstreetmap.josm.gui.widgets.OsmPrimitiveTypesComboBox; 039import org.openstreetmap.josm.spi.preferences.Config; 040import org.openstreetmap.josm.tools.Utils; 041 042/** 043 * Dialog prompt to user to let him choose OSM primitives by specifying their type and IDs. 044 * @since 6448, split from DownloadObjectDialog 045 */ 046public class OsmIdSelectionDialog extends ExtendedDialog implements WindowListener { 047 048 protected final JPanel panel = new JPanel(); 049 protected final OsmPrimitiveTypesComboBox cbType = new OsmPrimitiveTypesComboBox(); 050 protected final OsmIdTextField tfId = new OsmIdTextField(); 051 protected final HistoryComboBox cbId = new HistoryComboBox(); 052 protected final transient GroupLayout layout = new GroupLayout(panel); 053 054 /** 055 * Creates a new OsmIdSelectionDialog 056 * @param parent The parent element that will be used for position and maximum size 057 * @param title The text that will be shown in the window titlebar 058 * @param buttonTexts String Array of the text that will appear on the buttons. The first button is the default one. 059 */ 060 public OsmIdSelectionDialog(Component parent, String title, String... buttonTexts) { 061 super(parent, title, buttonTexts); 062 } 063 064 /** 065 * Creates a new OsmIdSelectionDialog 066 * @param parent The parent element that will be used for position and maximum size 067 * @param title The text that will be shown in the window titlebar 068 * @param buttonTexts String Array of the text that will appear on the buttons. The first button is the default one. 069 * @param modal Set it to {@code true} if you want the dialog to be modal 070 */ 071 public OsmIdSelectionDialog(Component parent, String title, String[] buttonTexts, boolean modal) { 072 super(parent, title, buttonTexts, modal); 073 } 074 075 /** 076 * Creates a new OsmIdSelectionDialog 077 * @param parent The parent element that will be used for position and maximum size 078 * @param title The text that will be shown in the window titlebar 079 * @param buttonTexts String Array of the text that will appear on the buttons. The first button is the default one. 080 * @param modal Set it to {@code true} if you want the dialog to be modal 081 * @param disposeOnClose whether to call {@link #dispose} when closing the dialog 082 */ 083 public OsmIdSelectionDialog(Component parent, String title, String[] buttonTexts, boolean modal, boolean disposeOnClose) { 084 super(parent, title, buttonTexts, modal, disposeOnClose); 085 } 086 087 protected void init() { 088 panel.setLayout(layout); 089 layout.setAutoCreateGaps(true); 090 layout.setAutoCreateContainerGaps(true); 091 092 JLabel lbl1 = new JLabel(tr("Object type:")); 093 lbl1.setLabelFor(cbType); 094 095 cbType.addItem(trc("osm object types", "mixed")); 096 cbType.setToolTipText(tr("Choose the OSM object type")); 097 JLabel lbl2 = new JLabel(tr("Object ID:")); 098 lbl2.setLabelFor(cbId); 099 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 List<String> cmtHistory = new LinkedList<>( 182 Config.getPref().getList(getClass().getName() + ".primitivesHistory", new LinkedList<String>())); 183 // we have to reverse the history, because ComboBoxHistory will reverse it again in addElement() 184 Collections.reverse(cmtHistory); 185 cbHistory.setPossibleItems(cmtHistory); 186 } 187 188 /** 189 * Remind the current history in the preferences 190 * 191 * @param cbHistory the {@link HistoryComboBox} of which to restore the history 192 */ 193 protected void remindPrimitivesHistory(HistoryComboBox cbHistory) { 194 cbHistory.addCurrentItemToHistory(); 195 Config.getPref().putList(getClass().getName() + ".primitivesHistory", cbHistory.getHistory()); 196 } 197 198 /** 199 * Gets the requested OSM object IDs. 200 * 201 * @return The list of requested OSM object IDs 202 */ 203 public final List<PrimitiveId> getOsmIds() { 204 return tfId.getIds(); 205 } 206 207 @Override 208 public void setupDialog() { 209 setContent(panel, false); 210 cbType.setSelectedIndex(Config.getPref().getInt("downloadprimitive.lasttype", 0)); 211 tfId.setType(cbType.getType()); 212 if (Config.getPref().getBoolean("downloadprimitive.autopaste", true)) { 213 tryToPasteFromClipboard(tfId, cbType); 214 } 215 setDefaultButton(getContinueButtonIndex()); 216 addWindowListener(this); 217 super.setupDialog(); 218 } 219 220 protected void tryToPasteFromClipboard(OsmIdTextField tfId, OsmPrimitiveTypesComboBox cbType) { 221 String buf = ClipboardUtils.getClipboardStringContent(); 222 if (buf == null || buf.isEmpty()) return; 223 if (buf.length() > Config.getPref().getInt("downloadprimitive.max-autopaste-length", 2000)) return; 224 final List<SimplePrimitiveId> ids = SimplePrimitiveId.fuzzyParse(buf); 225 if (!ids.isEmpty()) { 226 final String parsedText = ids.stream().map(x -> x.getType().getAPIName().charAt(0) + String.valueOf(x.getUniqueId())) 227 .collect(Collectors.joining(", ")); 228 tfId.tryToPasteFrom(parsedText); 229 final EnumSet<OsmPrimitiveType> types = ids.stream().map(SimplePrimitiveId::getType).collect( 230 Collectors.toCollection(() -> EnumSet.noneOf(OsmPrimitiveType.class))); 231 if (types.size() == 1) { 232 // select corresponding type 233 cbType.setSelectedItem(types.iterator().next()); 234 } else { 235 // select "mixed" 236 cbType.setSelectedIndex(3); 237 } 238 } else if (buf.matches("[\\d,v\\s]+")) { 239 //fallback solution for id1,id2,id3 format 240 tfId.tryToPasteFrom(buf); 241 } 242 } 243 244 @Override public void windowClosed(WindowEvent e) { 245 if (e != null && e.getComponent() == this && getValue() == getContinueButtonIndex()) { 246 Config.getPref().putInt("downloadprimitive.lasttype", cbType.getSelectedIndex()); 247 248 if (!tfId.readIds()) { 249 JOptionPane.showMessageDialog(getParent(), 250 tr("Invalid ID list specified\n" 251 + "Cannot continue."), 252 tr("Information"), 253 JOptionPane.INFORMATION_MESSAGE 254 ); 255 return; 256 } 257 258 remindPrimitivesHistory(cbId); 259 } 260 } 261 262 @Override public void windowOpened(WindowEvent e) { 263 // Do nothing 264 } 265 266 @Override public void windowClosing(WindowEvent e) { 267 // Do nothing 268 } 269 270 @Override public void windowIconified(WindowEvent e) { 271 // Do nothing 272 } 273 274 @Override public void windowDeiconified(WindowEvent e) { 275 // Do nothing 276 } 277 278 @Override public void windowActivated(WindowEvent e) { 279 // Do nothing 280 } 281 282 @Override public void windowDeactivated(WindowEvent e) { 283 // Do nothing 284 } 285}