001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.gui.dialogs.relation;
003
004import static org.openstreetmap.josm.tools.I18n.tr;
005
006import java.awt.Dimension;
007import java.awt.GraphicsEnvironment;
008import java.awt.event.ActionEvent;
009import java.util.Collection;
010import java.util.EnumSet;
011import java.util.Set;
012import java.util.stream.Collectors;
013
014import javax.swing.AbstractAction;
015import javax.swing.DropMode;
016import javax.swing.JComponent;
017import javax.swing.JPopupMenu;
018import javax.swing.JTable;
019import javax.swing.ListSelectionModel;
020import javax.swing.SwingUtilities;
021import javax.swing.event.ListSelectionEvent;
022import javax.swing.event.ListSelectionListener;
023
024import org.openstreetmap.josm.actions.AbstractShowHistoryAction;
025import org.openstreetmap.josm.actions.AutoScaleAction;
026import org.openstreetmap.josm.actions.AutoScaleAction.AutoScaleMode;
027import org.openstreetmap.josm.actions.HistoryInfoAction;
028import org.openstreetmap.josm.actions.ZoomToAction;
029import org.openstreetmap.josm.data.osm.IPrimitive;
030import org.openstreetmap.josm.data.osm.OsmPrimitive;
031import org.openstreetmap.josm.data.osm.Relation;
032import org.openstreetmap.josm.data.osm.RelationMember;
033import org.openstreetmap.josm.data.osm.Way;
034import org.openstreetmap.josm.gui.MainApplication;
035import org.openstreetmap.josm.gui.dialogs.relation.sort.WayConnectionType;
036import org.openstreetmap.josm.gui.dialogs.relation.sort.WayConnectionType.Direction;
037import org.openstreetmap.josm.gui.history.HistoryBrowserDialogManager;
038import org.openstreetmap.josm.gui.layer.LayerManager.LayerAddEvent;
039import org.openstreetmap.josm.gui.layer.LayerManager.LayerChangeListener;
040import org.openstreetmap.josm.gui.layer.LayerManager.LayerOrderChangeEvent;
041import org.openstreetmap.josm.gui.layer.LayerManager.LayerRemoveEvent;
042import org.openstreetmap.josm.gui.layer.MainLayerManager.ActiveLayerChangeEvent;
043import org.openstreetmap.josm.gui.layer.MainLayerManager.ActiveLayerChangeListener;
044import org.openstreetmap.josm.gui.layer.OsmDataLayer;
045import org.openstreetmap.josm.gui.tagging.ac.AutoCompletionManager;
046import org.openstreetmap.josm.gui.util.HighlightHelper;
047import org.openstreetmap.josm.gui.widgets.OsmPrimitivesTable;
048import org.openstreetmap.josm.spi.preferences.Config;
049
050/**
051 * The table of members a selected relation has.
052 */
053public class MemberTable extends OsmPrimitivesTable implements IMemberModelListener {
054
055    /** the additional actions in popup menu */
056    private ZoomToGapAction zoomToGap;
057    private final transient HighlightHelper highlightHelper = new HighlightHelper();
058    private boolean highlightEnabled;
059
060    /**
061     * constructor for relation member table
062     *
063     * @param layer the data layer of the relation. Must not be null
064     * @param relation the relation. Can be null
065     * @param model the table model
066     */
067    public MemberTable(OsmDataLayer layer, Relation relation, MemberTableModel model) {
068        super(model, new MemberTableColumnModel(AutoCompletionManager.of(layer.data), relation), model.getSelectionModel());
069        setLayer(layer);
070        model.addMemberModelListener(this);
071
072        MemberRoleCellEditor ce = (MemberRoleCellEditor) getColumnModel().getColumn(0).getCellEditor();
073        setRowHeight(ce.getEditor().getPreferredSize().height);
074        setAutoResizeMode(JTable.AUTO_RESIZE_ALL_COLUMNS);
075        setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
076        putClientProperty("terminateEditOnFocusLost", Boolean.TRUE);
077        HistoryInfoAction historyAction = MainApplication.getMenu().historyinfo;
078        getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(historyAction.getShortcut().getKeyStroke(), "historyAction");
079        getActionMap().put("historyAction", historyAction);
080
081        installCustomNavigation(0);
082        initHighlighting();
083
084        if (!GraphicsEnvironment.isHeadless()) {
085            setTransferHandler(new MemberTransferHandler());
086            setFillsViewportHeight(true); // allow drop on empty table
087            if (!GraphicsEnvironment.isHeadless()) {
088                setDragEnabled(true);
089            }
090            setDropMode(DropMode.INSERT_ROWS);
091        }
092    }
093
094    @Override
095    protected ZoomToAction buildZoomToAction() {
096        return new ZoomToAction(this);
097    }
098
099    @Override
100    protected JPopupMenu buildPopupMenu() {
101        JPopupMenu menu = super.buildPopupMenu();
102        zoomToGap = new ZoomToGapAction();
103        registerListeners();
104        menu.addSeparator();
105        getSelectionModel().addListSelectionListener(zoomToGap);
106        menu.add(zoomToGap);
107        menu.addSeparator();
108        menu.add(new SelectPreviousGapAction());
109        menu.add(new SelectNextGapAction());
110        menu.add(new AbstractShowHistoryAction() {
111            @Override
112            public void actionPerformed(ActionEvent ae) {
113                Collection<OsmPrimitive> sel = getMemberTableModel().getSelectedChildPrimitives();
114                HistoryBrowserDialogManager.getInstance().showHistory(sel);
115            }
116        });
117        return menu;
118    }
119
120    @Override
121    public Dimension getPreferredSize() {
122        return getPreferredFullWidthSize();
123    }
124
125    @Override
126    public void makeMemberVisible(int index) {
127        scrollRectToVisible(getCellRect(index, 0, true));
128    }
129
130    private transient ListSelectionListener highlighterListener = lse -> {
131        if (MainApplication.isDisplayingMapView()) {
132            Collection<RelationMember> sel = getMemberTableModel().getSelectedMembers();
133            final Set<OsmPrimitive> toHighlight = sel.stream()
134                    .map(RelationMember::getMember)
135                    .filter(IPrimitive::isUsable)
136                    .collect(Collectors.toSet());
137            SwingUtilities.invokeLater(() -> {
138                if (MainApplication.isDisplayingMapView() && highlightHelper.highlightOnly(toHighlight)) {
139                    MainApplication.getMap().mapView.repaint();
140                }
141            });
142        }
143    };
144
145    private void initHighlighting() {
146        highlightEnabled = Config.getPref().getBoolean("draw.target-highlight", true);
147        if (!highlightEnabled) return;
148        getMemberTableModel().getSelectionModel().addListSelectionListener(highlighterListener);
149        clearAllHighlighted();
150    }
151
152    @Override
153    public void registerListeners() {
154        MainApplication.getLayerManager().addLayerChangeListener(zoomToGap);
155        MainApplication.getLayerManager().addActiveLayerChangeListener(zoomToGap);
156        super.registerListeners();
157    }
158
159    @Override
160    public void unregisterListeners() {
161        super.unregisterListeners();
162        MainApplication.getLayerManager().removeLayerChangeListener(zoomToGap);
163        MainApplication.getLayerManager().removeActiveLayerChangeListener(zoomToGap);
164    }
165
166    /**
167     * Stops highlighting of selected objects.
168     */
169    public void stopHighlighting() {
170        if (highlighterListener == null) return;
171        if (!highlightEnabled) return;
172        getMemberTableModel().getSelectionModel().removeListSelectionListener(highlighterListener);
173        highlighterListener = null;
174        clearAllHighlighted();
175    }
176
177    private static void clearAllHighlighted() {
178        if (MainApplication.isDisplayingMapView()) {
179            HighlightHelper.clearAllHighlighted();
180            MainApplication.getMap().mapView.repaint();
181        }
182    }
183
184    private class SelectPreviousGapAction extends AbstractAction {
185
186        SelectPreviousGapAction() {
187            putValue(NAME, tr("Select previous Gap"));
188            putValue(SHORT_DESCRIPTION, tr("Select the previous relation member which gives rise to a gap"));
189        }
190
191        @Override
192        public void actionPerformed(ActionEvent e) {
193            int i = getSelectedRow() - 1;
194            while (i >= 0 && getMemberTableModel().getWayConnection(i).linkPrev) {
195                i--;
196            }
197            if (i >= 0) {
198                getSelectionModel().setSelectionInterval(i, i);
199                getMemberTableModel().fireMakeMemberVisible(i);
200            }
201        }
202    }
203
204    private class SelectNextGapAction extends AbstractAction {
205
206        SelectNextGapAction() {
207            putValue(NAME, tr("Select next Gap"));
208            putValue(SHORT_DESCRIPTION, tr("Select the next relation member which gives rise to a gap"));
209        }
210
211        @Override
212        public void actionPerformed(ActionEvent e) {
213            int i = getSelectedRow() + 1;
214            while (i < getRowCount() && getMemberTableModel().getWayConnection(i).linkNext) {
215                i++;
216            }
217            if (i < getRowCount()) {
218                getSelectionModel().setSelectionInterval(i, i);
219                getMemberTableModel().fireMakeMemberVisible(i);
220            }
221        }
222    }
223
224    private class ZoomToGapAction extends AbstractAction implements LayerChangeListener, ActiveLayerChangeListener, ListSelectionListener {
225
226        /**
227         * Constructs a new {@code ZoomToGapAction}.
228         */
229        ZoomToGapAction() {
230            putValue(NAME, tr("Zoom to Gap"));
231            putValue(SHORT_DESCRIPTION, tr("Zoom to the gap in the way sequence"));
232            updateEnabledState();
233        }
234
235        private WayConnectionType getConnectionType() {
236            return getMemberTableModel().getWayConnection(getSelectedRows()[0]);
237        }
238
239        private final Collection<Direction> connectionTypesOfInterest = EnumSet.of(
240                WayConnectionType.Direction.FORWARD, WayConnectionType.Direction.BACKWARD);
241
242        private boolean hasGap() {
243            WayConnectionType connectionType = getConnectionType();
244            return connectionTypesOfInterest.contains(connectionType.direction)
245                    && !(connectionType.linkNext && connectionType.linkPrev);
246        }
247
248        @Override
249        public void actionPerformed(ActionEvent e) {
250            WayConnectionType connectionType = getConnectionType();
251            Way way = (Way) getMemberTableModel().getReferredPrimitive(getSelectedRows()[0]);
252            if (!connectionType.linkPrev) {
253                getLayer().data.setSelected(WayConnectionType.Direction.FORWARD == connectionType.direction
254                        ? way.firstNode() : way.lastNode());
255                AutoScaleAction.autoScale(AutoScaleMode.SELECTION);
256            } else if (!connectionType.linkNext) {
257                getLayer().data.setSelected(WayConnectionType.Direction.FORWARD == connectionType.direction
258                        ? way.lastNode() : way.firstNode());
259                AutoScaleAction.autoScale(AutoScaleMode.SELECTION);
260            }
261        }
262
263        private void updateEnabledState() {
264            setEnabled(MainApplication.getLayerManager().getEditLayer() == getLayer()
265                    && getSelectedRowCount() == 1
266                    && hasGap());
267        }
268
269        @Override
270        public void valueChanged(ListSelectionEvent e) {
271            updateEnabledState();
272        }
273
274        @Override
275        public void activeOrEditLayerChanged(ActiveLayerChangeEvent e) {
276            updateEnabledState();
277        }
278
279        @Override
280        public void layerAdded(LayerAddEvent e) {
281            updateEnabledState();
282        }
283
284        @Override
285        public void layerRemoving(LayerRemoveEvent e) {
286            updateEnabledState();
287        }
288
289        @Override
290        public void layerOrderChanged(LayerOrderChangeEvent e) {
291            // Do nothing
292        }
293    }
294
295    protected MemberTableModel getMemberTableModel() {
296        return (MemberTableModel) getModel();
297    }
298}