source: josm/trunk/src/org/openstreetmap/josm/gui/history/VersionTable.java@ 14675

Last change on this file since 14675 was 14545, checked in by GerdP, 5 years ago

see #17040 - destroy ChangesetInfoAction and UserInfoAction
  • Property svn:eol-style set to native
File size: 13.0 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.history;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.Component;
7import java.awt.Dimension;
8import java.awt.Point;
9import java.awt.Rectangle;
10import java.awt.event.ActionEvent;
11import java.awt.event.ItemEvent;
12import java.awt.event.ItemListener;
13import java.awt.event.KeyAdapter;
14import java.awt.event.KeyEvent;
15import java.awt.event.MouseEvent;
16
17import javax.swing.DefaultCellEditor;
18import javax.swing.JCheckBox;
19import javax.swing.JLabel;
20import javax.swing.JPopupMenu;
21import javax.swing.JRadioButton;
22import javax.swing.JTable;
23import javax.swing.SwingConstants;
24import javax.swing.UIManager;
25import javax.swing.event.ChangeEvent;
26import javax.swing.event.ChangeListener;
27import javax.swing.table.TableCellRenderer;
28
29import org.openstreetmap.josm.actions.AbstractInfoAction;
30import org.openstreetmap.josm.data.osm.User;
31import org.openstreetmap.josm.data.osm.history.History;
32import org.openstreetmap.josm.data.osm.history.HistoryOsmPrimitive;
33import org.openstreetmap.josm.gui.util.GuiHelper;
34import org.openstreetmap.josm.gui.widgets.PopupMenuLauncher;
35import org.openstreetmap.josm.io.XmlWriter;
36import org.openstreetmap.josm.spi.preferences.Config;
37import org.openstreetmap.josm.tools.Destroyable;
38import org.openstreetmap.josm.tools.ImageProvider;
39import org.openstreetmap.josm.tools.OpenBrowser;
40
41/**
42 * VersionTable shows a list of version in a {@link org.openstreetmap.josm.data.osm.history.History}
43 * of an {@link org.openstreetmap.josm.data.osm.OsmPrimitive}.
44 * @since 1709
45 */
46public class VersionTable extends JTable implements ChangeListener, Destroyable {
47 private VersionTablePopupMenu popupMenu;
48 private final transient HistoryBrowserModel model;
49
50 /**
51 * Constructs a new {@code VersionTable}.
52 * @param model model used by the history browser
53 */
54 public VersionTable(HistoryBrowserModel model) {
55 super(model.getVersionTableModel(), new VersionTableColumnModel());
56 model.addChangeListener(this);
57 build();
58 this.model = model;
59 }
60
61 /**
62 * Builds the table.
63 */
64 protected void build() {
65 getTableHeader().setFont(getTableHeader().getFont().deriveFont(9f));
66 setRowSelectionAllowed(false);
67 setShowGrid(false);
68 setAutoResizeMode(JTable.AUTO_RESIZE_OFF);
69 GuiHelper.setBackgroundReadable(this, UIManager.getColor("Button.background"));
70 setIntercellSpacing(new Dimension(6, 0));
71 putClientProperty("terminateEditOnFocusLost", Boolean.TRUE);
72 popupMenu = new VersionTablePopupMenu();
73 addMouseListener(new MouseListener());
74 addKeyListener(new KeyAdapter() {
75 @Override
76 public void keyReleased(KeyEvent e) {
77 // navigate history down/up using the corresponding arrow keys.
78 long ref = model.getReferencePointInTime().getVersion();
79 long cur = model.getCurrentPointInTime().getVersion();
80 if (e.getKeyCode() == KeyEvent.VK_DOWN) {
81 History refNext = model.getHistory().from(ref);
82 History curNext = model.getHistory().from(cur);
83 if (refNext.getNumVersions() > 1 && curNext.getNumVersions() > 1) {
84 model.setReferencePointInTime(refNext.sortAscending().get(1));
85 model.setCurrentPointInTime(curNext.sortAscending().get(1));
86 }
87 } else if (e.getKeyCode() == KeyEvent.VK_UP) {
88 History refNext = model.getHistory().until(ref);
89 History curNext = model.getHistory().until(cur);
90 if (refNext.getNumVersions() > 1 && curNext.getNumVersions() > 1) {
91 model.setReferencePointInTime(refNext.sortDescending().get(1));
92 model.setCurrentPointInTime(curNext.sortDescending().get(1));
93 }
94 }
95 }
96 });
97 getModel().addTableModelListener(e -> {
98 adjustColumnWidth(this, 0, 0);
99 adjustColumnWidth(this, 1, -8);
100 adjustColumnWidth(this, 2, -8);
101 adjustColumnWidth(this, 3, 0);
102 adjustColumnWidth(this, 4, 0);
103 adjustColumnWidth(this, 5, 0);
104 });
105 }
106
107 @Override
108 public void destroy() {
109 popupMenu.destroy();
110 }
111
112 // some kind of hack to prevent the table from scrolling to the
113 // right when clicking on the cells
114 @Override
115 public void scrollRectToVisible(Rectangle aRect) {
116 super.scrollRectToVisible(new Rectangle(0, aRect.y, aRect.width, aRect.height));
117 }
118
119 @Override
120 public void stateChanged(ChangeEvent e) {
121 repaint();
122 }
123
124 final class MouseListener extends PopupMenuLauncher {
125 private MouseListener() {
126 super(popupMenu);
127 }
128
129 @Override
130 public void mousePressed(MouseEvent e) {
131 super.mousePressed(e);
132 if (!e.isPopupTrigger() && e.getButton() == MouseEvent.BUTTON1) {
133 int row = rowAtPoint(e.getPoint());
134 int col = columnAtPoint(e.getPoint());
135 if (row >= 0 && (col == VersionTableColumnModel.COL_DATE || col == VersionTableColumnModel.COL_USER)) {
136 model.setCurrentPointInTime(row);
137 model.setReferencePointInTime(Math.max(0, row - 1));
138 }
139 }
140 }
141
142 @Override
143 protected int checkTableSelection(JTable table, Point p) {
144 int row = rowAtPoint(p);
145 if (row > -1 && !model.isLatest(row)) {
146 popupMenu.prepare(model.getPrimitive(row));
147 }
148 return row;
149 }
150 }
151
152 static class ChangesetInfoAction extends AbstractInfoAction {
153 private transient HistoryOsmPrimitive primitive;
154
155 /**
156 * Constructs a new {@code ChangesetInfoAction}.
157 */
158 ChangesetInfoAction() {
159 super(true);
160 putValue(NAME, tr("Changeset info"));
161 putValue(SHORT_DESCRIPTION, tr("Launch browser with information about the changeset"));
162 new ImageProvider("data/changeset").getResource().attachImageIcon(this, true);
163 }
164
165 @Override
166 protected String createInfoUrl(Object infoObject) {
167 if (infoObject instanceof HistoryOsmPrimitive) {
168 HistoryOsmPrimitive prim = (HistoryOsmPrimitive) infoObject;
169 return Config.getUrls().getBaseBrowseUrl() + "/changeset/" + prim.getChangesetId();
170 } else {
171 return null;
172 }
173 }
174
175 @Override
176 public void actionPerformed(ActionEvent e) {
177 if (!isEnabled())
178 return;
179 String url = createInfoUrl(primitive);
180 OpenBrowser.displayUrl(url);
181 }
182
183 public void prepare(HistoryOsmPrimitive primitive) {
184 putValue(NAME, tr("Show changeset {0}", primitive.getChangesetId()));
185 this.primitive = primitive;
186 }
187 }
188
189 static class UserInfoAction extends AbstractInfoAction {
190 private transient HistoryOsmPrimitive primitive;
191
192 /**
193 * Constructs a new {@code UserInfoAction}.
194 */
195 UserInfoAction() {
196 super(true);
197 putValue(NAME, tr("User info"));
198 putValue(SHORT_DESCRIPTION, tr("Launch browser with information about the user"));
199 new ImageProvider("data/user").getResource().attachImageIcon(this, true);
200 }
201
202 @Override
203 protected String createInfoUrl(Object infoObject) {
204 if (infoObject instanceof HistoryOsmPrimitive) {
205 HistoryOsmPrimitive hp = (HistoryOsmPrimitive) infoObject;
206 return hp.getUser() == null ? null : Config.getUrls().getBaseUserUrl() + '/' + hp.getUser().getName();
207 } else {
208 return null;
209 }
210 }
211
212 @Override
213 public void actionPerformed(ActionEvent e) {
214 if (!isEnabled())
215 return;
216 String url = createInfoUrl(primitive);
217 OpenBrowser.displayUrl(url);
218 }
219
220 public void prepare(HistoryOsmPrimitive primitive) {
221 final User user = primitive.getUser();
222 putValue(NAME, "<html>" + tr("Show user {0}", user == null ? "?" :
223 XmlWriter.encode(user.getName(), true) + " <font color=gray>(" + user.getId() + ")</font>") + "</html>");
224 this.primitive = primitive;
225 }
226 }
227
228 static class VersionTablePopupMenu extends JPopupMenu implements Destroyable {
229
230 private ChangesetInfoAction changesetInfoAction;
231 private UserInfoAction userInfoAction;
232
233 /**
234 * Constructs a new {@code VersionTablePopupMenu}.
235 */
236 VersionTablePopupMenu() {
237 super();
238 build();
239 }
240
241 protected void build() {
242 changesetInfoAction = new ChangesetInfoAction();
243 add(changesetInfoAction);
244 userInfoAction = new UserInfoAction();
245 add(userInfoAction);
246 }
247
248 public void prepare(HistoryOsmPrimitive primitive) {
249 changesetInfoAction.prepare(primitive);
250 userInfoAction.prepare(primitive);
251 invalidate();
252 }
253
254 @Override
255 public void destroy() {
256 if (changesetInfoAction != null)
257 changesetInfoAction.destroy();
258 if (userInfoAction != null)
259 userInfoAction.destroy();
260 }
261 }
262
263 /**
264 * Renderer for history radio buttons in columns A and B.
265 */
266 public static class RadioButtonRenderer extends JRadioButton implements TableCellRenderer {
267
268 @Override
269 public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus,
270 int row, int column) {
271 setSelected(value != null && (Boolean) value);
272 setHorizontalAlignment(SwingConstants.CENTER);
273 return this;
274 }
275 }
276
277 /**
278 * Editor for history radio buttons in columns A and B.
279 */
280 public static class RadioButtonEditor extends DefaultCellEditor implements ItemListener {
281
282 private final JRadioButton btn;
283
284 /**
285 * Constructs a new {@code RadioButtonEditor}.
286 */
287 public RadioButtonEditor() {
288 super(new JCheckBox());
289 btn = new JRadioButton();
290 btn.setHorizontalAlignment(SwingConstants.CENTER);
291 }
292
293 @Override
294 public Component getTableCellEditorComponent(JTable table, Object value, boolean isSelected, int row, int column) {
295 if (value == null)
296 return null;
297 boolean val = (Boolean) value;
298 btn.setSelected(val);
299 btn.addItemListener(this);
300 return btn;
301 }
302
303 @Override
304 public Object getCellEditorValue() {
305 btn.removeItemListener(this);
306 return btn.isSelected();
307 }
308
309 @Override
310 public void itemStateChanged(ItemEvent e) {
311 fireEditingStopped();
312 }
313 }
314
315 /**
316 * Renderer for history version labels, allowing to define horizontal alignment.
317 */
318 public static class AlignedRenderer extends JLabel implements TableCellRenderer {
319
320 /**
321 * Constructs a new {@code AlignedRenderer}.
322 * @param hAlignment Horizontal alignement. One of the following constants defined in SwingConstants:
323 * LEFT, CENTER (the default for image-only labels), RIGHT, LEADING (the default for text-only labels) or TRAILING
324 */
325 public AlignedRenderer(int hAlignment) {
326 setHorizontalAlignment(hAlignment);
327 }
328
329 AlignedRenderer() {
330 this(SwingConstants.LEFT);
331 }
332
333 @Override
334 public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus,
335 int row, int column) {
336 String v = "";
337 if (value != null) {
338 v = value.toString();
339 }
340 setText(v);
341 return this;
342 }
343 }
344
345 private static void adjustColumnWidth(JTable tbl, int col, int cellInset) {
346 int maxwidth = 0;
347
348 for (int row = 0; row < tbl.getRowCount(); row++) {
349 TableCellRenderer tcr = tbl.getCellRenderer(row, col);
350 Object val = tbl.getValueAt(row, col);
351 Component comp = tcr.getTableCellRendererComponent(tbl, val, false, false, row, col);
352 maxwidth = Math.max(comp.getPreferredSize().width + cellInset, maxwidth);
353 }
354 TableCellRenderer tcr = tbl.getTableHeader().getDefaultRenderer();
355 Object val = tbl.getColumnModel().getColumn(col).getHeaderValue();
356 Component comp = tcr.getTableCellRendererComponent(tbl, val, false, false, -1, col);
357 maxwidth = Math.max(comp.getPreferredSize().width + Config.getPref().getInt("table.header-inset", 0), maxwidth);
358
359 int spacing = tbl.getIntercellSpacing().width;
360 tbl.getColumnModel().getColumn(col).setPreferredWidth(maxwidth + spacing);
361 }
362}
Note: See TracBrowser for help on using the repository browser.