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

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

copy/paste error in comment

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