001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.gui.layer.gpx; 003 004import static org.openstreetmap.josm.gui.help.HelpUtil.ht; 005import static org.openstreetmap.josm.tools.I18n.tr; 006 007import java.awt.Component; 008import java.awt.Dimension; 009import java.awt.GridBagLayout; 010import java.awt.event.ActionEvent; 011import java.awt.event.ActionListener; 012import java.awt.event.MouseAdapter; 013import java.awt.event.MouseEvent; 014import java.awt.event.MouseListener; 015import java.util.Arrays; 016import java.util.Comparator; 017import java.util.Map; 018 019import javax.swing.AbstractAction; 020import javax.swing.JComponent; 021import javax.swing.JLabel; 022import javax.swing.JPanel; 023import javax.swing.JScrollPane; 024import javax.swing.JTable; 025import javax.swing.JToggleButton; 026import javax.swing.ListSelectionModel; 027import javax.swing.event.ListSelectionEvent; 028import javax.swing.event.ListSelectionListener; 029import javax.swing.table.DefaultTableModel; 030import javax.swing.table.TableCellRenderer; 031import javax.swing.table.TableRowSorter; 032 033import org.openstreetmap.josm.Main; 034import org.openstreetmap.josm.data.gpx.GpxTrack; 035import org.openstreetmap.josm.gui.ExtendedDialog; 036import org.openstreetmap.josm.gui.NavigatableComponent; 037import org.openstreetmap.josm.gui.layer.GpxLayer; 038import org.openstreetmap.josm.tools.GBC; 039import org.openstreetmap.josm.tools.ImageProvider; 040import org.openstreetmap.josm.tools.OpenBrowser; 041import org.openstreetmap.josm.tools.WindowGeometry; 042 043/** 044 * allows the user to choose which of the downloaded tracks should be displayed. 045 * they can be chosen from the gpx layer context menu. 046 */ 047public class ChooseTrackVisibilityAction extends AbstractAction { 048 private final GpxLayer layer; 049 050 DateFilterPanel dateFilter; 051 JTable table; 052 053 /** 054 * Constructs a new {@code ChooseTrackVisibilityAction}. 055 * @param layer The associated GPX layer 056 */ 057 public ChooseTrackVisibilityAction(final GpxLayer layer) { 058 super(tr("Choose visible tracks"), ImageProvider.get("dialogs/filter")); 059 this.layer = layer; 060 putValue("help", ht("/Action/ChooseTrackVisibility")); 061 } 062 063 /** 064 * Class to format a length according to SystemOfMesurement. 065 */ 066 private static final class TrackLength { 067 private double value; 068 069 /** 070 * Constructs a new {@code TrackLength} object with a given length. 071 * @param value length of the track 072 */ 073 TrackLength(double value) { 074 this.value = value; 075 } 076 077 /** 078 * Provides string representation. 079 * @return String representation depending of SystemOfMeasurement 080 */ 081 @Override 082 public String toString() { 083 return NavigatableComponent.getSystemOfMeasurement().getDistText(value); 084 } 085 } 086 087 /** 088 * Comparator for TrackLength objects 089 */ 090 private static final class LengthContentComparator implements Comparator<TrackLength> { 091 092 /** 093 * Compare 2 TrackLength objects relative to the real length 094 */ 095 @Override 096 public int compare(TrackLength l0, TrackLength l1) { 097 if(l0.value < l1.value) 098 return -1; 099 else if(l0.value > l1.value) 100 return 1; 101 return 0; 102 } 103 } 104 105 /** 106 * gathers all available data for the tracks and returns them as array of arrays 107 * in the expected column order */ 108 private Object[][] buildTableContents() { 109 Object[][] tracks = new Object[layer.data.tracks.size()][5]; 110 int i = 0; 111 for (GpxTrack trk : layer.data.tracks) { 112 Map<String, Object> attr = trk.getAttributes(); 113 String name = (String) (attr.containsKey("name") ? attr.get("name") : ""); 114 String desc = (String) (attr.containsKey("desc") ? attr.get("desc") : ""); 115 String time = GpxLayer.getTimespanForTrack(trk); 116 TrackLength length = new TrackLength(trk.length()); 117 String url = (String) (attr.containsKey("url") ? attr.get("url") : ""); 118 tracks[i] = new Object[]{name, desc, time, length, url}; 119 i++; 120 } 121 return tracks; 122 } 123 124 /** 125 * Builds an non-editable table whose 5th column will open a browser when double clicked. 126 * The table will fill its parent. */ 127 private JTable buildTable(Object[][] content) { 128 final String[] headers = {tr("Name"), tr("Description"), tr("Timespan"), tr("Length"), tr("URL")}; 129 DefaultTableModel model = new DefaultTableModel(content, headers); 130 final JTable t = new JTable(model) { 131 @Override 132 public Component prepareRenderer(TableCellRenderer renderer, int row, int col) { 133 Component c = super.prepareRenderer(renderer, row, col); 134 if (c instanceof JComponent) { 135 JComponent jc = (JComponent) c; 136 jc.setToolTipText(getValueAt(row, col).toString()); 137 } 138 return c; 139 } 140 141 @Override 142 public boolean isCellEditable(int rowIndex, int colIndex) { 143 return false; 144 } 145 }; 146 // define how to sort row 147 TableRowSorter<DefaultTableModel> rowSorter = new TableRowSorter<>(); 148 t.setRowSorter(rowSorter); 149 rowSorter.setModel(model); 150 rowSorter.setComparator(3, new LengthContentComparator()); 151 // default column widths 152 t.getColumnModel().getColumn(0).setPreferredWidth(220); 153 t.getColumnModel().getColumn(1).setPreferredWidth(300); 154 t.getColumnModel().getColumn(2).setPreferredWidth(200); 155 t.getColumnModel().getColumn(3).setPreferredWidth(50); 156 t.getColumnModel().getColumn(4).setPreferredWidth(100); 157 // make the link clickable 158 final MouseListener urlOpener = new MouseAdapter() { 159 @Override 160 public void mouseClicked(MouseEvent e) { 161 if (e.getClickCount() != 2) { 162 return; 163 } 164 JTable t = (JTable) e.getSource(); 165 int col = t.convertColumnIndexToModel(t.columnAtPoint(e.getPoint())); 166 if (col != 4) { 167 return; 168 } 169 int row = t.rowAtPoint(e.getPoint()); 170 String url = (String) t.getValueAt(row, col); 171 if (url == null || url.isEmpty()) { 172 return; 173 } 174 OpenBrowser.displayUrl(url); 175 } 176 }; 177 t.addMouseListener(urlOpener); 178 t.setFillsViewportHeight(true); 179 return t; 180 } 181 182 boolean noUpdates=false; 183 184 /** selects all rows (=tracks) in the table that are currently visible on the layer*/ 185 private void selectVisibleTracksInTable() { 186 // don't select any tracks if the layer is not visible 187 if (!layer.isVisible()) { 188 return; 189 } 190 ListSelectionModel s = table.getSelectionModel(); 191 s.clearSelection(); 192 for (int i = 0; i < layer.trackVisibility.length; i++) { 193 if (layer.trackVisibility[i]) { 194 s.addSelectionInterval(i, i); 195 } 196 } 197 } 198 199 /** listens to selection changes in the table and redraws the map */ 200 private void listenToSelectionChanges() { 201 table.getSelectionModel().addListSelectionListener(new ListSelectionListener() { 202 @Override 203 public void valueChanged(ListSelectionEvent e) { 204 if (noUpdates || !(e.getSource() instanceof ListSelectionModel)) { 205 return; 206 } 207 updateVisibilityFromTable(); 208 } 209 }); 210 } 211 212 private void updateVisibilityFromTable() { 213 ListSelectionModel s = table.getSelectionModel(); 214 for (int i = 0; i < layer.trackVisibility.length; i++) { 215 layer.trackVisibility[table.convertRowIndexToModel(i)] = s.isSelectedIndex(i); 216 } 217 Main.map.mapView.preferenceChanged(null); 218 Main.map.repaint(100); 219 } 220 221 @Override 222 public void actionPerformed(ActionEvent arg0) { 223 final JPanel msg = new JPanel(new GridBagLayout()); 224 225 dateFilter = new DateFilterPanel(layer, "gpx.traces", false); 226 dateFilter.setFilterAppliedListener(new ActionListener(){ 227 @Override public void actionPerformed(ActionEvent e) { 228 noUpdates = true; 229 selectVisibleTracksInTable(); 230 noUpdates = false; 231 Main.map.mapView.preferenceChanged(null); 232 Main.map.repaint(100); 233 } 234 }); 235 dateFilter.loadFromPrefs(); 236 237 final JToggleButton b = new JToggleButton(new AbstractAction(tr("Select by date")) { 238 @Override public void actionPerformed(ActionEvent e) { 239 if (((JToggleButton) e.getSource()).isSelected()) { 240 dateFilter.setEnabled(true); 241 dateFilter.applyFilter(); 242 } else { 243 dateFilter.setEnabled(false); 244 } 245 } 246 }); 247 dateFilter.setEnabled(false); 248 msg.add(b, GBC.std().insets(0,0,5,0)); 249 msg.add(dateFilter, GBC.eol().insets(0,0,10,0).fill(GBC.HORIZONTAL)); 250 251 msg.add(new JLabel(tr("<html>Select all tracks that you want to be displayed. You can drag select a " + "range of tracks or use CTRL+Click to select specific ones. The map is updated live in the " + "background. Open the URLs by double clicking them.</html>")), GBC.eop().fill(GBC.HORIZONTAL)); 252 // build table 253 final boolean[] trackVisibilityBackup = layer.trackVisibility.clone(); 254 table = buildTable(buildTableContents()); 255 selectVisibleTracksInTable(); 256 listenToSelectionChanges(); 257 // make the table scrollable 258 JScrollPane scrollPane = new JScrollPane(table); 259 msg.add(scrollPane, GBC.eol().fill(GBC.BOTH)); 260 261 // build dialog 262 ExtendedDialog ed = new ExtendedDialog(Main.parent, tr("Set track visibility for {0}", layer.getName()), new String[]{tr("Show all"), tr("Show selected only"), tr("Cancel")}); 263 ed.setButtonIcons(new String[]{"dialogs/layerlist/eye", "dialogs/filter", "cancel"}); 264 ed.setContent(msg, false); 265 ed.setDefaultButton(2); 266 ed.setCancelButton(3); 267 ed.configureContextsensitiveHelp("/Action/ChooseTrackVisibility", true); 268 ed.setRememberWindowGeometry(getClass().getName() + ".geometry", WindowGeometry.centerInWindow(Main.parent, new Dimension(1000, 500))); 269 ed.showDialog(); 270 dateFilter.saveInPrefs(); 271 int v = ed.getValue(); 272 // cancel for unknown buttons and copy back original settings 273 if (v != 1 && v != 2) { 274 layer.trackVisibility = Arrays.copyOf(trackVisibilityBackup, layer.trackVisibility.length); 275 Main.map.repaint(); 276 return; 277 } 278 // set visibility (1 = show all, 2 = filter). If no tracks are selected 279 // set all of them visible and... 280 ListSelectionModel s = table.getSelectionModel(); 281 final boolean all = v == 1 || s.isSelectionEmpty(); 282 for (int i = 0; i < layer.trackVisibility.length; i++) { 283 layer.trackVisibility[table.convertRowIndexToModel(i)] = all || s.isSelectedIndex(i); 284 } 285 // ...sync with layer visibility instead to avoid having two ways to hide everything 286 layer.setVisible(v == 1 || !s.isSelectionEmpty()); 287 288 Main.map.mapView.preferenceChanged(null); 289 Main.map.repaint(); 290 } 291 292}