source: josm/trunk/src/org/openstreetmap/josm/gui/layer/gpx/ChooseTrackVisibilityAction.java@ 9804

Last change on this file since 9804 was 9804, checked in by Don-vip, 8 years ago

robustness/code refactoring for unit tests
  • Property svn:eol-style set to native
File size: 12.0 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.layer.gpx;
3
4import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
5import static org.openstreetmap.josm.tools.I18n.tr;
6
7import java.awt.Component;
8import java.awt.Dimension;
9import java.awt.GraphicsEnvironment;
10import java.awt.GridBagLayout;
11import java.awt.event.ActionEvent;
12import java.awt.event.ActionListener;
13import java.awt.event.MouseAdapter;
14import java.awt.event.MouseEvent;
15import java.awt.event.MouseListener;
16import java.io.Serializable;
17import java.util.Arrays;
18import java.util.Comparator;
19import java.util.Map;
20
21import javax.swing.AbstractAction;
22import javax.swing.JComponent;
23import javax.swing.JLabel;
24import javax.swing.JPanel;
25import javax.swing.JScrollPane;
26import javax.swing.JTable;
27import javax.swing.JToggleButton;
28import javax.swing.ListSelectionModel;
29import javax.swing.event.ListSelectionEvent;
30import javax.swing.event.ListSelectionListener;
31import javax.swing.table.DefaultTableModel;
32import javax.swing.table.TableCellRenderer;
33import javax.swing.table.TableRowSorter;
34
35import org.openstreetmap.josm.Main;
36import org.openstreetmap.josm.data.SystemOfMeasurement;
37import org.openstreetmap.josm.data.gpx.GpxConstants;
38import org.openstreetmap.josm.data.gpx.GpxTrack;
39import org.openstreetmap.josm.gui.ExtendedDialog;
40import org.openstreetmap.josm.gui.layer.GpxLayer;
41import org.openstreetmap.josm.tools.GBC;
42import org.openstreetmap.josm.tools.ImageProvider;
43import org.openstreetmap.josm.tools.OpenBrowser;
44import org.openstreetmap.josm.tools.WindowGeometry;
45
46/**
47 * allows the user to choose which of the downloaded tracks should be displayed.
48 * they can be chosen from the gpx layer context menu.
49 */
50public class ChooseTrackVisibilityAction extends AbstractAction {
51 private final transient GpxLayer layer;
52
53 private DateFilterPanel dateFilter;
54 private JTable table;
55
56 /**
57 * Constructs a new {@code ChooseTrackVisibilityAction}.
58 * @param layer The associated GPX layer
59 */
60 public ChooseTrackVisibilityAction(final GpxLayer layer) {
61 super(tr("Choose visible tracks"), ImageProvider.get("dialogs/filter"));
62 this.layer = layer;
63 putValue("help", ht("/Action/ChooseTrackVisibility"));
64 }
65
66 /**
67 * Class to format a length according to SystemOfMesurement.
68 */
69 private static final class TrackLength {
70 private final double value;
71
72 /**
73 * Constructs a new {@code TrackLength} object with a given length.
74 * @param value length of the track
75 */
76 TrackLength(double value) {
77 this.value = value;
78 }
79
80 /**
81 * Provides string representation.
82 * @return String representation depending of SystemOfMeasurement
83 */
84 @Override
85 public String toString() {
86 return SystemOfMeasurement.getSystemOfMeasurement().getDistText(value);
87 }
88 }
89
90 /**
91 * Comparator for TrackLength objects
92 */
93 private static final class LengthContentComparator implements Comparator<TrackLength>, Serializable {
94
95 private static final long serialVersionUID = 1L;
96
97 /**
98 * Compare 2 TrackLength objects relative to the real length
99 */
100 @Override
101 public int compare(TrackLength l0, TrackLength l1) {
102 if (l0.value < l1.value)
103 return -1;
104 else if (l0.value > l1.value)
105 return 1;
106 return 0;
107 }
108 }
109
110 /**
111 * Gathers all available data for the tracks and returns them as array of arrays
112 * in the expected column order.
113 * @return table data
114 */
115 private Object[][] buildTableContents() {
116 Object[][] tracks = new Object[layer.data.tracks.size()][5];
117 int i = 0;
118 for (GpxTrack trk : layer.data.tracks) {
119 Map<String, Object> attr = trk.getAttributes();
120 String name = (String) (attr.containsKey(GpxConstants.GPX_NAME) ? attr.get(GpxConstants.GPX_NAME) : "");
121 String desc = (String) (attr.containsKey(GpxConstants.GPX_DESC) ? attr.get(GpxConstants.GPX_DESC) : "");
122 String time = GpxLayer.getTimespanForTrack(trk);
123 TrackLength length = new TrackLength(trk.length());
124 String url = (String) (attr.containsKey("url") ? attr.get("url") : "");
125 tracks[i] = new Object[]{name, desc, time, length, url};
126 i++;
127 }
128 return tracks;
129 }
130
131 /**
132 * Builds an non-editable table whose 5th column will open a browser when double clicked.
133 * The table will fill its parent.
134 * @param content table data
135 * @return non-editable table
136 */
137 private JTable buildTable(Object[][] content) {
138 final String[] headers = {tr("Name"), tr("Description"), tr("Timespan"), tr("Length"), tr("URL")};
139 DefaultTableModel model = new DefaultTableModel(content, headers);
140 final JTable t = new JTable(model) {
141 @Override
142 public Component prepareRenderer(TableCellRenderer renderer, int row, int col) {
143 Component c = super.prepareRenderer(renderer, row, col);
144 if (c instanceof JComponent) {
145 JComponent jc = (JComponent) c;
146 jc.setToolTipText(getValueAt(row, col).toString());
147 }
148 return c;
149 }
150
151 @Override
152 public boolean isCellEditable(int rowIndex, int colIndex) {
153 return false;
154 }
155 };
156 // define how to sort row
157 TableRowSorter<DefaultTableModel> rowSorter = new TableRowSorter<>();
158 t.setRowSorter(rowSorter);
159 rowSorter.setModel(model);
160 rowSorter.setComparator(3, new LengthContentComparator());
161 // default column widths
162 t.getColumnModel().getColumn(0).setPreferredWidth(220);
163 t.getColumnModel().getColumn(1).setPreferredWidth(300);
164 t.getColumnModel().getColumn(2).setPreferredWidth(200);
165 t.getColumnModel().getColumn(3).setPreferredWidth(50);
166 t.getColumnModel().getColumn(4).setPreferredWidth(100);
167 // make the link clickable
168 final MouseListener urlOpener = new MouseAdapter() {
169 @Override
170 public void mouseClicked(MouseEvent e) {
171 if (e.getClickCount() != 2) {
172 return;
173 }
174 JTable t = (JTable) e.getSource();
175 int col = t.convertColumnIndexToModel(t.columnAtPoint(e.getPoint()));
176 if (col != 4) {
177 return;
178 }
179 int row = t.rowAtPoint(e.getPoint());
180 String url = (String) t.getValueAt(row, col);
181 if (url == null || url.isEmpty()) {
182 return;
183 }
184 OpenBrowser.displayUrl(url);
185 }
186 };
187 t.addMouseListener(urlOpener);
188 t.setFillsViewportHeight(true);
189 return t;
190 }
191
192 private boolean noUpdates;
193
194 /** selects all rows (=tracks) in the table that are currently visible on the layer*/
195 private void selectVisibleTracksInTable() {
196 // don't select any tracks if the layer is not visible
197 if (!layer.isVisible()) {
198 return;
199 }
200 ListSelectionModel s = table.getSelectionModel();
201 s.clearSelection();
202 for (int i = 0; i < layer.trackVisibility.length; i++) {
203 if (layer.trackVisibility[i]) {
204 s.addSelectionInterval(i, i);
205 }
206 }
207 }
208
209 /** listens to selection changes in the table and redraws the map */
210 private void listenToSelectionChanges() {
211 table.getSelectionModel().addListSelectionListener(new ListSelectionListener() {
212 @Override
213 public void valueChanged(ListSelectionEvent e) {
214 if (noUpdates || !(e.getSource() instanceof ListSelectionModel)) {
215 return;
216 }
217 updateVisibilityFromTable();
218 }
219 });
220 }
221
222 private void updateVisibilityFromTable() {
223 ListSelectionModel s = table.getSelectionModel();
224 for (int i = 0; i < layer.trackVisibility.length; i++) {
225 layer.trackVisibility[table.convertRowIndexToModel(i)] = s.isSelectedIndex(i);
226 }
227 Main.map.mapView.preferenceChanged(null);
228 Main.map.repaint(100);
229 }
230
231 @Override
232 public void actionPerformed(ActionEvent arg0) {
233 final JPanel msg = new JPanel(new GridBagLayout());
234
235 dateFilter = new DateFilterPanel(layer, "gpx.traces", false);
236 dateFilter.setFilterAppliedListener(new ActionListener() {
237 @Override public void actionPerformed(ActionEvent e) {
238 noUpdates = true;
239 selectVisibleTracksInTable();
240 noUpdates = false;
241 Main.map.mapView.preferenceChanged(null);
242 Main.map.repaint(100);
243 }
244 });
245 dateFilter.loadFromPrefs();
246
247 final JToggleButton b = new JToggleButton(new AbstractAction(tr("Select by date")) {
248 @Override public void actionPerformed(ActionEvent e) {
249 if (((JToggleButton) e.getSource()).isSelected()) {
250 dateFilter.setEnabled(true);
251 dateFilter.applyFilter();
252 } else {
253 dateFilter.setEnabled(false);
254 }
255 }
256 });
257 dateFilter.setEnabled(false);
258 msg.add(b, GBC.std().insets(0, 0, 5, 0));
259 msg.add(dateFilter, GBC.eol().insets(0, 0, 10, 0).fill(GBC.HORIZONTAL));
260
261 msg.add(new JLabel(tr("<html>Select all tracks that you want to be displayed. " +
262 "You can drag select a range of tracks or use CTRL+Click to select specific ones. " +
263 "The map is updated live in the background. Open the URLs by double clicking them.</html>")),
264 GBC.eop().fill(GBC.HORIZONTAL));
265 // build table
266 final boolean[] trackVisibilityBackup = layer.trackVisibility.clone();
267 table = buildTable(buildTableContents());
268 selectVisibleTracksInTable();
269 listenToSelectionChanges();
270 // make the table scrollable
271 JScrollPane scrollPane = new JScrollPane(table);
272 msg.add(scrollPane, GBC.eol().fill(GBC.BOTH));
273
274 int v = 1;
275 if (!GraphicsEnvironment.isHeadless()) {
276 // build dialog
277 ExtendedDialog ed = new ExtendedDialog(Main.parent, tr("Set track visibility for {0}", layer.getName()),
278 new String[]{tr("Show all"), tr("Show selected only"), tr("Cancel")});
279 ed.setButtonIcons(new String[]{"eye", "dialogs/filter", "cancel"});
280 ed.setContent(msg, false);
281 ed.setDefaultButton(2);
282 ed.setCancelButton(3);
283 ed.configureContextsensitiveHelp("/Action/ChooseTrackVisibility", true);
284 ed.setRememberWindowGeometry(getClass().getName() + ".geometry",
285 WindowGeometry.centerInWindow(Main.parent, new Dimension(1000, 500)));
286 ed.showDialog();
287 dateFilter.saveInPrefs();
288 v = ed.getValue();
289 // cancel for unknown buttons and copy back original settings
290 if (v != 1 && v != 2) {
291 layer.trackVisibility = Arrays.copyOf(trackVisibilityBackup, layer.trackVisibility.length);
292 Main.map.repaint();
293 return;
294 }
295 }
296 // set visibility (1 = show all, 2 = filter). If no tracks are selected
297 // set all of them visible and...
298 ListSelectionModel s = table.getSelectionModel();
299 final boolean all = v == 1 || s.isSelectionEmpty();
300 for (int i = 0; i < layer.trackVisibility.length; i++) {
301 layer.trackVisibility[table.convertRowIndexToModel(i)] = all || s.isSelectedIndex(i);
302 }
303 // ...sync with layer visibility instead to avoid having two ways to hide everything
304 layer.setVisible(v == 1 || !s.isSelectionEmpty());
305
306 if (Main.isDisplayingMapView()) {
307 Main.map.mapView.preferenceChanged(null);
308 }
309 if (Main.map != null) {
310 Main.map.repaint();
311 }
312 }
313}
Note: See TracBrowser for help on using the repository browser.