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.GridBagLayout;
008import java.awt.event.ActionEvent;
009import java.awt.event.ActionListener;
010import java.awt.event.FocusAdapter;
011import java.awt.event.FocusEvent;
012import java.awt.event.KeyEvent;
013import java.awt.event.KeyListener;
014import java.util.Arrays;
015import java.util.Collections;
016import java.util.LinkedList;
017import java.util.List;
018import java.util.Observable;
019import java.util.Observer;
020
021import javax.swing.Action;
022import javax.swing.BorderFactory;
023import javax.swing.JEditorPane;
024import javax.swing.JPanel;
025import javax.swing.event.HyperlinkEvent;
026import javax.swing.event.HyperlinkListener;
027
028import org.openstreetmap.josm.Main;
029import org.openstreetmap.josm.data.osm.Changeset;
030import org.openstreetmap.josm.gui.widgets.HistoryComboBox;
031import org.openstreetmap.josm.gui.widgets.JMultilineLabel;
032import org.openstreetmap.josm.tools.CheckParameterUtil;
033import org.openstreetmap.josm.tools.GBC;
034import org.openstreetmap.josm.tools.Utils;
035
036/**
037 * BasicUploadSettingsPanel allows to enter the basic parameters required for uploading data.
038 * @since 2599
039 */
040public class BasicUploadSettingsPanel extends JPanel {
041    public static final String HISTORY_KEY = "upload.comment.history";
042    public static final String HISTORY_LAST_USED_KEY = "upload.comment.last-used";
043    public static final String HISTORY_MAX_AGE_KEY = "upload.comment.max-age";
044    public static final String SOURCE_HISTORY_KEY = "upload.source.history";
045
046    /** the history combo box for the upload comment */
047    private final HistoryComboBox hcbUploadComment = new HistoryComboBox();
048    private final HistoryComboBox hcbUploadSource = new HistoryComboBox();
049    /** the panel with a summary of the upload parameters */
050    private final UploadParameterSummaryPanel pnlUploadParameterSummary = new UploadParameterSummaryPanel();
051    /** the changeset comment model */
052    private final transient ChangesetCommentModel changesetCommentModel;
053    private final transient ChangesetCommentModel changesetSourceModel;
054
055    protected JPanel buildUploadCommentPanel() {
056        JPanel pnl = new JPanel(new GridBagLayout());
057
058        JEditorPane commentLabel = new JMultilineLabel("<html><b>" + tr("Provide a brief comment for the changes you are uploading:"));
059        pnl.add(commentLabel, GBC.eol().insets(0, 5, 10, 3).fill(GBC.HORIZONTAL));
060        hcbUploadComment.setToolTipText(tr("Enter an upload comment"));
061        hcbUploadComment.setMaxTextLength(Changeset.MAX_CHANGESET_TAG_LENGTH);
062        List<String> cmtHistory = new LinkedList<>(Main.pref.getCollection(HISTORY_KEY, new LinkedList<String>()));
063        Collections.reverse(cmtHistory); // we have to reverse the history, because ComboBoxHistory will reverse it again in addElement()
064        hcbUploadComment.setPossibleItems(cmtHistory);
065        CommentModelListener commentModelListener = new CommentModelListener(hcbUploadComment, changesetCommentModel);
066        hcbUploadComment.getEditor().addActionListener(commentModelListener);
067        hcbUploadComment.getEditor().getEditorComponent().addFocusListener(commentModelListener);
068        pnl.add(hcbUploadComment, GBC.eol().fill(GBC.HORIZONTAL));
069
070        JEditorPane sourceLabel = new JMultilineLabel("<html><b>" + tr("Specify the data source for the changes")
071                + "</b> (<a href=\"urn:changeset-source\">" + tr("obtain from current layers") + "</a>)<b>:</b>");
072        sourceLabel.addHyperlinkListener(new HyperlinkListener() {
073            @Override
074            public void hyperlinkUpdate(HyperlinkEvent e) {
075                if (HyperlinkEvent.EventType.ACTIVATED.equals(e.getEventType())) {
076                    final String source = Main.map.mapView.getLayerInformationForSourceTag();
077                    hcbUploadSource.setText(Utils.shortenString(source, Changeset.MAX_CHANGESET_TAG_LENGTH));
078                    // Fix #9965
079                    changesetSourceModel.setComment(hcbUploadSource.getText());
080                }
081            }
082        });
083        pnl.add(sourceLabel, GBC.eol().insets(0, 8, 10, 3).fill(GBC.HORIZONTAL));
084
085        hcbUploadSource.setToolTipText(tr("Enter a source"));
086        hcbUploadSource.setMaxTextLength(Changeset.MAX_CHANGESET_TAG_LENGTH);
087        List<String> sourceHistory = new LinkedList<>(Main.pref.getCollection(SOURCE_HISTORY_KEY, getDefaultSources()));
088        Collections.reverse(sourceHistory); // we have to reverse the history, because ComboBoxHistory will reverse it again in addElement()
089        hcbUploadSource.setPossibleItems(sourceHistory);
090        CommentModelListener sourceModelListener = new CommentModelListener(hcbUploadSource, changesetSourceModel);
091        hcbUploadSource.getEditor().addActionListener(sourceModelListener);
092        hcbUploadSource.getEditor().getEditorComponent().addFocusListener(sourceModelListener);
093        pnl.add(hcbUploadSource, GBC.eol().fill(GBC.HORIZONTAL));
094        return pnl;
095    }
096
097    public static List<String> getDefaultSources() {
098        return Arrays.asList("knowledge", "survey", "Bing");
099    }
100
101    protected void build() {
102        setLayout(new BorderLayout());
103        setBorder(BorderFactory.createEmptyBorder(3, 3, 3, 3));
104        add(buildUploadCommentPanel(), BorderLayout.NORTH);
105        add(pnlUploadParameterSummary, BorderLayout.CENTER);
106    }
107
108    /**
109     * Creates the panel
110     *
111     * @param changesetCommentModel the model for the changeset comment. Must not be null
112     * @param changesetSourceModel the model for the changeset source. Must not be null.
113     * @throws IllegalArgumentException if {@code changesetCommentModel} is null
114     */
115    public BasicUploadSettingsPanel(ChangesetCommentModel changesetCommentModel, ChangesetCommentModel changesetSourceModel) {
116        CheckParameterUtil.ensureParameterNotNull(changesetCommentModel, "changesetCommentModel");
117        CheckParameterUtil.ensureParameterNotNull(changesetSourceModel, "changesetSourceModel");
118        this.changesetCommentModel = changesetCommentModel;
119        this.changesetSourceModel = changesetSourceModel;
120        changesetCommentModel.addObserver(new ChangesetCommentObserver(hcbUploadComment));
121        changesetSourceModel.addObserver(new ChangesetCommentObserver(hcbUploadSource));
122        build();
123    }
124
125    public void setUploadTagDownFocusTraversalHandlers(final Action handler) {
126        setHistoryComboBoxDownFocusTraversalHandler(handler, hcbUploadComment);
127        setHistoryComboBoxDownFocusTraversalHandler(handler, hcbUploadSource);
128    }
129
130    public void setHistoryComboBoxDownFocusTraversalHandler(final Action handler, final HistoryComboBox hcb) {
131        hcb.getEditor().addActionListener(handler);
132        hcb.getEditor().getEditorComponent().addKeyListener(
133                new KeyListener() {
134                    @Override
135                    public void keyTyped(KeyEvent e) {
136                        if (e.getKeyCode() == KeyEvent.VK_TAB) {
137                            handler.actionPerformed(new ActionEvent(hcb, 0, "focusDown"));
138                        }
139                    }
140
141                    @Override
142                    public void keyReleased(KeyEvent e) {}
143
144                    @Override
145                    public void keyPressed(KeyEvent e) {}
146                }
147        );
148    }
149
150    /**
151     * Remembers the user input in the preference settings
152     */
153    public void rememberUserInput() {
154        // store the history of comments
155        hcbUploadComment.addCurrentItemToHistory();
156        Main.pref.putCollection(HISTORY_KEY, hcbUploadComment.getHistory());
157        Main.pref.putInteger(HISTORY_LAST_USED_KEY, (int) (System.currentTimeMillis() / 1000));
158        // store the history of sources
159        hcbUploadSource.addCurrentItemToHistory();
160        Main.pref.putCollection(SOURCE_HISTORY_KEY, hcbUploadSource.getHistory());
161    }
162
163    /**
164     * Initializes the panel for user input
165     */
166    public void startUserInput() {
167        hcbUploadComment.requestFocusInWindow();
168        hcbUploadComment.getEditor().getEditorComponent().requestFocusInWindow();
169    }
170
171    public void initEditingOfUploadComment() {
172        hcbUploadComment.getEditor().selectAll();
173        hcbUploadComment.requestFocusInWindow();
174    }
175
176    public UploadParameterSummaryPanel getUploadParameterSummaryPanel() {
177        return pnlUploadParameterSummary;
178    }
179
180    /**
181     * Updates the changeset comment model upon changes in the input field.
182     */
183    static class CommentModelListener extends FocusAdapter implements ActionListener {
184
185        private final HistoryComboBox source;
186        private final ChangesetCommentModel destination;
187
188        CommentModelListener(HistoryComboBox source, ChangesetCommentModel destination) {
189            this.source = source;
190            this.destination = destination;
191        }
192
193        @Override
194        public void actionPerformed(ActionEvent e) {
195            destination.setComment(source.getText());
196        }
197
198        @Override
199        public void focusLost(FocusEvent e) {
200            destination.setComment(source.getText());
201        }
202    }
203
204    /**
205     * Observes the changeset comment model and keeps the comment input field
206     * in sync with the current changeset comment
207     */
208    static class ChangesetCommentObserver implements Observer {
209
210        private final HistoryComboBox destination;
211
212        ChangesetCommentObserver(HistoryComboBox destination) {
213            this.destination = destination;
214        }
215
216        @Override
217        public void update(Observable o, Object arg) {
218            if (!(o instanceof ChangesetCommentModel)) return;
219            String newComment = (String) arg;
220            if (!destination.getText().equals(newComment)) {
221                destination.setText(newComment);
222            }
223        }
224    }
225}