001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.gui.history;
003
004import static org.openstreetmap.josm.tools.I18n.tr;
005
006import java.awt.Component;
007import java.awt.Dimension;
008import java.awt.Point;
009import java.awt.Rectangle;
010import java.awt.event.ActionEvent;
011import java.awt.event.ItemEvent;
012import java.awt.event.ItemListener;
013import java.awt.event.KeyAdapter;
014import java.awt.event.KeyEvent;
015import java.awt.event.MouseEvent;
016import java.util.Observable;
017import java.util.Observer;
018
019import javax.swing.DefaultCellEditor;
020import javax.swing.JCheckBox;
021import javax.swing.JLabel;
022import javax.swing.JPopupMenu;
023import javax.swing.JRadioButton;
024import javax.swing.JTable;
025import javax.swing.SwingConstants;
026import javax.swing.UIManager;
027import javax.swing.event.TableModelEvent;
028import javax.swing.event.TableModelListener;
029import javax.swing.table.TableCellRenderer;
030
031import org.openstreetmap.josm.Main;
032import org.openstreetmap.josm.actions.AbstractInfoAction;
033import org.openstreetmap.josm.data.osm.User;
034import org.openstreetmap.josm.data.osm.history.History;
035import org.openstreetmap.josm.data.osm.history.HistoryOsmPrimitive;
036import org.openstreetmap.josm.gui.widgets.PopupMenuLauncher;
037import org.openstreetmap.josm.io.XmlWriter;
038import org.openstreetmap.josm.tools.ImageProvider;
039import org.openstreetmap.josm.tools.OpenBrowser;
040
041/**
042 * VersionTable shows a list of version in a {@link org.openstreetmap.josm.data.osm.history.History}
043 * of an {@link org.openstreetmap.josm.data.osm.OsmPrimitive}.
044 * @since 1709
045 */
046public class VersionTable extends JTable implements Observer{
047    private VersionTablePopupMenu popupMenu;
048    private final HistoryBrowserModel model;
049
050    protected void build() {
051        getTableHeader().setFont(getTableHeader().getFont().deriveFont(9f));
052        setRowSelectionAllowed(false);
053        setShowGrid(false);
054        setAutoResizeMode(JTable.AUTO_RESIZE_OFF);
055        setBackground(UIManager.getColor("Button.background"));
056        setIntercellSpacing(new Dimension(6, 0));
057        putClientProperty("terminateEditOnFocusLost", true);
058        popupMenu = new VersionTablePopupMenu();
059        addMouseListener(new MouseListener());
060        addKeyListener(new KeyAdapter() {
061            @Override
062            public void keyReleased(KeyEvent e) {
063                // navigate history down/up using the corresponding arrow keys.
064                long ref = model.getReferencePointInTime().getVersion();
065                long cur = model.getCurrentPointInTime().getVersion();
066                if (e.getKeyCode() == KeyEvent.VK_DOWN) {
067                    History refNext = model.getHistory().from(ref);
068                    History curNext = model.getHistory().from(cur);
069                    if (refNext.getNumVersions() > 1 && curNext.getNumVersions() > 1) {
070                        model.setReferencePointInTime(refNext.sortAscending().get(1));
071                        model.setCurrentPointInTime(curNext.sortAscending().get(1));
072                    }
073                } else if (e.getKeyCode() == KeyEvent.VK_UP) {
074                    History refNext = model.getHistory().until(ref);
075                    History curNext = model.getHistory().until(cur);
076                    if (refNext.getNumVersions() > 1 && curNext.getNumVersions() > 1) {
077                        model.setReferencePointInTime(refNext.sortDescending().get(1));
078                        model.setCurrentPointInTime(curNext.sortDescending().get(1));
079                    }
080                }
081            }
082        });
083        getModel().addTableModelListener(new TableModelListener() {
084            @Override
085            public void tableChanged(TableModelEvent e) {
086                adjustColumnWidth(VersionTable.this, 0, 0);
087                adjustColumnWidth(VersionTable.this, 1, -8);
088                adjustColumnWidth(VersionTable.this, 2, -8);
089                adjustColumnWidth(VersionTable.this, 3, 0);
090                adjustColumnWidth(VersionTable.this, 4, 0);
091            }
092        });
093    }
094
095    /**
096     * Constructs a new {@code VersionTable}.
097     * @param model model used by the history browser
098     */
099    public VersionTable(HistoryBrowserModel model) {
100        super(model.getVersionTableModel(), new VersionTableColumnModel());
101        model.addObserver(this);
102        build();
103        this.model = model;
104    }
105
106    // some kind of hack to prevent the table from scrolling to the
107    // right when clicking on the cells
108    @Override
109    public void scrollRectToVisible(Rectangle aRect) {
110        super.scrollRectToVisible(new Rectangle(0, aRect.y, aRect.width, aRect.height));
111    }
112
113    protected HistoryBrowserModel.VersionTableModel getVersionTableModel() {
114        return (HistoryBrowserModel.VersionTableModel) getModel();
115    }
116
117    @Override
118    public void update(Observable o, Object arg) {
119        repaint();
120    }
121
122    class MouseListener extends PopupMenuLauncher {
123        private MouseListener() {
124            super(popupMenu);
125        }
126        @Override
127        public void mousePressed(MouseEvent e) {
128            super.mousePressed(e);
129            if (!e.isPopupTrigger() && e.getButton() == MouseEvent.BUTTON1) {
130                int row = rowAtPoint(e.getPoint());
131                int col = columnAtPoint(e.getPoint());
132                if (row >= 0 && (col == VersionTableColumnModel.COL_DATE || col == VersionTableColumnModel.COL_USER)) {
133                    model.getVersionTableModel().setCurrentPointInTime(row);
134                    model.getVersionTableModel().setReferencePointInTime(Math.max(0, row - 1));
135                }
136            }
137        }
138        @Override
139        protected int checkTableSelection(JTable table, Point p) {
140            HistoryBrowserModel.VersionTableModel model = getVersionTableModel();
141            int row = rowAtPoint(p);
142            if (row > -1 && !model.isLatest(row)) {
143                popupMenu.prepare(model.getPrimitive(row));
144            }
145            return row;
146        }
147    }
148
149    static class ChangesetInfoAction extends AbstractInfoAction {
150        private HistoryOsmPrimitive primitive;
151
152        public ChangesetInfoAction() {
153            super(true);
154            putValue(NAME, tr("Changeset info"));
155            putValue(SHORT_DESCRIPTION, tr("Launch browser with information about the changeset"));
156            putValue(SMALL_ICON, ImageProvider.get("data/changeset"));
157        }
158
159        @Override
160        protected String createInfoUrl(Object infoObject) {
161            HistoryOsmPrimitive primitive = (HistoryOsmPrimitive) infoObject;
162            return Main.getBaseBrowseUrl() + "/changeset/" + primitive.getChangesetId();
163        }
164
165        @Override
166        public void actionPerformed(ActionEvent e) {
167            if (!isEnabled())
168                return;
169            String url = createInfoUrl(primitive);
170            OpenBrowser.displayUrl(url);
171        }
172
173        public void prepare(HistoryOsmPrimitive primitive) {
174            putValue(NAME, tr("Show changeset {0}", primitive.getChangesetId()));
175            this.primitive = primitive;
176        }
177    }
178
179    static class UserInfoAction extends AbstractInfoAction {
180        private HistoryOsmPrimitive primitive;
181
182        public UserInfoAction() {
183            super(true);
184            putValue(NAME, tr("User info"));
185            putValue(SHORT_DESCRIPTION, tr("Launch browser with information about the user"));
186            putValue(SMALL_ICON, ImageProvider.get("data/user"));
187        }
188
189        @Override
190        protected String createInfoUrl(Object infoObject) {
191            HistoryOsmPrimitive hp = (HistoryOsmPrimitive) infoObject;
192            return hp.getUser() == null ? null : Main.getBaseUserUrl() + "/" + hp.getUser().getName();
193        }
194
195        @Override
196        public void actionPerformed(ActionEvent e) {
197            if (!isEnabled())
198                return;
199            String url = createInfoUrl(primitive);
200            OpenBrowser.displayUrl(url);
201        }
202
203        public void prepare(HistoryOsmPrimitive primitive) {
204            final User user = primitive.getUser();
205            putValue(NAME, "<html>" + tr("Show user {0}", user == null ? "?" :
206                    XmlWriter.encode(user.getName(), true) + " <font color=gray>(" + user.getId() + ")</font>") + "</html>");
207            this.primitive = primitive;
208        }
209    }
210
211    static class VersionTablePopupMenu extends JPopupMenu {
212
213        private ChangesetInfoAction changesetInfoAction;
214        private UserInfoAction userInfoAction;
215
216        protected void build() {
217            changesetInfoAction = new ChangesetInfoAction();
218            add(changesetInfoAction);
219            userInfoAction = new UserInfoAction();
220            add(userInfoAction);
221        }
222        public VersionTablePopupMenu() {
223            super();
224            build();
225        }
226
227        public void prepare(HistoryOsmPrimitive primitive) {
228            changesetInfoAction.prepare(primitive);
229            userInfoAction.prepare(primitive);
230            invalidate();
231        }
232    }
233
234    public static class RadioButtonRenderer extends JRadioButton implements TableCellRenderer {
235
236        @Override
237        public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus,
238                int row, int column) {
239            setSelected(value != null && (Boolean)value);
240            setHorizontalAlignment(SwingConstants.CENTER);
241            return this;
242        }
243    }
244
245    public static class RadioButtonEditor extends DefaultCellEditor implements ItemListener {
246
247        private JRadioButton btn;
248
249        /**
250         * Constructs a new {@code RadioButtonEditor}.
251         */
252        public RadioButtonEditor() {
253            super(new JCheckBox());
254            btn = new JRadioButton();
255            btn.setHorizontalAlignment(SwingConstants.CENTER);
256        }
257
258        @Override
259        public Component getTableCellEditorComponent(JTable table, Object value, boolean isSelected, int row, int column) {
260            if (value == null) return null;
261            boolean val = (Boolean) value;
262            btn.setSelected(val);
263            btn.addItemListener(this);
264            return btn;
265        }
266
267        @Override
268        public Object getCellEditorValue() {
269            btn.removeItemListener(this);
270            return btn.isSelected();
271        }
272
273        @Override
274        public void itemStateChanged(ItemEvent e) {
275            fireEditingStopped();
276        }
277    }
278
279    public static class AlignedRenderer extends JLabel implements TableCellRenderer {
280
281        /**
282         * Constructs a new {@code AlignedRenderer}.
283         * @param hAlignment Horizontal alignement. One of the following constants defined in SwingConstants:
284         *        LEFT, CENTER (the default for image-only labels), RIGHT, LEADING (the default for text-only labels) or TRAILING
285         */
286        public AlignedRenderer(int hAlignment) {
287            setHorizontalAlignment(hAlignment);
288        }
289
290        @Override
291        public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus,
292                int row, int column) {
293            String v = value.toString();
294            setText(v);
295            return this;
296        }
297    }
298
299    private static void adjustColumnWidth(JTable tbl, int col, int cellInset) {
300        int maxwidth = 0;
301
302        for (int row=0; row<tbl.getRowCount(); row++) {
303            TableCellRenderer tcr = tbl.getCellRenderer(row, col);
304            Object val = tbl.getValueAt(row, col);
305            Component comp = tcr.getTableCellRendererComponent(tbl, val, false, false, row, col);
306            maxwidth = Math.max(comp.getPreferredSize().width + cellInset, maxwidth);
307        }
308        TableCellRenderer tcr = tbl.getTableHeader().getDefaultRenderer();
309        Object val = tbl.getColumnModel().getColumn(col).getHeaderValue();
310        Component comp = tcr.getTableCellRendererComponent(tbl, val, false, false, -1, col);
311        maxwidth = Math.max(comp.getPreferredSize().width + Main.pref.getInteger("table.header-inset", 0), maxwidth);
312
313        int spacing = tbl.getIntercellSpacing().width;
314        tbl.getColumnModel().getColumn(col).setPreferredWidth(maxwidth + spacing);
315    }
316}