001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.gui.io;
003
004import static org.openstreetmap.josm.tools.I18n.tr;
005
006import java.awt.BorderLayout;
007import java.awt.Dimension;
008import java.awt.FlowLayout;
009import java.awt.event.ActionEvent;
010import java.awt.event.WindowAdapter;
011import java.awt.event.WindowEvent;
012import java.util.ArrayList;
013import java.util.Collection;
014import java.util.Collections;
015import java.util.Comparator;
016import java.util.List;
017
018import javax.swing.AbstractAction;
019import javax.swing.AbstractListModel;
020import javax.swing.Action;
021import javax.swing.BorderFactory;
022import javax.swing.JComponent;
023import javax.swing.JDialog;
024import javax.swing.JLabel;
025import javax.swing.JList;
026import javax.swing.JOptionPane;
027import javax.swing.JPanel;
028import javax.swing.JScrollPane;
029import javax.swing.JSplitPane;
030import javax.swing.KeyStroke;
031import javax.swing.ListSelectionModel;
032import javax.swing.event.ListSelectionEvent;
033import javax.swing.event.ListSelectionListener;
034
035import org.openstreetmap.josm.Main;
036import org.openstreetmap.josm.data.osm.OsmPrimitive;
037import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
038import org.openstreetmap.josm.gui.DefaultNameFormatter;
039import org.openstreetmap.josm.gui.OsmPrimitivRenderer;
040import org.openstreetmap.josm.gui.SideButton;
041import org.openstreetmap.josm.gui.help.ContextSensitiveHelpAction;
042import org.openstreetmap.josm.gui.help.HelpUtil;
043import org.openstreetmap.josm.tools.ImageProvider;
044import org.openstreetmap.josm.tools.WindowGeometry;
045
046/**
047 * This dialog can be used to select individual object for uploading.
048 *
049 * @since 2250
050 */
051public class UploadSelectionDialog extends JDialog {
052
053    private OsmPrimitiveList lstSelectedPrimitives;
054    private OsmPrimitiveList lstDeletedPrimitives;
055    private JSplitPane spLists;
056    private boolean canceled;
057    private SideButton btnContinue;
058
059    /**
060     * Constructs a new {@code UploadSelectionDialog}.
061     */
062    public UploadSelectionDialog() {
063        super(JOptionPane.getFrameForComponent(Main.parent), ModalityType.DOCUMENT_MODAL);
064        build();
065    }
066
067    protected JPanel buildSelectedPrimitivesPanel() {
068        JPanel pnl = new JPanel(new BorderLayout());
069        JLabel lbl = new JLabel(
070                tr("<html>Mark modified objects <strong>from the current selection</strong> to be uploaded to the server.</html>"));
071        lbl.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
072        pnl.add(lbl, BorderLayout.NORTH);
073        pnl.add(new JScrollPane(lstSelectedPrimitives = new OsmPrimitiveList()), BorderLayout.CENTER);
074        lbl.setLabelFor(lstSelectedPrimitives);
075        return pnl;
076    }
077
078    protected JPanel buildDeletedPrimitivesPanel() {
079        JPanel pnl = new JPanel(new BorderLayout());
080        JLabel lbl = new JLabel(tr("<html>Mark <strong>locally deleted objects</strong> to be deleted on the server.</html>"));
081        lbl.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
082        pnl.add(lbl, BorderLayout.NORTH);
083        pnl.add(new JScrollPane(lstDeletedPrimitives = new OsmPrimitiveList()), BorderLayout.CENTER);
084        lbl.setLabelFor(lstDeletedPrimitives);
085        return pnl;
086    }
087
088    protected JPanel buildButtonPanel() {
089        JPanel pnl = new JPanel(new FlowLayout());
090        ContinueAction continueAction = new ContinueAction();
091        pnl.add(btnContinue = new SideButton(continueAction));
092        btnContinue.setFocusable(true);
093        lstDeletedPrimitives.getSelectionModel().addListSelectionListener(continueAction);
094        lstSelectedPrimitives.getSelectionModel().addListSelectionListener(continueAction);
095
096        pnl.add(new SideButton(new CancelAction()));
097        pnl.add(new SideButton(new ContextSensitiveHelpAction(HelpUtil.ht("/Dialog/UploadSelection"))));
098        return pnl;
099    }
100
101    protected void build() {
102        setLayout(new BorderLayout());
103        spLists = new JSplitPane(JSplitPane.VERTICAL_SPLIT);
104        spLists.setTopComponent(buildSelectedPrimitivesPanel());
105        spLists.setBottomComponent(buildDeletedPrimitivesPanel());
106        add(spLists, BorderLayout.CENTER);
107        add(buildButtonPanel(), BorderLayout.SOUTH);
108        addWindowListener(
109                new WindowAdapter() {
110                    @Override
111                    public void windowOpened(WindowEvent e) {
112                        spLists.setDividerLocation(0.5);
113                        btnContinue.requestFocusInWindow();
114                    }
115
116                    @Override
117                    public void windowClosing(WindowEvent e) {
118                        setCanceled(true);
119                    }
120                }
121        );
122        setTitle(tr("Select objects to upload"));
123        HelpUtil.setHelpContext(getRootPane(), HelpUtil.ht("/Dialog/UploadSelection"));
124    }
125
126    public void populate(Collection<OsmPrimitive> selected, Collection<OsmPrimitive> deleted) {
127        if (selected != null) {
128            lstSelectedPrimitives.getOsmPrimitiveListModel().setPrimitives(new ArrayList<>(selected));
129            if (!selected.isEmpty()) {
130                lstSelectedPrimitives.getSelectionModel().setSelectionInterval(0, selected.size()-1);
131            } else {
132                lstSelectedPrimitives.getSelectionModel().clearSelection();
133            }
134        } else {
135            lstSelectedPrimitives.getOsmPrimitiveListModel().setPrimitives(null);
136            lstSelectedPrimitives.getSelectionModel().clearSelection();
137        }
138
139        if (deleted != null) {
140            lstDeletedPrimitives.getOsmPrimitiveListModel().setPrimitives(new ArrayList<>(deleted));
141        } else {
142            lstDeletedPrimitives.getOsmPrimitiveListModel().setPrimitives(null);
143        }
144    }
145
146    public boolean isCanceled() {
147        return canceled;
148    }
149
150    protected void setCanceled(boolean canceled) {
151        this.canceled = canceled;
152    }
153
154    public List<OsmPrimitive> getSelectedPrimitives() {
155        List<OsmPrimitive> ret  = new ArrayList<>();
156        ret.addAll(lstSelectedPrimitives.getOsmPrimitiveListModel().getPrimitives(lstSelectedPrimitives.getSelectedIndices()));
157        ret.addAll(lstDeletedPrimitives.getOsmPrimitiveListModel().getPrimitives(lstDeletedPrimitives.getSelectedIndices()));
158        return ret;
159    }
160
161    @Override
162    public void setVisible(boolean visible) {
163        if (visible) {
164            new WindowGeometry(
165                    getClass().getName() + ".geometry",
166                    WindowGeometry.centerInWindow(
167                            Main.parent,
168                            new Dimension(200, 400)
169                    )
170            ).applySafe(this);
171        } else if (isShowing()) { // Avoid IllegalComponentStateException like in #8775
172            new WindowGeometry(this).remember(getClass().getName() + ".geometry");
173        }
174        super.setVisible(visible);
175    }
176
177    static class OsmPrimitiveList extends JList<OsmPrimitive> {
178        protected void init() {
179            setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
180            setCellRenderer(new OsmPrimitivRenderer());
181        }
182
183        OsmPrimitiveList() {
184            this(new OsmPrimitiveListModel());
185        }
186
187        OsmPrimitiveList(OsmPrimitiveListModel model) {
188            super(model);
189            init();
190        }
191
192        public OsmPrimitiveListModel getOsmPrimitiveListModel() {
193            return (OsmPrimitiveListModel) getModel();
194        }
195    }
196
197    static class OsmPrimitiveListModel extends AbstractListModel<OsmPrimitive> {
198        private transient List<OsmPrimitive> data;
199
200        protected void sort() {
201            if (data == null)
202                return;
203            Collections.sort(
204                    data,
205                    new Comparator<OsmPrimitive>() {
206                        private DefaultNameFormatter formatter = DefaultNameFormatter.getInstance();
207                        @Override
208                        public int compare(OsmPrimitive o1, OsmPrimitive o2) {
209                            int ret = OsmPrimitiveType.from(o1).compareTo(OsmPrimitiveType.from(o2));
210                            if (ret != 0) return ret;
211                            return o1.getDisplayName(formatter).compareTo(o1.getDisplayName(formatter));
212                        }
213                    }
214            );
215        }
216
217        public void setPrimitives(List<OsmPrimitive> data) {
218            this.data = data;
219            sort();
220            if (data != null) {
221                fireContentsChanged(this, 0, data.size());
222            } else {
223                fireContentsChanged(this, 0, 0);
224            }
225        }
226
227        @Override
228        public OsmPrimitive getElementAt(int index) {
229            if (data == null)
230                return null;
231            return data.get(index);
232        }
233
234        @Override
235        public int getSize() {
236            if (data == null)
237                return 0;
238            return data.size();
239        }
240
241        public List<OsmPrimitive> getPrimitives(int[] indices) {
242            if (indices == null || indices.length == 0)
243                return Collections.emptyList();
244            List<OsmPrimitive> ret = new ArrayList<>(indices.length);
245            for (int i: indices) {
246                if (i < 0) {
247                    continue;
248                }
249                ret.add(data.get(i));
250            }
251            return ret;
252        }
253    }
254
255    class CancelAction extends AbstractAction {
256        CancelAction() {
257            putValue(Action.SHORT_DESCRIPTION, tr("Cancel uploading"));
258            putValue(Action.NAME, tr("Cancel"));
259            putValue(Action.SMALL_ICON, ImageProvider.get("", "cancel"));
260            getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW)
261            .put(KeyStroke.getKeyStroke("ESCAPE"), "ESCAPE");
262            getRootPane().getActionMap().put("ESCAPE", this);
263            setEnabled(true);
264        }
265
266        @Override
267        public void actionPerformed(ActionEvent e) {
268            setCanceled(true);
269            setVisible(false);
270        }
271    }
272
273    class ContinueAction extends AbstractAction implements ListSelectionListener {
274        ContinueAction() {
275            putValue(Action.SHORT_DESCRIPTION, tr("Continue uploading"));
276            putValue(Action.NAME, tr("Continue"));
277            putValue(Action.SMALL_ICON, ImageProvider.get("", "upload"));
278            updateEnabledState();
279        }
280
281        @Override
282        public void actionPerformed(ActionEvent e) {
283            setCanceled(false);
284            setVisible(false);
285        }
286
287        protected void updateEnabledState() {
288            setEnabled(lstSelectedPrimitives.getSelectedIndex() >= 0
289                    || lstDeletedPrimitives.getSelectedIndex() >= 0);
290        }
291
292        @Override
293        public void valueChanged(ListSelectionEvent e) {
294            updateEnabledState();
295        }
296    }
297}