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

Last change on this file since 12080 was 12080, checked in by michael2402, 7 years ago

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