source: josm/trunk/src/org/openstreetmap/josm/gui/dialogs/relation/GenericRelationEditor.java@ 10627

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

sonar - squid:S1166 - Exception handlers should preserve the original exceptions
  • Property svn:eol-style set to native
File size: 40.1 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.dialogs.relation;
3
4import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
5import static org.openstreetmap.josm.tools.I18n.tr;
6
7import java.awt.BorderLayout;
8import java.awt.Dimension;
9import java.awt.FlowLayout;
10import java.awt.GraphicsEnvironment;
11import java.awt.GridBagConstraints;
12import java.awt.GridBagLayout;
13import java.awt.Window;
14import java.awt.datatransfer.Clipboard;
15import java.awt.datatransfer.FlavorListener;
16import java.awt.event.ActionEvent;
17import java.awt.event.FocusAdapter;
18import java.awt.event.FocusEvent;
19import java.awt.event.InputEvent;
20import java.awt.event.KeyEvent;
21import java.awt.event.MouseAdapter;
22import java.awt.event.MouseEvent;
23import java.awt.event.WindowAdapter;
24import java.awt.event.WindowEvent;
25import java.util.ArrayList;
26import java.util.Collection;
27import java.util.Collections;
28import java.util.EnumSet;
29import java.util.HashSet;
30import java.util.List;
31import java.util.Set;
32
33import javax.swing.AbstractAction;
34import javax.swing.BorderFactory;
35import javax.swing.InputMap;
36import javax.swing.JButton;
37import javax.swing.JComponent;
38import javax.swing.JLabel;
39import javax.swing.JMenuItem;
40import javax.swing.JOptionPane;
41import javax.swing.JPanel;
42import javax.swing.JRootPane;
43import javax.swing.JScrollPane;
44import javax.swing.JSplitPane;
45import javax.swing.JTabbedPane;
46import javax.swing.JTable;
47import javax.swing.JToolBar;
48import javax.swing.KeyStroke;
49
50import org.openstreetmap.josm.Main;
51import org.openstreetmap.josm.actions.ExpertToggleAction;
52import org.openstreetmap.josm.actions.JosmAction;
53import org.openstreetmap.josm.command.ChangeCommand;
54import org.openstreetmap.josm.command.Command;
55import org.openstreetmap.josm.data.osm.OsmPrimitive;
56import org.openstreetmap.josm.data.osm.Relation;
57import org.openstreetmap.josm.data.osm.RelationMember;
58import org.openstreetmap.josm.data.osm.Tag;
59import org.openstreetmap.josm.gui.ConditionalOptionPaneUtil;
60import org.openstreetmap.josm.gui.DefaultNameFormatter;
61import org.openstreetmap.josm.gui.MainMenu;
62import org.openstreetmap.josm.gui.datatransfer.ClipboardUtils;
63import org.openstreetmap.josm.gui.dialogs.relation.actions.AddSelectedAfterSelection;
64import org.openstreetmap.josm.gui.dialogs.relation.actions.AddSelectedAtEndAction;
65import org.openstreetmap.josm.gui.dialogs.relation.actions.AddSelectedAtStartAction;
66import org.openstreetmap.josm.gui.dialogs.relation.actions.AddSelectedBeforeSelection;
67import org.openstreetmap.josm.gui.dialogs.relation.actions.ApplyAction;
68import org.openstreetmap.josm.gui.dialogs.relation.actions.CancelAction;
69import org.openstreetmap.josm.gui.dialogs.relation.actions.CopyMembersAction;
70import org.openstreetmap.josm.gui.dialogs.relation.actions.DeleteCurrentRelationAction;
71import org.openstreetmap.josm.gui.dialogs.relation.actions.DownloadIncompleteMembersAction;
72import org.openstreetmap.josm.gui.dialogs.relation.actions.DownloadSelectedIncompleteMembersAction;
73import org.openstreetmap.josm.gui.dialogs.relation.actions.DuplicateRelationAction;
74import org.openstreetmap.josm.gui.dialogs.relation.actions.EditAction;
75import org.openstreetmap.josm.gui.dialogs.relation.actions.MoveDownAction;
76import org.openstreetmap.josm.gui.dialogs.relation.actions.MoveUpAction;
77import org.openstreetmap.josm.gui.dialogs.relation.actions.OKAction;
78import org.openstreetmap.josm.gui.dialogs.relation.actions.PasteMembersAction;
79import org.openstreetmap.josm.gui.dialogs.relation.actions.RefreshAction;
80import org.openstreetmap.josm.gui.dialogs.relation.actions.RemoveAction;
81import org.openstreetmap.josm.gui.dialogs.relation.actions.RemoveSelectedAction;
82import org.openstreetmap.josm.gui.dialogs.relation.actions.ReverseAction;
83import org.openstreetmap.josm.gui.dialogs.relation.actions.SelectPrimitivesForSelectedMembersAction;
84import org.openstreetmap.josm.gui.dialogs.relation.actions.SelectedMembersForSelectionAction;
85import org.openstreetmap.josm.gui.dialogs.relation.actions.SetRoleAction;
86import org.openstreetmap.josm.gui.dialogs.relation.actions.SortAction;
87import org.openstreetmap.josm.gui.dialogs.relation.actions.SortBelowAction;
88import org.openstreetmap.josm.gui.help.ContextSensitiveHelpAction;
89import org.openstreetmap.josm.gui.help.HelpUtil;
90import org.openstreetmap.josm.gui.layer.OsmDataLayer;
91import org.openstreetmap.josm.gui.tagging.TagEditorPanel;
92import org.openstreetmap.josm.gui.tagging.ac.AutoCompletingTextField;
93import org.openstreetmap.josm.gui.tagging.ac.AutoCompletionList;
94import org.openstreetmap.josm.gui.tagging.presets.TaggingPreset;
95import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetHandler;
96import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetType;
97import org.openstreetmap.josm.gui.tagging.presets.TaggingPresets;
98import org.openstreetmap.josm.tools.CheckParameterUtil;
99import org.openstreetmap.josm.tools.Shortcut;
100import org.openstreetmap.josm.tools.WindowGeometry;
101
102/**
103 * This dialog is for editing relations.
104 * @since 343
105 */
106public class GenericRelationEditor extends RelationEditor {
107 /** the tag table and its model */
108 private final TagEditorPanel tagEditorPanel;
109 private final ReferringRelationsBrowser referrerBrowser;
110 private final ReferringRelationsBrowserModel referrerModel;
111
112 /** the member table and its model */
113 private final MemberTable memberTable;
114 private final MemberTableModel memberTableModel;
115
116 /** the selection table and its model */
117 private final SelectionTable selectionTable;
118 private final SelectionTableModel selectionTableModel;
119
120 private final AutoCompletingTextField tfRole;
121
122 /**
123 * the menu item in the windows menu. Required to properly hide on dialog close.
124 */
125 private JMenuItem windowMenuItem;
126 /**
127 * The toolbar with the buttons on the left
128 */
129 private final LeftButtonToolbar leftButtonToolbar;
130 /**
131 * Action for performing the {@link RefreshAction}
132 */
133 private final RefreshAction refreshAction;
134 /**
135 * Action for performing the {@link ApplyAction}
136 */
137 private final ApplyAction applyAction;
138 /**
139 * Action for performing the {@link DuplicateRelationAction}
140 */
141 private final DuplicateRelationAction duplicateAction;
142 /**
143 * Action for performing the {@link DeleteCurrentRelationAction}
144 */
145 private final DeleteCurrentRelationAction deleteAction;
146 /**
147 * Action for performing the {@link OKAction}
148 */
149 private final OKAction okAction;
150 /**
151 * Action for performing the {@link CancelAction}
152 */
153 private final CancelAction cancelAction;
154 /**
155 * A list of listeners that need to be notified on clipboard content changes.
156 */
157 private final ArrayList<FlavorListener> clipboardListeners = new ArrayList<>();
158
159 /**
160 * Creates a new relation editor for the given relation. The relation will be saved if the user
161 * selects "ok" in the editor.
162 *
163 * If no relation is given, will create an editor for a new relation.
164 *
165 * @param layer the {@link OsmDataLayer} the new or edited relation belongs to
166 * @param relation relation to edit, or null to create a new one.
167 * @param selectedMembers a collection of members which shall be selected initially
168 */
169 public GenericRelationEditor(OsmDataLayer layer, Relation relation, Collection<RelationMember> selectedMembers) {
170 super(layer, relation);
171
172 setRememberWindowGeometry(getClass().getName() + ".geometry",
173 WindowGeometry.centerInWindow(Main.parent, new Dimension(700, 650)));
174
175 final TaggingPresetHandler presetHandler = new TaggingPresetHandler() {
176
177 @Override
178 public void updateTags(List<Tag> tags) {
179 tagEditorPanel.getModel().updateTags(tags);
180 }
181
182 @Override
183 public Collection<OsmPrimitive> getSelection() {
184 Relation relation = new Relation();
185 tagEditorPanel.getModel().applyToPrimitive(relation);
186 return Collections.<OsmPrimitive>singletonList(relation);
187 }
188 };
189
190 // init the various models
191 //
192 memberTableModel = new MemberTableModel(relation, getLayer(), presetHandler);
193 memberTableModel.register();
194 selectionTableModel = new SelectionTableModel(getLayer());
195 selectionTableModel.register();
196 referrerModel = new ReferringRelationsBrowserModel(relation);
197
198 tagEditorPanel = new TagEditorPanel(relation, presetHandler);
199 populateModels(relation);
200 tagEditorPanel.getModel().ensureOneTag();
201
202 // setting up the member table
203 memberTable = new MemberTable(getLayer(), getRelation(), memberTableModel);
204 memberTable.addMouseListener(new MemberTableDblClickAdapter());
205 memberTableModel.addMemberModelListener(memberTable);
206
207 MemberRoleCellEditor ce = (MemberRoleCellEditor) memberTable.getColumnModel().getColumn(0).getCellEditor();
208 selectionTable = new SelectionTable(selectionTableModel, memberTableModel);
209 selectionTable.setRowHeight(ce.getEditor().getPreferredSize().height);
210
211 leftButtonToolbar = new LeftButtonToolbar(memberTable, memberTableModel, this);
212 tfRole = buildRoleTextField(this);
213
214 JSplitPane pane = buildSplitPane(
215 buildTagEditorPanel(tagEditorPanel),
216 buildMemberEditorPanel(memberTable, memberTableModel, selectionTable, selectionTableModel, this, leftButtonToolbar, tfRole),
217 this);
218 pane.setPreferredSize(new Dimension(100, 100));
219
220 JPanel pnl = new JPanel(new BorderLayout());
221 pnl.add(pane, BorderLayout.CENTER);
222 pnl.setBorder(BorderFactory.createRaisedBevelBorder());
223
224 getContentPane().setLayout(new BorderLayout());
225 JTabbedPane tabbedPane = new JTabbedPane();
226 tabbedPane.add(tr("Tags and Members"), pnl);
227 referrerBrowser = new ReferringRelationsBrowser(getLayer(), referrerModel);
228 tabbedPane.add(tr("Parent Relations"), referrerBrowser);
229 tabbedPane.add(tr("Child Relations"), new ChildRelationBrowser(getLayer(), relation));
230 tabbedPane.addChangeListener(e -> {
231 JTabbedPane sourceTabbedPane = (JTabbedPane) e.getSource();
232 int index = sourceTabbedPane.getSelectedIndex();
233 String title = sourceTabbedPane.getTitleAt(index);
234 if (title.equals(tr("Parent Relations"))) {
235 referrerBrowser.init();
236 }
237 });
238
239 refreshAction = new RefreshAction(memberTable, memberTableModel, tagEditorPanel.getModel(), getLayer(), this);
240 applyAction = new ApplyAction(memberTable, memberTableModel, tagEditorPanel.getModel(), getLayer(), this);
241 duplicateAction = new DuplicateRelationAction(memberTableModel, tagEditorPanel.getModel(), getLayer());
242 deleteAction = new DeleteCurrentRelationAction(getLayer(), this);
243 addPropertyChangeListener(deleteAction);
244
245 okAction = new OKAction(memberTable, memberTableModel, tagEditorPanel.getModel(), getLayer(), this, tfRole);
246 cancelAction = new CancelAction(memberTable, memberTableModel, tagEditorPanel.getModel(), getLayer(), this, tfRole);
247
248 getContentPane().add(buildToolBar(refreshAction, applyAction, duplicateAction, deleteAction), BorderLayout.NORTH);
249 getContentPane().add(tabbedPane, BorderLayout.CENTER);
250 getContentPane().add(buildOkCancelButtonPanel(okAction, cancelAction), BorderLayout.SOUTH);
251
252 setSize(findMaxDialogSize());
253
254 setDefaultCloseOperation(DO_NOTHING_ON_CLOSE);
255 addWindowListener(
256 new WindowAdapter() {
257 @Override
258 public void windowOpened(WindowEvent e) {
259 cleanSelfReferences(memberTableModel, getRelation());
260 }
261
262 @Override
263 public void windowClosing(WindowEvent e) {
264 cancel();
265 }
266 }
267 );
268 // CHECKSTYLE.OFF: LineLength
269 registerCopyPasteAction(tagEditorPanel.getPasteAction(), "PASTE_TAGS",
270 Shortcut.registerShortcut("system:pastestyle", tr("Edit: {0}", tr("Paste Tags")), KeyEvent.VK_V, Shortcut.CTRL_SHIFT).getKeyStroke(),
271 getRootPane(), memberTable, selectionTable);
272 // CHECKSTYLE.ON: LineLength
273
274 registerCopyPasteAction(new PasteMembersAction(memberTable, getLayer(), this) {
275 @Override
276 public void actionPerformed(ActionEvent e) {
277 super.actionPerformed(e);
278 tfRole.requestFocusInWindow();
279 }
280 }, "PASTE_MEMBERS", Shortcut.getPasteKeyStroke(), getRootPane(), memberTable, selectionTable);
281
282 registerCopyPasteAction(new CopyMembersAction(memberTableModel, getLayer(), this),
283 "COPY_MEMBERS", Shortcut.getCopyKeyStroke(), getRootPane(), memberTable, selectionTable);
284
285 tagEditorPanel.setNextFocusComponent(memberTable);
286 selectionTable.setFocusable(false);
287 memberTableModel.setSelectedMembers(selectedMembers);
288 HelpUtil.setHelpContext(getRootPane(), ht("/Dialog/RelationEditor"));
289 }
290
291 @Override
292 public void reloadDataFromRelation() {
293 setRelation(getRelation());
294 populateModels(getRelation());
295 refreshAction.updateEnabledState();
296 }
297
298 private void populateModels(Relation relation) {
299 if (relation != null) {
300 tagEditorPanel.getModel().initFromPrimitive(relation);
301 memberTableModel.populate(relation);
302 if (!getLayer().data.getRelations().contains(relation)) {
303 // treat it as a new relation if it doesn't exist in the data set yet.
304 setRelation(null);
305 }
306 } else {
307 tagEditorPanel.getModel().clear();
308 memberTableModel.populate(null);
309 }
310 }
311
312 /**
313 * Apply changes.
314 * @see ApplyAction
315 */
316 public void apply() {
317 applyAction.actionPerformed(null);
318 }
319
320 /**
321 * Cancel changes.
322 * @see CancelAction
323 */
324 public void cancel() {
325 cancelAction.actionPerformed(null);
326 }
327
328 /**
329 * Creates the toolbar
330 * @param refreshAction refresh action
331 * @param applyAction apply action
332 * @param duplicateAction duplicate action
333 * @param deleteAction delete action
334 *
335 * @return the toolbar
336 */
337 protected static JToolBar buildToolBar(RefreshAction refreshAction, ApplyAction applyAction,
338 DuplicateRelationAction duplicateAction, DeleteCurrentRelationAction deleteAction) {
339 JToolBar tb = new JToolBar();
340 tb.setFloatable(false);
341 tb.add(refreshAction);
342 tb.add(applyAction);
343 tb.add(duplicateAction);
344 tb.add(deleteAction);
345 return tb;
346 }
347
348 /**
349 * builds the panel with the OK and the Cancel button
350 * @param okAction OK action
351 * @param cancelAction Cancel action
352 *
353 * @return the panel with the OK and the Cancel button
354 */
355 protected static JPanel buildOkCancelButtonPanel(OKAction okAction, CancelAction cancelAction) {
356 JPanel pnl = new JPanel(new FlowLayout(FlowLayout.CENTER));
357 pnl.add(new JButton(okAction));
358 pnl.add(new JButton(cancelAction));
359 pnl.add(new JButton(new ContextSensitiveHelpAction(ht("/Dialog/RelationEditor"))));
360 return pnl;
361 }
362
363 /**
364 * builds the panel with the tag editor
365 * @param tagEditorPanel tag editor panel
366 *
367 * @return the panel with the tag editor
368 */
369 protected static JPanel buildTagEditorPanel(TagEditorPanel tagEditorPanel) {
370 JPanel pnl = new JPanel(new GridBagLayout());
371
372 GridBagConstraints gc = new GridBagConstraints();
373 gc.gridx = 0;
374 gc.gridy = 0;
375 gc.gridheight = 1;
376 gc.gridwidth = 1;
377 gc.fill = GridBagConstraints.HORIZONTAL;
378 gc.anchor = GridBagConstraints.FIRST_LINE_START;
379 gc.weightx = 1.0;
380 gc.weighty = 0.0;
381 pnl.add(new JLabel(tr("Tags")), gc);
382
383 gc.gridx = 0;
384 gc.gridy = 1;
385 gc.fill = GridBagConstraints.BOTH;
386 gc.anchor = GridBagConstraints.CENTER;
387 gc.weightx = 1.0;
388 gc.weighty = 1.0;
389 pnl.add(tagEditorPanel, gc);
390 return pnl;
391 }
392
393 /**
394 * builds the role text field
395 * @param re relation editor
396 * @return the role text field
397 */
398 protected static AutoCompletingTextField buildRoleTextField(final IRelationEditor re) {
399 final AutoCompletingTextField tfRole = new AutoCompletingTextField(10);
400 tfRole.setToolTipText(tr("Enter a role and apply it to the selected relation members"));
401 tfRole.addFocusListener(new FocusAdapter() {
402 @Override
403 public void focusGained(FocusEvent e) {
404 tfRole.selectAll();
405 }
406 });
407 tfRole.setAutoCompletionList(new AutoCompletionList());
408 tfRole.addFocusListener(
409 new FocusAdapter() {
410 @Override
411 public void focusGained(FocusEvent e) {
412 AutoCompletionList list = tfRole.getAutoCompletionList();
413 if (list != null) {
414 list.clear();
415 re.getLayer().data.getAutoCompletionManager().populateWithMemberRoles(list, re.getRelation());
416 }
417 }
418 }
419 );
420 tfRole.setText(Main.pref.get("relation.editor.generic.lastrole", ""));
421 return tfRole;
422 }
423
424 /**
425 * builds the panel for the relation member editor
426 * @param memberTable member table
427 * @param memberTableModel member table model
428 * @param selectionTable selection table
429 * @param selectionTableModel selection table model
430 * @param re relation editor
431 * @param leftButtonToolbar left button toolbar
432 * @param tfRole role text field
433 *
434 * @return the panel for the relation member editor
435 */
436 protected static JPanel buildMemberEditorPanel(final MemberTable memberTable, MemberTableModel memberTableModel,
437 SelectionTable selectionTable, SelectionTableModel selectionTableModel, IRelationEditor re,
438 LeftButtonToolbar leftButtonToolbar, final AutoCompletingTextField tfRole) {
439 final JPanel pnl = new JPanel(new GridBagLayout());
440 final JScrollPane scrollPane = new JScrollPane(memberTable);
441
442 GridBagConstraints gc = new GridBagConstraints();
443 gc.gridx = 0;
444 gc.gridy = 0;
445 gc.gridwidth = 2;
446 gc.fill = GridBagConstraints.HORIZONTAL;
447 gc.anchor = GridBagConstraints.FIRST_LINE_START;
448 gc.weightx = 1.0;
449 gc.weighty = 0.0;
450 pnl.add(new JLabel(tr("Members")), gc);
451
452 gc.gridx = 0;
453 gc.gridy = 1;
454 gc.gridheight = 2;
455 gc.gridwidth = 1;
456 gc.fill = GridBagConstraints.VERTICAL;
457 gc.anchor = GridBagConstraints.NORTHWEST;
458 gc.weightx = 0.0;
459 gc.weighty = 1.0;
460 pnl.add(leftButtonToolbar, gc);
461
462 gc.gridx = 1;
463 gc.gridy = 1;
464 gc.gridheight = 1;
465 gc.fill = GridBagConstraints.BOTH;
466 gc.anchor = GridBagConstraints.CENTER;
467 gc.weightx = 0.6;
468 gc.weighty = 1.0;
469 pnl.add(scrollPane, gc);
470
471 // --- role editing
472 JPanel p3 = new JPanel(new FlowLayout(FlowLayout.LEFT));
473 p3.add(new JLabel(tr("Apply Role:")));
474 p3.add(tfRole);
475 SetRoleAction setRoleAction = new SetRoleAction(memberTable, memberTableModel, tfRole);
476 memberTableModel.getSelectionModel().addListSelectionListener(setRoleAction);
477 tfRole.getDocument().addDocumentListener(setRoleAction);
478 tfRole.addActionListener(setRoleAction);
479 memberTableModel.getSelectionModel().addListSelectionListener(
480 e -> tfRole.setEnabled(memberTable.getSelectedRowCount() > 0)
481 );
482 tfRole.setEnabled(memberTable.getSelectedRowCount() > 0);
483 JButton btnApply = new JButton(setRoleAction);
484 btnApply.setPreferredSize(new Dimension(20, 20));
485 btnApply.setText("");
486 p3.add(btnApply);
487
488 gc.gridx = 1;
489 gc.gridy = 2;
490 gc.fill = GridBagConstraints.HORIZONTAL;
491 gc.anchor = GridBagConstraints.LAST_LINE_START;
492 gc.weightx = 1.0;
493 gc.weighty = 0.0;
494 pnl.add(p3, gc);
495
496 JPanel pnl2 = new JPanel(new GridBagLayout());
497
498 gc.gridx = 0;
499 gc.gridy = 0;
500 gc.gridheight = 1;
501 gc.gridwidth = 3;
502 gc.fill = GridBagConstraints.HORIZONTAL;
503 gc.anchor = GridBagConstraints.FIRST_LINE_START;
504 gc.weightx = 1.0;
505 gc.weighty = 0.0;
506 pnl2.add(new JLabel(tr("Selection")), gc);
507
508 gc.gridx = 0;
509 gc.gridy = 1;
510 gc.gridheight = 1;
511 gc.gridwidth = 1;
512 gc.fill = GridBagConstraints.VERTICAL;
513 gc.anchor = GridBagConstraints.NORTHWEST;
514 gc.weightx = 0.0;
515 gc.weighty = 1.0;
516 pnl2.add(buildSelectionControlButtonToolbar(memberTable, memberTableModel, selectionTableModel, re), gc);
517
518 gc.gridx = 1;
519 gc.gridy = 1;
520 gc.weightx = 1.0;
521 gc.weighty = 1.0;
522 gc.fill = GridBagConstraints.BOTH;
523 pnl2.add(buildSelectionTablePanel(selectionTable), gc);
524
525 final JSplitPane splitPane = new JSplitPane(JSplitPane.HORIZONTAL_SPLIT);
526 splitPane.setLeftComponent(pnl);
527 splitPane.setRightComponent(pnl2);
528 splitPane.setOneTouchExpandable(false);
529 if (re instanceof Window) {
530 ((Window) re).addWindowListener(new WindowAdapter() {
531 @Override
532 public void windowOpened(WindowEvent e) {
533 // has to be called when the window is visible, otherwise no effect
534 splitPane.setDividerLocation(0.6);
535 }
536 });
537 }
538
539 JPanel pnl3 = new JPanel(new BorderLayout());
540 pnl3.add(splitPane, BorderLayout.CENTER);
541
542 return pnl3;
543 }
544
545 /**
546 * builds the panel with the table displaying the currently selected primitives
547 * @param selectionTable selection table
548 *
549 * @return panel with current selection
550 */
551 protected static JPanel buildSelectionTablePanel(SelectionTable selectionTable) {
552 JPanel pnl = new JPanel(new BorderLayout());
553 pnl.add(new JScrollPane(selectionTable), BorderLayout.CENTER);
554 return pnl;
555 }
556
557 /**
558 * builds the {@link JSplitPane} which divides the editor in an upper and a lower half
559 * @param top top panel
560 * @param bottom bottom panel
561 * @param re relation editor
562 *
563 * @return the split panel
564 */
565 protected static JSplitPane buildSplitPane(JPanel top, JPanel bottom, IRelationEditor re) {
566 final JSplitPane pane = new JSplitPane(JSplitPane.VERTICAL_SPLIT);
567 pane.setTopComponent(top);
568 pane.setBottomComponent(bottom);
569 pane.setOneTouchExpandable(true);
570 if (re instanceof Window) {
571 ((Window) re).addWindowListener(new WindowAdapter() {
572 @Override
573 public void windowOpened(WindowEvent e) {
574 // has to be called when the window is visible, otherwise no effect
575 pane.setDividerLocation(0.3);
576 }
577 });
578 }
579 return pane;
580 }
581
582 /**
583 * The toolbar with the buttons on the left
584 */
585 static class LeftButtonToolbar extends JToolBar {
586
587 /**
588 * Button for performing the {@link org.openstreetmap.josm.gui.dialogs.relation.actions.SortBelowAction}.
589 */
590 final JButton sortBelowButton;
591
592 /**
593 * Constructs a new {@code LeftButtonToolbar}.
594 * @param memberTable member table
595 * @param memberTableModel member table model
596 * @param re relation editor
597 */
598 LeftButtonToolbar(MemberTable memberTable, MemberTableModel memberTableModel, IRelationEditor re) {
599 setOrientation(JToolBar.VERTICAL);
600 setFloatable(false);
601
602 // -- move up action
603 MoveUpAction moveUpAction = new MoveUpAction(memberTable, memberTableModel, "moveUp");
604 memberTableModel.getSelectionModel().addListSelectionListener(moveUpAction);
605 add(moveUpAction);
606
607 // -- move down action
608 MoveDownAction moveDownAction = new MoveDownAction(memberTable, memberTableModel, "moveDown");
609 memberTableModel.getSelectionModel().addListSelectionListener(moveDownAction);
610 add(moveDownAction);
611
612 addSeparator();
613
614 // -- edit action
615 EditAction editAction = new EditAction(memberTable, memberTableModel, re.getLayer());
616 memberTableModel.getSelectionModel().addListSelectionListener(editAction);
617 add(editAction);
618
619 // -- delete action
620 RemoveAction removeSelectedAction = new RemoveAction(memberTable, memberTableModel, "removeSelected");
621 memberTable.getSelectionModel().addListSelectionListener(removeSelectedAction);
622 add(removeSelectedAction);
623
624 addSeparator();
625 // -- sort action
626 SortAction sortAction = new SortAction(memberTable, memberTableModel);
627 memberTableModel.addTableModelListener(sortAction);
628 add(sortAction);
629 final SortBelowAction sortBelowAction = new SortBelowAction(memberTable, memberTableModel);
630 memberTableModel.addTableModelListener(sortBelowAction);
631 memberTableModel.getSelectionModel().addListSelectionListener(sortBelowAction);
632 sortBelowButton = add(sortBelowAction);
633
634 // -- reverse action
635 ReverseAction reverseAction = new ReverseAction(memberTable, memberTableModel);
636 memberTableModel.addTableModelListener(reverseAction);
637 add(reverseAction);
638
639 addSeparator();
640
641 // -- download action
642 DownloadIncompleteMembersAction downloadIncompleteMembersAction = new DownloadIncompleteMembersAction(
643 memberTable, memberTableModel, "downloadIncomplete", re.getLayer(), re);
644 memberTable.getModel().addTableModelListener(downloadIncompleteMembersAction);
645 add(downloadIncompleteMembersAction);
646
647 // -- download selected action
648 DownloadSelectedIncompleteMembersAction downloadSelectedIncompleteMembersAction = new DownloadSelectedIncompleteMembersAction(
649 memberTable, memberTableModel, null, re.getLayer(), re);
650 memberTable.getModel().addTableModelListener(downloadSelectedIncompleteMembersAction);
651 memberTable.getSelectionModel().addListSelectionListener(downloadSelectedIncompleteMembersAction);
652 add(downloadSelectedIncompleteMembersAction);
653
654 InputMap inputMap = memberTable.getInputMap(MemberTable.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
655 inputMap.put((KeyStroke) removeSelectedAction.getValue(AbstractAction.ACCELERATOR_KEY), "removeSelected");
656 inputMap.put((KeyStroke) moveUpAction.getValue(AbstractAction.ACCELERATOR_KEY), "moveUp");
657 inputMap.put((KeyStroke) moveDownAction.getValue(AbstractAction.ACCELERATOR_KEY), "moveDown");
658 inputMap.put((KeyStroke) downloadIncompleteMembersAction.getValue(AbstractAction.ACCELERATOR_KEY), "downloadIncomplete");
659 }
660 }
661
662 /**
663 * build the toolbar with the buttons for adding or removing the current selection
664 * @param memberTable member table
665 * @param memberTableModel member table model
666 * @param selectionTableModel selection table model
667 * @param re relation editor
668 *
669 * @return control buttons panel for selection/members
670 */
671 protected static JToolBar buildSelectionControlButtonToolbar(MemberTable memberTable,
672 MemberTableModel memberTableModel, SelectionTableModel selectionTableModel, IRelationEditor re) {
673 JToolBar tb = new JToolBar(JToolBar.VERTICAL);
674 tb.setFloatable(false);
675
676 // -- add at start action
677 AddSelectedAtStartAction addSelectionAction = new AddSelectedAtStartAction(
678 memberTableModel, selectionTableModel, re);
679 selectionTableModel.addTableModelListener(addSelectionAction);
680 tb.add(addSelectionAction);
681
682 // -- add before selected action
683 AddSelectedBeforeSelection addSelectedBeforeSelectionAction = new AddSelectedBeforeSelection(
684 memberTableModel, selectionTableModel, re);
685 selectionTableModel.addTableModelListener(addSelectedBeforeSelectionAction);
686 memberTableModel.getSelectionModel().addListSelectionListener(addSelectedBeforeSelectionAction);
687 tb.add(addSelectedBeforeSelectionAction);
688
689 // -- add after selected action
690 AddSelectedAfterSelection addSelectedAfterSelectionAction = new AddSelectedAfterSelection(
691 memberTableModel, selectionTableModel, re);
692 selectionTableModel.addTableModelListener(addSelectedAfterSelectionAction);
693 memberTableModel.getSelectionModel().addListSelectionListener(addSelectedAfterSelectionAction);
694 tb.add(addSelectedAfterSelectionAction);
695
696 // -- add at end action
697 AddSelectedAtEndAction addSelectedAtEndAction = new AddSelectedAtEndAction(
698 memberTableModel, selectionTableModel, re);
699 selectionTableModel.addTableModelListener(addSelectedAtEndAction);
700 tb.add(addSelectedAtEndAction);
701
702 tb.addSeparator();
703
704 // -- select members action
705 SelectedMembersForSelectionAction selectMembersForSelectionAction = new SelectedMembersForSelectionAction(
706 memberTableModel, selectionTableModel, re.getLayer());
707 selectionTableModel.addTableModelListener(selectMembersForSelectionAction);
708 memberTableModel.addTableModelListener(selectMembersForSelectionAction);
709 tb.add(selectMembersForSelectionAction);
710
711 // -- select action
712 SelectPrimitivesForSelectedMembersAction selectAction = new SelectPrimitivesForSelectedMembersAction(
713 memberTable, memberTableModel, re.getLayer());
714 memberTable.getSelectionModel().addListSelectionListener(selectAction);
715 tb.add(selectAction);
716
717 tb.addSeparator();
718
719 // -- remove selected action
720 RemoveSelectedAction removeSelectedAction = new RemoveSelectedAction(memberTableModel, selectionTableModel, re.getLayer());
721 selectionTableModel.addTableModelListener(removeSelectedAction);
722 tb.add(removeSelectedAction);
723
724 return tb;
725 }
726
727 @Override
728 protected Dimension findMaxDialogSize() {
729 return new Dimension(700, 650);
730 }
731
732 @Override
733 public void setVisible(boolean visible) {
734 if (visible) {
735 tagEditorPanel.initAutoCompletion(getLayer());
736 }
737 super.setVisible(visible);
738 Clipboard clipboard = ClipboardUtils.getClipboard();
739 if (visible) {
740 leftButtonToolbar.sortBelowButton.setVisible(ExpertToggleAction.isExpert());
741 RelationDialogManager.getRelationDialogManager().positionOnScreen(this);
742 if (windowMenuItem == null) {
743 windowMenuItem = addToWindowMenu(this, getLayer().getName());
744 }
745 tagEditorPanel.requestFocusInWindow();
746 for (FlavorListener listener : clipboardListeners) {
747 clipboard.addFlavorListener(listener);
748 }
749 } else {
750 // make sure all registered listeners are unregistered
751 //
752 memberTable.stopHighlighting();
753 selectionTableModel.unregister();
754 memberTableModel.unregister();
755 memberTable.unregisterListeners();
756 if (windowMenuItem != null) {
757 Main.main.menu.windowMenu.remove(windowMenuItem);
758 windowMenuItem = null;
759 }
760 for (FlavorListener listener : clipboardListeners) {
761 clipboard.removeFlavorListener(listener);
762 }
763 dispose();
764 }
765 }
766
767 /**
768 * Adds current relation editor to the windows menu (in the "volatile" group)
769 * @param re relation editor
770 * @param layerName layer name
771 * @return created menu item
772 */
773 protected static JMenuItem addToWindowMenu(IRelationEditor re, String layerName) {
774 Relation r = re.getRelation();
775 String name = r == null ? tr("New Relation") : r.getLocalName();
776 JosmAction focusAction = new JosmAction(
777 tr("Relation Editor: {0}", name == null && r != null ? r.getId() : name),
778 "dialogs/relationlist",
779 tr("Focus Relation Editor with relation ''{0}'' in layer ''{1}''", name, layerName),
780 null, false, false) {
781 @Override
782 public void actionPerformed(ActionEvent e) {
783 ((RelationEditor) getValue("relationEditor")).setVisible(true);
784 }
785 };
786 focusAction.putValue("relationEditor", re);
787 return MainMenu.add(Main.main.menu.windowMenu, focusAction, MainMenu.WINDOW_MENU_GROUP.VOLATILE);
788 }
789
790 /**
791 * checks whether the current relation has members referring to itself. If so,
792 * warns the users and provides an option for removing these members.
793 * @param memberTableModel member table model
794 * @param relation relation
795 */
796 protected static void cleanSelfReferences(MemberTableModel memberTableModel, Relation relation) {
797 List<OsmPrimitive> toCheck = new ArrayList<>();
798 toCheck.add(relation);
799 if (memberTableModel.hasMembersReferringTo(toCheck)) {
800 int ret = ConditionalOptionPaneUtil.showOptionDialog(
801 "clean_relation_self_references",
802 Main.parent,
803 tr("<html>There is at least one member in this relation referring<br>"
804 + "to the relation itself.<br>"
805 + "This creates circular dependencies and is discouraged.<br>"
806 + "How do you want to proceed with circular dependencies?</html>"),
807 tr("Warning"),
808 JOptionPane.YES_NO_OPTION,
809 JOptionPane.WARNING_MESSAGE,
810 new String[]{tr("Remove them, clean up relation"), tr("Ignore them, leave relation as is")},
811 tr("Remove them, clean up relation")
812 );
813 switch(ret) {
814 case ConditionalOptionPaneUtil.DIALOG_DISABLED_OPTION:
815 case JOptionPane.CLOSED_OPTION:
816 case JOptionPane.NO_OPTION:
817 return;
818 case JOptionPane.YES_OPTION:
819 memberTableModel.removeMembersReferringTo(toCheck);
820 break;
821 default: // Do nothing
822 }
823 }
824 }
825
826 private void registerCopyPasteAction(AbstractAction action, Object actionName, KeyStroke shortcut,
827 JRootPane rootPane, JTable... tables) {
828 int mods = shortcut.getModifiers();
829 int code = shortcut.getKeyCode();
830 if (code != KeyEvent.VK_INSERT && (mods == 0 || mods == InputEvent.SHIFT_DOWN_MASK)) {
831 Main.info(tr("Sorry, shortcut \"{0}\" can not be enabled in Relation editor dialog"), shortcut);
832 return;
833 }
834 rootPane.getActionMap().put(actionName, action);
835 rootPane.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(shortcut, actionName);
836 // Assign also to JTables because they have their own Copy&Paste implementation
837 // (which is disabled in this case but eats key shortcuts anyway)
838 for (JTable table : tables) {
839 table.getInputMap(JComponent.WHEN_FOCUSED).put(shortcut, actionName);
840 table.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).put(shortcut, actionName);
841 table.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(shortcut, actionName);
842 }
843 if (action instanceof FlavorListener) {
844 clipboardListeners.add((FlavorListener) action);
845 }
846 }
847
848 /**
849 * Exception thrown when user aborts add operation.
850 */
851 public static class AddAbortException extends Exception {
852 }
853
854 /**
855 * Asks confirmationbefore adding a primitive.
856 * @param primitive primitive to add
857 * @return {@code true} is user confirms the operation, {@code false} otherwise
858 * @throws AddAbortException if user aborts operation
859 */
860 public static boolean confirmAddingPrimitive(OsmPrimitive primitive) throws AddAbortException {
861 String msg = tr("<html>This relation already has one or more members referring to<br>"
862 + "the object ''{0}''<br>"
863 + "<br>"
864 + "Do you really want to add another relation member?</html>",
865 primitive.getDisplayName(DefaultNameFormatter.getInstance())
866 );
867 int ret = ConditionalOptionPaneUtil.showOptionDialog(
868 "add_primitive_to_relation",
869 Main.parent,
870 msg,
871 tr("Multiple members referring to same object."),
872 JOptionPane.YES_NO_CANCEL_OPTION,
873 JOptionPane.WARNING_MESSAGE,
874 null,
875 null
876 );
877 switch(ret) {
878 case ConditionalOptionPaneUtil.DIALOG_DISABLED_OPTION:
879 case JOptionPane.YES_OPTION:
880 return true;
881 case JOptionPane.NO_OPTION:
882 case JOptionPane.CLOSED_OPTION:
883 return false;
884 case JOptionPane.CANCEL_OPTION:
885 default:
886 throw new AddAbortException();
887 }
888 }
889
890 /**
891 * Warn about circular references.
892 * @param primitive the concerned primitive
893 */
894 public static void warnOfCircularReferences(OsmPrimitive primitive) {
895 String msg = tr("<html>You are trying to add a relation to itself.<br>"
896 + "<br>"
897 + "This creates circular references and is therefore discouraged.<br>"
898 + "Skipping relation ''{0}''.</html>",
899 primitive.getDisplayName(DefaultNameFormatter.getInstance()));
900 JOptionPane.showMessageDialog(
901 Main.parent,
902 msg,
903 tr("Warning"),
904 JOptionPane.WARNING_MESSAGE);
905 }
906
907 /**
908 * Adds primitives to a given relation.
909 * @param orig The relation to modify
910 * @param primitivesToAdd The primitives to add as relation members
911 * @return The resulting command
912 * @throws IllegalArgumentException if orig is null
913 */
914 public static Command addPrimitivesToRelation(final Relation orig, Collection<? extends OsmPrimitive> primitivesToAdd) {
915 CheckParameterUtil.ensureParameterNotNull(orig, "orig");
916 try {
917 final Collection<TaggingPreset> presets = TaggingPresets.getMatchingPresets(
918 EnumSet.of(TaggingPresetType.forPrimitive(orig)), orig.getKeys(), false);
919 Relation relation = new Relation(orig);
920 boolean modified = false;
921 for (OsmPrimitive p : primitivesToAdd) {
922 if (p instanceof Relation && orig.equals(p)) {
923 if (!GraphicsEnvironment.isHeadless()) {
924 warnOfCircularReferences(p);
925 }
926 continue;
927 } else if (MemberTableModel.hasMembersReferringTo(relation.getMembers(), Collections.singleton(p))
928 && !confirmAddingPrimitive(p)) {
929 continue;
930 }
931 final Set<String> roles = findSuggestedRoles(presets, p);
932 relation.addMember(new RelationMember(roles.size() == 1 ? roles.iterator().next() : "", p));
933 modified = true;
934 }
935 return modified ? new ChangeCommand(orig, relation) : null;
936 } catch (AddAbortException ign) {
937 Main.trace(ign);
938 return null;
939 }
940 }
941
942 protected static Set<String> findSuggestedRoles(final Collection<TaggingPreset> presets, OsmPrimitive p) {
943 final Set<String> roles = new HashSet<>();
944 for (TaggingPreset preset : presets) {
945 String role = preset.suggestRoleForOsmPrimitive(p);
946 if (role != null && !role.isEmpty()) {
947 roles.add(role);
948 }
949 }
950 return roles;
951 }
952
953 class MemberTableDblClickAdapter extends MouseAdapter {
954 @Override
955 public void mouseClicked(MouseEvent e) {
956 if (e.getButton() == MouseEvent.BUTTON1 && e.getClickCount() == 2) {
957 new EditAction(memberTable, memberTableModel, getLayer()).actionPerformed(null);
958 }
959 }
960 }
961}
Note: See TracBrowser for help on using the repository browser.