[2512] | 1 | // License: GPL. For details, see LICENSE file.
|
---|
| 2 | package org.openstreetmap.josm.gui.history;
|
---|
| 3 |
|
---|
| 4 | import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
|
---|
| 5 | import static org.openstreetmap.josm.tools.I18n.marktr;
|
---|
| 6 | import static org.openstreetmap.josm.tools.I18n.tr;
|
---|
| 7 |
|
---|
| 8 | import java.awt.BorderLayout;
|
---|
| 9 | import java.awt.FlowLayout;
|
---|
| 10 | import java.awt.event.ActionEvent;
|
---|
[4297] | 11 | import java.awt.event.KeyEvent;
|
---|
[2512] | 12 | import java.awt.event.WindowAdapter;
|
---|
| 13 | import java.awt.event.WindowEvent;
|
---|
| 14 |
|
---|
| 15 | import javax.swing.AbstractAction;
|
---|
[4297] | 16 | import javax.swing.JComponent;
|
---|
[2512] | 17 | import javax.swing.JDialog;
|
---|
[7528] | 18 | import javax.swing.JLabel;
|
---|
[2512] | 19 | import javax.swing.JOptionPane;
|
---|
| 20 | import javax.swing.JPanel;
|
---|
[4297] | 21 | import javax.swing.KeyStroke;
|
---|
[2512] | 22 |
|
---|
| 23 | import org.openstreetmap.josm.Main;
|
---|
| 24 | import org.openstreetmap.josm.data.osm.PrimitiveId;
|
---|
| 25 | import org.openstreetmap.josm.data.osm.history.History;
|
---|
| 26 | import org.openstreetmap.josm.data.osm.history.HistoryDataSet;
|
---|
| 27 | import org.openstreetmap.josm.data.osm.history.HistoryDataSetListener;
|
---|
| 28 | import org.openstreetmap.josm.gui.SideButton;
|
---|
| 29 | import org.openstreetmap.josm.gui.help.ContextSensitiveHelpAction;
|
---|
| 30 | import org.openstreetmap.josm.gui.help.HelpUtil;
|
---|
| 31 | import org.openstreetmap.josm.tools.ImageProvider;
|
---|
| 32 |
|
---|
| 33 | /**
|
---|
| 34 | * This is non-modal dialog, always showing on top, which displays history information
|
---|
[5832] | 35 | * about a given {@link org.openstreetmap.josm.data.osm.OsmPrimitive}.
|
---|
[2512] | 36 | *
|
---|
| 37 | */
|
---|
| 38 | public class HistoryBrowserDialog extends JDialog implements HistoryDataSetListener{
|
---|
| 39 |
|
---|
| 40 | /** the embedded browser */
|
---|
| 41 | private HistoryBrowser browser;
|
---|
| 42 | private CloseAction closeAction;
|
---|
[7528] | 43 | private JLabel titleLabel;
|
---|
[2512] | 44 |
|
---|
| 45 | /**
|
---|
| 46 | * displays the title for this dialog
|
---|
| 47 | *
|
---|
| 48 | * @param h the current history
|
---|
| 49 | */
|
---|
| 50 | protected void renderTitle(History h) {
|
---|
| 51 | String title = "";
|
---|
| 52 | switch(h.getEarliest().getType()) {
|
---|
| 53 | case NODE: title = marktr("History for node {0}"); break;
|
---|
| 54 | case WAY: title = marktr("History for way {0}"); break;
|
---|
| 55 | case RELATION: title = marktr("History for relation {0}"); break;
|
---|
| 56 | }
|
---|
| 57 | setTitle(tr(
|
---|
| 58 | title,
|
---|
| 59 | Long.toString(h.getId())
|
---|
| 60 | ));
|
---|
| 61 | }
|
---|
| 62 |
|
---|
[7528] | 63 | @Override
|
---|
| 64 | public void setTitle(String title) {
|
---|
| 65 | super.setTitle(title);
|
---|
| 66 | if (titleLabel != null) {
|
---|
| 67 | titleLabel.setText(title);
|
---|
| 68 | }
|
---|
| 69 | }
|
---|
| 70 |
|
---|
[2512] | 71 | /**
|
---|
| 72 | * builds the GUI
|
---|
| 73 | */
|
---|
| 74 | protected void build() {
|
---|
| 75 | setLayout(new BorderLayout());
|
---|
[7528] | 76 |
|
---|
| 77 | titleLabel = new JLabel();
|
---|
| 78 | titleLabel.setHorizontalAlignment(JLabel.CENTER);
|
---|
| 79 | add(titleLabel, BorderLayout.NORTH);
|
---|
| 80 |
|
---|
[2512] | 81 | browser = new HistoryBrowser();
|
---|
| 82 | add(browser, BorderLayout.CENTER);
|
---|
| 83 |
|
---|
| 84 | JPanel pnl = new JPanel();
|
---|
| 85 | pnl.setLayout(new FlowLayout(FlowLayout.CENTER));
|
---|
| 86 |
|
---|
| 87 | SideButton btn = new SideButton(new ReloadAction());
|
---|
| 88 | btn.setName("btn.reload");
|
---|
| 89 | pnl.add(btn);
|
---|
| 90 |
|
---|
| 91 | btn = new SideButton(closeAction = new CloseAction());
|
---|
[4297] | 92 | final String closeHistoryBrowserDialogKey = "CloseHistoryBrowserDialog";
|
---|
| 93 | KeyStroke escapeKey = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0, false);
|
---|
| 94 | getRootPane().getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).put(escapeKey, closeHistoryBrowserDialogKey);
|
---|
| 95 | getRootPane().getActionMap().put(closeHistoryBrowserDialogKey, closeAction);
|
---|
[2512] | 96 | btn.setName("btn.close");
|
---|
| 97 | pnl.add(btn);
|
---|
| 98 |
|
---|
[3768] | 99 | btn = new SideButton(new ContextSensitiveHelpAction(ht("/Dialog/HistoryBrowser")));
|
---|
[2512] | 100 | btn.setName("btn.help");
|
---|
| 101 | pnl.add(btn);
|
---|
| 102 | add(pnl, BorderLayout.SOUTH);
|
---|
| 103 |
|
---|
[3768] | 104 | HelpUtil.setHelpContext(getRootPane(), ht("/Dialog/HistoryBrowser"));
|
---|
[2512] | 105 | }
|
---|
| 106 |
|
---|
| 107 | /**
|
---|
[7528] | 108 | * Constructs a new {@code HistoryBrowserDialog}.
|
---|
[2512] | 109 | *
|
---|
[7528] | 110 | * @param history the history to be displayed
|
---|
[2512] | 111 | */
|
---|
| 112 | public HistoryBrowserDialog(History history) {
|
---|
| 113 | super(JOptionPane.getFrameForComponent(Main.parent), false);
|
---|
| 114 | build();
|
---|
| 115 | setHistory(history);
|
---|
| 116 | renderTitle(history);
|
---|
[7528] | 117 | pack();
|
---|
| 118 | if (getInsets().top > 0) {
|
---|
| 119 | titleLabel.setVisible(false);
|
---|
| 120 | }
|
---|
[2512] | 121 | HistoryDataSet.getInstance().addHistoryDataSetListener(this);
|
---|
| 122 | addWindowListener(new WindowClosingAdapter());
|
---|
| 123 | }
|
---|
| 124 |
|
---|
| 125 | /**
|
---|
[7528] | 126 | * Sets the current history.
|
---|
[2512] | 127 | * @param history
|
---|
| 128 | */
|
---|
| 129 | protected void setHistory(History history) {
|
---|
| 130 | browser.populate(history);
|
---|
| 131 | }
|
---|
| 132 |
|
---|
[7528] | 133 | /**
|
---|
| 134 | * Removes this history browser model as listener for data change and layer change events.
|
---|
| 135 | */
|
---|
[2961] | 136 | public void unlinkAsListener() {
|
---|
| 137 | getHistoryBrowser().getModel().unlinkAsListener();
|
---|
| 138 | }
|
---|
| 139 |
|
---|
| 140 | /* ---------------------------------------------------------------------------------- */
|
---|
| 141 | /* interface HistoryDataSetListener */
|
---|
| 142 | /* ---------------------------------------------------------------------------------- */
|
---|
[6084] | 143 | @Override
|
---|
[2512] | 144 | public void historyUpdated(HistoryDataSet source, PrimitiveId primitiveId) {
|
---|
[5171] | 145 | if (primitiveId == null || primitiveId.equals(browser.getHistory().getPrimitiveId())) {
|
---|
| 146 | browser.populate(source.getHistory(browser.getHistory().getPrimitiveId()));
|
---|
[2512] | 147 | }
|
---|
| 148 | }
|
---|
| 149 |
|
---|
[6084] | 150 | @Override
|
---|
[2961] | 151 | public void historyDataSetCleared(HistoryDataSet source) {
|
---|
| 152 | closeAction.run();
|
---|
[2512] | 153 | }
|
---|
| 154 |
|
---|
[2961] | 155 |
|
---|
[2512] | 156 | class CloseAction extends AbstractAction {
|
---|
| 157 | public CloseAction() {
|
---|
| 158 | putValue(NAME, tr("Close"));
|
---|
| 159 | putValue(SHORT_DESCRIPTION, tr("Close the dialog"));
|
---|
| 160 | putValue(SMALL_ICON, ImageProvider.get("ok"));
|
---|
| 161 | }
|
---|
| 162 |
|
---|
| 163 | public void run() {
|
---|
| 164 | getHistoryBrowser().getModel().unlinkAsListener();
|
---|
| 165 | HistoryDataSet.getInstance().removeHistoryDataSetListener(HistoryBrowserDialog.this);
|
---|
| 166 | HistoryBrowserDialogManager.getInstance().hide(HistoryBrowserDialog.this);
|
---|
| 167 | }
|
---|
| 168 |
|
---|
[6084] | 169 | @Override
|
---|
[2512] | 170 | public void actionPerformed(ActionEvent e) {
|
---|
| 171 | run();
|
---|
| 172 | }
|
---|
| 173 | }
|
---|
| 174 |
|
---|
| 175 | class ReloadAction extends AbstractAction {
|
---|
| 176 | public ReloadAction() {
|
---|
| 177 | putValue(NAME, tr("Reload"));
|
---|
| 178 | putValue(SHORT_DESCRIPTION, tr("Reload the history from the server"));
|
---|
| 179 | putValue(SMALL_ICON, ImageProvider.get("dialogs", "refresh"));
|
---|
| 180 | }
|
---|
| 181 |
|
---|
[6084] | 182 | @Override
|
---|
[2512] | 183 | public void actionPerformed(ActionEvent e) {
|
---|
| 184 | HistoryLoadTask task = new HistoryLoadTask();
|
---|
| 185 | task.add(browser.getHistory());
|
---|
| 186 | Main.worker.submit(task);
|
---|
| 187 | }
|
---|
| 188 | }
|
---|
| 189 |
|
---|
| 190 | class WindowClosingAdapter extends WindowAdapter {
|
---|
| 191 | @Override
|
---|
| 192 | public void windowClosing(WindowEvent e) {
|
---|
| 193 | closeAction.run();
|
---|
| 194 | }
|
---|
| 195 | }
|
---|
| 196 |
|
---|
[7528] | 197 | /**
|
---|
| 198 | * Replies the history browser.
|
---|
| 199 | * @return the history browser
|
---|
| 200 | */
|
---|
[2512] | 201 | public HistoryBrowser getHistoryBrowser() {
|
---|
| 202 | return browser;
|
---|
| 203 | }
|
---|
| 204 | }
|
---|