source: josm/trunk/src/org/openstreetmap/josm/gui/dialogs/FilterDialog.java@ 8836

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

fix Checkstyle issues
  • Property svn:eol-style set to native
File size: 16.8 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.dialogs;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.Component;
7import java.awt.Graphics2D;
8import java.awt.event.ActionEvent;
9import java.awt.event.KeyEvent;
10import java.awt.event.MouseEvent;
11import java.util.ArrayList;
12import java.util.Arrays;
13import java.util.Collection;
14import java.util.HashSet;
15import java.util.List;
16import java.util.Set;
17import java.util.Stack;
18
19import javax.swing.AbstractAction;
20import javax.swing.JCheckBox;
21import javax.swing.JTable;
22import javax.swing.ListSelectionModel;
23import javax.swing.SwingUtilities;
24import javax.swing.table.DefaultTableCellRenderer;
25import javax.swing.table.JTableHeader;
26import javax.swing.table.TableCellRenderer;
27
28import org.openstreetmap.josm.Main;
29import org.openstreetmap.josm.actions.search.SearchAction;
30import org.openstreetmap.josm.data.osm.Filter;
31import org.openstreetmap.josm.data.osm.OsmPrimitive;
32import org.openstreetmap.josm.data.osm.Relation;
33import org.openstreetmap.josm.data.osm.RelationMember;
34import org.openstreetmap.josm.data.osm.Way;
35import org.openstreetmap.josm.data.osm.event.AbstractDatasetChangedEvent;
36import org.openstreetmap.josm.data.osm.event.DataChangedEvent;
37import org.openstreetmap.josm.data.osm.event.DataSetListener;
38import org.openstreetmap.josm.data.osm.event.DatasetEventManager;
39import org.openstreetmap.josm.data.osm.event.DatasetEventManager.FireMode;
40import org.openstreetmap.josm.data.osm.event.NodeMovedEvent;
41import org.openstreetmap.josm.data.osm.event.PrimitivesAddedEvent;
42import org.openstreetmap.josm.data.osm.event.PrimitivesRemovedEvent;
43import org.openstreetmap.josm.data.osm.event.RelationMembersChangedEvent;
44import org.openstreetmap.josm.data.osm.event.TagsChangedEvent;
45import org.openstreetmap.josm.data.osm.event.WayNodesChangedEvent;
46import org.openstreetmap.josm.gui.SideButton;
47import org.openstreetmap.josm.tools.ImageProvider;
48import org.openstreetmap.josm.tools.InputMapUtils;
49import org.openstreetmap.josm.tools.MultikeyActionsHandler;
50import org.openstreetmap.josm.tools.MultikeyShortcutAction;
51import org.openstreetmap.josm.tools.Shortcut;
52
53/**
54 *
55 * @author Petr_Dlouhý
56 */
57public class FilterDialog extends ToggleDialog implements DataSetListener {
58
59 private JTable userTable;
60 private FilterTableModel filterModel = new FilterTableModel();
61
62 private EnableFilterAction enableFilterAction;
63 private HidingFilterAction hidingFilterAction;
64
65 /**
66 * Constructs a new {@code FilterDialog}
67 */
68 public FilterDialog() {
69 super(tr("Filter"), "filter", tr("Filter objects and hide/disable them."),
70 Shortcut.registerShortcut("subwindow:filter", tr("Toggle: {0}", tr("Filter")),
71 KeyEvent.VK_F, Shortcut.ALT_SHIFT), 162);
72 build();
73 enableFilterAction = new EnableFilterAction();
74 hidingFilterAction = new HidingFilterAction();
75 MultikeyActionsHandler.getInstance().addAction(enableFilterAction);
76 MultikeyActionsHandler.getInstance().addAction(hidingFilterAction);
77 }
78
79 @Override
80 public void showNotify() {
81 DatasetEventManager.getInstance().addDatasetListener(this, FireMode.IN_EDT_CONSOLIDATED);
82 filterModel.executeFilters();
83 }
84
85 @Override
86 public void hideNotify() {
87 DatasetEventManager.getInstance().removeDatasetListener(this);
88 filterModel.clearFilterFlags();
89 Main.map.mapView.repaint();
90 }
91
92 private static final Shortcut ENABLE_FILTER_SHORTCUT
93 = Shortcut.registerShortcut("core_multikey:enableFilter", tr("Multikey: {0}", tr("Enable filter")),
94 KeyEvent.VK_E, Shortcut.ALT_CTRL);
95
96 private static final Shortcut HIDING_FILTER_SHORTCUT
97 = Shortcut.registerShortcut("core_multikey:hidingFilter", tr("Multikey: {0}", tr("Hide filter")),
98 KeyEvent.VK_H, Shortcut.ALT_CTRL);
99
100 protected final String[] columnToolTips = {
101 Main.platform.makeTooltip(tr("Enable filter"), ENABLE_FILTER_SHORTCUT),
102 Main.platform.makeTooltip(tr("Hiding filter"), HIDING_FILTER_SHORTCUT),
103 null,
104 tr("Inverse filter"),
105 tr("Filter mode")
106 };
107
108 protected void build() {
109 userTable = new JTable(filterModel) {
110 @Override
111 protected JTableHeader createDefaultTableHeader() {
112 return new JTableHeader(columnModel) {
113 @Override
114 public String getToolTipText(MouseEvent e) {
115 java.awt.Point p = e.getPoint();
116 int index = columnModel.getColumnIndexAtX(p.x);
117 int realIndex = columnModel.getColumn(index).getModelIndex();
118 return columnToolTips[realIndex];
119 }
120 };
121 }
122 };
123
124 userTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
125
126 userTable.getColumnModel().getColumn(0).setMaxWidth(1);
127 userTable.getColumnModel().getColumn(1).setMaxWidth(1);
128 userTable.getColumnModel().getColumn(3).setMaxWidth(1);
129 userTable.getColumnModel().getColumn(4).setMaxWidth(1);
130
131 userTable.getColumnModel().getColumn(0).setResizable(false);
132 userTable.getColumnModel().getColumn(1).setResizable(false);
133 userTable.getColumnModel().getColumn(3).setResizable(false);
134 userTable.getColumnModel().getColumn(4).setResizable(false);
135
136 userTable.setDefaultRenderer(Boolean.class, new BooleanRenderer());
137 userTable.setDefaultRenderer(String.class, new StringRenderer());
138
139 SideButton addButton = new SideButton(new AbstractAction() {
140 {
141 putValue(NAME, tr("Add"));
142 putValue(SHORT_DESCRIPTION, tr("Add filter."));
143 putValue(SMALL_ICON, ImageProvider.get("dialogs", "add"));
144 }
145
146 @Override
147 public void actionPerformed(ActionEvent e) {
148 Filter filter = (Filter) SearchAction.showSearchDialog(new Filter());
149 if (filter != null) {
150 filterModel.addFilter(filter);
151 }
152 }});
153 SideButton editButton = new SideButton(new AbstractAction() {
154 {
155 putValue(NAME, tr("Edit"));
156 putValue(SHORT_DESCRIPTION, tr("Edit filter."));
157 putValue(SMALL_ICON, ImageProvider.get("dialogs", "edit"));
158 }
159
160 @Override
161 public void actionPerformed(ActionEvent e) {
162 int index = userTable.getSelectionModel().getMinSelectionIndex();
163 if (index < 0) return;
164 Filter f = filterModel.getFilter(index);
165 Filter filter = (Filter) SearchAction.showSearchDialog(f);
166 if (filter != null) {
167 filterModel.setFilter(index, filter);
168 }
169 }
170 });
171 SideButton deleteButton = new SideButton(new AbstractAction() {
172 {
173 putValue(NAME, tr("Delete"));
174 putValue(SHORT_DESCRIPTION, tr("Delete filter."));
175 putValue(SMALL_ICON, ImageProvider.get("dialogs", "delete"));
176 }
177
178 @Override
179 public void actionPerformed(ActionEvent e) {
180 int index = userTable.getSelectionModel().getMinSelectionIndex();
181 if (index < 0) return;
182 filterModel.removeFilter(index);
183 }
184 });
185 SideButton upButton = new SideButton(new AbstractAction() {
186 {
187 putValue(NAME, tr("Up"));
188 putValue(SHORT_DESCRIPTION, tr("Move filter up."));
189 putValue(SMALL_ICON, ImageProvider.get("dialogs", "up"));
190 }
191
192 @Override
193 public void actionPerformed(ActionEvent e) {
194 int index = userTable.getSelectionModel().getMinSelectionIndex();
195 if (index < 0) return;
196 filterModel.moveUpFilter(index);
197 userTable.getSelectionModel().setSelectionInterval(index-1, index-1);
198 }
199
200 });
201 SideButton downButton = new SideButton(new AbstractAction() {
202 {
203 putValue(NAME, tr("Down"));
204 putValue(SHORT_DESCRIPTION, tr("Move filter down."));
205 putValue(SMALL_ICON, ImageProvider.get("dialogs", "down"));
206 }
207
208 @Override
209 public void actionPerformed(ActionEvent e) {
210 int index = userTable.getSelectionModel().getMinSelectionIndex();
211 if (index < 0) return;
212 filterModel.moveDownFilter(index);
213 userTable.getSelectionModel().setSelectionInterval(index+1, index+1);
214 }
215 });
216
217 // Toggle filter "enabled" on Enter
218 InputMapUtils.addEnterAction(userTable, new AbstractAction() {
219 @Override
220 public void actionPerformed(ActionEvent e) {
221 int index = userTable.getSelectedRow();
222 if (index < 0) return;
223 Filter filter = filterModel.getFilter(index);
224 filterModel.setValueAt(!filter.enable, index, FilterTableModel.COL_ENABLED);
225 }
226 });
227
228 // Toggle filter "hiding" on Spacebar
229 InputMapUtils.addSpacebarAction(userTable, new AbstractAction() {
230 @Override
231 public void actionPerformed(ActionEvent e) {
232 int index = userTable.getSelectedRow();
233 if (index < 0) return;
234 Filter filter = filterModel.getFilter(index);
235 filterModel.setValueAt(!filter.hiding, index, FilterTableModel.COL_HIDING);
236 }
237 });
238
239 createLayout(userTable, true, Arrays.asList(new SideButton[] {
240 addButton, editButton, deleteButton, upButton, downButton
241 }));
242 }
243
244 @Override
245 public void destroy() {
246 MultikeyActionsHandler.getInstance().removeAction(enableFilterAction);
247 MultikeyActionsHandler.getInstance().removeAction(hidingFilterAction);
248 super.destroy();
249 }
250
251 static class StringRenderer extends DefaultTableCellRenderer {
252 @Override
253 public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column) {
254 FilterTableModel model = (FilterTableModel) table.getModel();
255 Component cell = super.getTableCellRendererComponent(table, value, isSelected, hasFocus, row, column);
256 cell.setEnabled(model.isCellEnabled(row, column));
257 return cell;
258 }
259 }
260
261 static class BooleanRenderer extends JCheckBox implements TableCellRenderer {
262 @Override
263 public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column) {
264 FilterTableModel model = (FilterTableModel) table.getModel();
265 setSelected(value != null && (Boolean) value);
266 setEnabled(model.isCellEnabled(row, column));
267 setHorizontalAlignment(javax.swing.SwingConstants.CENTER);
268 return this;
269 }
270 }
271
272 public void updateDialogHeader() {
273 SwingUtilities.invokeLater(new Runnable() {
274 @Override
275 public void run() {
276 setTitle(tr("Filter Hidden:{0} Disabled:{1}", filterModel.disabledAndHiddenCount, filterModel.disabledCount));
277 }
278 });
279 }
280
281 public void drawOSDText(Graphics2D g) {
282 filterModel.drawOSDText(g);
283 }
284
285 /**
286 * Returns the list of primitives whose filtering can be affected by change in primitive
287 * @param primitives list of primitives to check
288 * @return List of primitives whose filtering can be affected by change in source primitives
289 */
290 private Collection<OsmPrimitive> getAffectedPrimitives(Collection<? extends OsmPrimitive> primitives) {
291 // Filters can use nested parent/child expression so complete tree is necessary
292 Set<OsmPrimitive> result = new HashSet<>();
293 Stack<OsmPrimitive> stack = new Stack<>();
294 stack.addAll(primitives);
295
296 while (!stack.isEmpty()) {
297 OsmPrimitive p = stack.pop();
298
299 if (result.contains(p)) {
300 continue;
301 }
302
303 result.add(p);
304
305 if (p instanceof Way) {
306 for (OsmPrimitive n: ((Way) p).getNodes()) {
307 stack.push(n);
308 }
309 } else if (p instanceof Relation) {
310 for (RelationMember rm: ((Relation) p).getMembers()) {
311 stack.push(rm.getMember());
312 }
313 }
314
315 for (OsmPrimitive ref: p.getReferrers()) {
316 stack.push(ref);
317 }
318 }
319
320 return result;
321 }
322
323 @Override
324 public void dataChanged(DataChangedEvent event) {
325 filterModel.executeFilters();
326 }
327
328 @Override
329 public void nodeMoved(NodeMovedEvent event) {
330 // Do nothing
331 }
332
333 @Override
334 public void otherDatasetChange(AbstractDatasetChangedEvent event) {
335 filterModel.executeFilters();
336 }
337
338 @Override
339 public void primitivesAdded(PrimitivesAddedEvent event) {
340 filterModel.executeFilters(event.getPrimitives());
341 }
342
343 @Override
344 public void primitivesRemoved(PrimitivesRemovedEvent event) {
345 filterModel.executeFilters();
346 }
347
348 @Override
349 public void relationMembersChanged(RelationMembersChangedEvent event) {
350 filterModel.executeFilters(getAffectedPrimitives(event.getPrimitives()));
351 }
352
353 @Override
354 public void tagsChanged(TagsChangedEvent event) {
355 filterModel.executeFilters(getAffectedPrimitives(event.getPrimitives()));
356 }
357
358 @Override
359 public void wayNodesChanged(WayNodesChangedEvent event) {
360 filterModel.executeFilters(getAffectedPrimitives(event.getPrimitives()));
361 }
362
363 /**
364 * This method is intendet for Plugins getting the filtermodel and using .addFilter() to
365 * add a new filter.
366 * @return the filtermodel
367 */
368 public FilterTableModel getFilterModel() {
369 return filterModel;
370 }
371
372 abstract class AbstractFilterAction extends AbstractAction implements MultikeyShortcutAction {
373
374 protected transient Filter lastFilter;
375
376 @Override
377 public void actionPerformed(ActionEvent e) {
378 throw new UnsupportedOperationException();
379 }
380
381 @Override
382 public List<MultikeyInfo> getMultikeyCombinations() {
383 List<MultikeyInfo> result = new ArrayList<>();
384
385 for (int i = 0; i < filterModel.getRowCount(); i++) {
386 Filter filter = filterModel.getFilter(i);
387 MultikeyInfo info = new MultikeyInfo(i, filter.text);
388 result.add(info);
389 }
390
391 return result;
392 }
393
394 protected boolean isLastFilterValid() {
395 return lastFilter != null && filterModel.getFilters().contains(lastFilter);
396 }
397
398 @Override
399 public MultikeyInfo getLastMultikeyAction() {
400 if (isLastFilterValid())
401 return new MultikeyInfo(-1, lastFilter.text);
402 else
403 return null;
404 }
405 }
406
407 private class EnableFilterAction extends AbstractFilterAction {
408
409 EnableFilterAction() {
410 putValue(SHORT_DESCRIPTION, tr("Enable filter"));
411 ENABLE_FILTER_SHORTCUT.setAccelerator(this);
412 }
413
414 @Override
415 public Shortcut getMultikeyShortcut() {
416 return ENABLE_FILTER_SHORTCUT;
417 }
418
419 @Override
420 public void executeMultikeyAction(int index, boolean repeatLastAction) {
421 if (index >= 0 && index < filterModel.getRowCount()) {
422 Filter filter = filterModel.getFilter(index);
423 filterModel.setValueAt(!filter.enable, index, FilterTableModel.COL_ENABLED);
424 lastFilter = filter;
425 } else if (repeatLastAction && isLastFilterValid()) {
426 filterModel.setValueAt(!lastFilter.enable, filterModel.getFilters().indexOf(lastFilter), FilterTableModel.COL_ENABLED);
427 }
428 }
429 }
430
431 private class HidingFilterAction extends AbstractFilterAction {
432
433 HidingFilterAction() {
434 putValue(SHORT_DESCRIPTION, tr("Hiding filter"));
435 HIDING_FILTER_SHORTCUT.setAccelerator(this);
436 }
437
438 @Override
439 public Shortcut getMultikeyShortcut() {
440 return HIDING_FILTER_SHORTCUT;
441 }
442
443 @Override
444 public void executeMultikeyAction(int index, boolean repeatLastAction) {
445 if (index >= 0 && index < filterModel.getRowCount()) {
446 Filter filter = filterModel.getFilter(index);
447 filterModel.setValueAt(!filter.hiding, index, FilterTableModel.COL_HIDING);
448 lastFilter = filter;
449 } else if (repeatLastAction && isLastFilterValid()) {
450 filterModel.setValueAt(!lastFilter.hiding, filterModel.getFilters().indexOf(lastFilter), FilterTableModel.COL_HIDING);
451 }
452 }
453 }
454}
Note: See TracBrowser for help on using the repository browser.