// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.gui.dialogs;
import static org.openstreetmap.josm.tools.I18n.tr;
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.event.ActionEvent;
import java.awt.event.KeyEvent;
import java.awt.event.MouseEvent;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import javax.swing.AbstractAction;
import javax.swing.AbstractListModel;
import javax.swing.DefaultListSelectionModel;
import javax.swing.FocusManager;
import javax.swing.JComponent;
import javax.swing.JList;
import javax.swing.JMenuItem;
import javax.swing.JPanel;
import javax.swing.JPopupMenu;
import javax.swing.JScrollPane;
import javax.swing.KeyStroke;
import javax.swing.ListSelectionModel;
import org.openstreetmap.josm.Main;
import org.openstreetmap.josm.actions.ExpertToggleAction;
import org.openstreetmap.josm.actions.relation.AddSelectionToRelations;
import org.openstreetmap.josm.actions.relation.DeleteRelationsAction;
import org.openstreetmap.josm.actions.relation.DownloadMembersAction;
import org.openstreetmap.josm.actions.relation.DownloadSelectedIncompleteMembersAction;
import org.openstreetmap.josm.actions.relation.DuplicateRelationAction;
import org.openstreetmap.josm.actions.relation.EditRelationAction;
import org.openstreetmap.josm.actions.relation.RecentRelationsAction;
import org.openstreetmap.josm.actions.relation.SelectMembersAction;
import org.openstreetmap.josm.actions.relation.SelectRelationAction;
import org.openstreetmap.josm.actions.search.SearchCompiler;
import org.openstreetmap.josm.data.osm.DataSet;
import org.openstreetmap.josm.data.osm.OsmPrimitive;
import org.openstreetmap.josm.data.osm.Relation;
import org.openstreetmap.josm.data.osm.event.AbstractDatasetChangedEvent;
import org.openstreetmap.josm.data.osm.event.DataChangedEvent;
import org.openstreetmap.josm.data.osm.event.DataSetListener;
import org.openstreetmap.josm.data.osm.event.DatasetEventManager;
import org.openstreetmap.josm.data.osm.event.DatasetEventManager.FireMode;
import org.openstreetmap.josm.data.osm.event.NodeMovedEvent;
import org.openstreetmap.josm.data.osm.event.PrimitivesAddedEvent;
import org.openstreetmap.josm.data.osm.event.PrimitivesRemovedEvent;
import org.openstreetmap.josm.data.osm.event.RelationMembersChangedEvent;
import org.openstreetmap.josm.data.osm.event.TagsChangedEvent;
import org.openstreetmap.josm.data.osm.event.WayNodesChangedEvent;
import org.openstreetmap.josm.gui.DefaultNameFormatter;
import org.openstreetmap.josm.gui.MapView;
import org.openstreetmap.josm.gui.NavigatableComponent;
import org.openstreetmap.josm.gui.OsmPrimitivRenderer;
import org.openstreetmap.josm.gui.PopupMenuHandler;
import org.openstreetmap.josm.gui.SideButton;
import org.openstreetmap.josm.gui.dialogs.relation.RelationEditor;
import org.openstreetmap.josm.gui.layer.Layer;
import org.openstreetmap.josm.gui.layer.LayerManager.LayerAddEvent;
import org.openstreetmap.josm.gui.layer.LayerManager.LayerChangeListener;
import org.openstreetmap.josm.gui.layer.LayerManager.LayerOrderChangeEvent;
import org.openstreetmap.josm.gui.layer.LayerManager.LayerRemoveEvent;
import org.openstreetmap.josm.gui.layer.MainLayerManager.ActiveLayerChangeEvent;
import org.openstreetmap.josm.gui.layer.MainLayerManager.ActiveLayerChangeListener;
import org.openstreetmap.josm.gui.layer.OsmDataLayer;
import org.openstreetmap.josm.gui.util.GuiHelper;
import org.openstreetmap.josm.gui.util.HighlightHelper;
import org.openstreetmap.josm.gui.widgets.CompileSearchTextDecorator;
import org.openstreetmap.josm.gui.widgets.DisableShortcutsOnFocusGainedTextField;
import org.openstreetmap.josm.gui.widgets.JosmTextField;
import org.openstreetmap.josm.gui.widgets.PopupMenuLauncher;
import org.openstreetmap.josm.tools.ImageProvider;
import org.openstreetmap.josm.tools.InputMapUtils;
import org.openstreetmap.josm.tools.Shortcut;
import org.openstreetmap.josm.tools.SubclassFilteredCollection;
/**
* A dialog showing all known relations, with buttons to add, edit, and delete them.
*
* We don't have such dialogs for nodes, segments, and ways, because those
* objects are visible on the map and can be selected there. Relations are not.
*/
public class RelationListDialog extends ToggleDialog
implements DataSetListener, NavigatableComponent.ZoomChangeListener, ExpertToggleAction.ExpertModeChangeListener {
/** The display list. */
private final JList<Relation> displaylist;
/** the list model used */
private final RelationListModel model;
private final NewAction newAction;
/** the popup menu and its handler */
private final JPopupMenu popupMenu = new JPopupMenu();
private final transient PopupMenuHandler popupMenuHandler = new PopupMenuHandler(popupMenu);
private final JosmTextField filter;
// Actions
/** the edit action */
private final EditRelationAction editAction = new EditRelationAction();
/** the delete action */
private final DeleteRelationsAction deleteRelationsAction = new DeleteRelationsAction();
/** the duplicate action */
private final DuplicateRelationAction duplicateAction = new DuplicateRelationAction();
private final DownloadMembersAction downloadMembersAction = new DownloadMembersAction();
private final DownloadSelectedIncompleteMembersAction downloadSelectedIncompleteMembersAction =
new DownloadSelectedIncompleteMembersAction();
private final SelectMembersAction selectMembersAction = new SelectMembersAction(false);
private final SelectMembersAction addMembersToSelectionAction = new SelectMembersAction(true);
private final SelectRelationAction selectRelationAction = new SelectRelationAction(false);
private final SelectRelationAction addRelationToSelectionAction = new SelectRelationAction(true);
/** add all selected primitives to the given relations */
private final AddSelectionToRelations addSelectionToRelations = new AddSelectionToRelations();
private transient JMenuItem addSelectionToRelationMenuItem;
private final transient HighlightHelper highlightHelper = new HighlightHelper();
private final boolean highlightEnabled = Main.pref.getBoolean("draw.target-highlight", true);
private final transient RecentRelationsAction recentRelationsAction;
/**
* Constructs <code>RelationListDialog</code>
*/
public RelationListDialog() {
super(tr("Relations"), "relationlist", tr("Open a list of all relations."),
Shortcut.registerShortcut("subwindow:relations", tr("Toggle: {0}", tr("Relations")),
KeyEvent.VK_R, Shortcut.ALT_SHIFT), 150, true);
// create the list of relations
//
DefaultListSelectionModel selectionModel = new DefaultListSelectionModel();
model = new RelationListModel(selectionModel);
displaylist = new JList<>(model);
displaylist.setSelectionModel(selectionModel);
displaylist.setCellRenderer(new NoTooltipOsmRenderer());
displaylist.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
displaylist.addMouseListener(new MouseEventHandler());
// the new action
//
newAction = new NewAction();
filter = setupFilter();
displaylist.addListSelectionListener(e -> {
if (!e.getValueIsAdjusting()) updateActionsRelationLists();
});
// Setup popup menu handler
setupPopupMenuHandler();
JPanel pane = new JPanel(new BorderLayout());
pane.add(filter, BorderLayout.NORTH);
pane.add(new JScrollPane(displaylist), BorderLayout.CENTER);
SideButton editButton = new SideButton(editAction, false);
recentRelationsAction = new RecentRelationsAction(editButton);
createLayout(pane, false, Arrays.asList(new SideButton[]{
new SideButton(newAction, false),
editButton,
new SideButton(duplicateAction, false),
new SideButton(deleteRelationsAction, false),
new SideButton(selectRelationAction, false)
}));
InputMapUtils.unassignCtrlShiftUpDown(displaylist, JComponent.WHEN_FOCUSED);
// Select relation on Enter
InputMapUtils.addEnterAction(displaylist, selectRelationAction);
// Edit relation on Ctrl-Enter
displaylist.getActionMap().put("edit", editAction);
displaylist.getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, KeyEvent.CTRL_MASK), "edit");
// Do not hide copy action because of default JList override (fix #9815)
displaylist.getActionMap().put("copy", Main.main.menu.copy);
displaylist.getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_C, GuiHelper.getMenuShortcutKeyMaskEx()), "copy");
updateActionsRelationLists();
}
@Override
public void destroy() {
recentRelationsAction.destroy();
model.clear();
super.destroy();
}
/**
* Enable the "recent relations" dropdown menu next to edit button.
*/
public void enableRecentRelations() {
recentRelationsAction.enableArrow();
}
// inform all actions about list of relations they need
private void updateActionsRelationLists() {
List<Relation> sel = model.getSelectedRelations();
popupMenuHandler.setPrimitives(sel);
Component focused = FocusManager.getCurrentKeyboardFocusManager().getFocusOwner();
//update highlights
if (highlightEnabled && focused == displaylist && Main.isDisplayingMapView() && highlightHelper.highlightOnly(sel)) {
Main.map.mapView.repaint();
}
}
@Override
public void showNotify() {
Main.getLayerManager().addLayerChangeListener(newAction);
Main.getLayerManager().addActiveLayerChangeListener(newAction);
MapView.addZoomChangeListener(this);
newAction.updateEnabledState();
DatasetEventManager.getInstance().addDatasetListener(this, FireMode.IN_EDT);
DataSet.addSelectionListener(addSelectionToRelations);
dataChanged(null);
ExpertToggleAction.addExpertModeChangeListener(this);
expertChanged(ExpertToggleAction.isExpert());
}
@Override
public void hideNotify() {
Main.getLayerManager().removeActiveLayerChangeListener(newAction);
Main.getLayerManager().removeLayerChangeListener(newAction);
MapView.removeZoomChangeListener(this);
DatasetEventManager.getInstance().removeDatasetListener(this);
DataSet.removeSelectionListener(addSelectionToRelations);
ExpertToggleAction.removeExpertModeChangeListener(this);
}
private void resetFilter() {
filter.setText(null);
}
/**
* Initializes the relation list dialog from a layer. If <code>layer</code> is null
* or if it isn't an {@link OsmDataLayer} the dialog is reset to an empty dialog.
* Otherwise it is initialized with the list of non-deleted and visible relations
* in the layer's dataset.
*
* @param layer the layer. May be null.
*/
protected void initFromLayer(Layer layer) {
if (!(layer instanceof OsmDataLayer)) {
model.setRelations(null);
return;
}
OsmDataLayer l = (OsmDataLayer) layer;
model.setRelations(l.data.getRelations());
model.updateTitle();
updateActionsRelationLists();
}
/**
* @return The selected relation in the list
*/
private Relation getSelected() {
if (model.getSize() == 1) {
displaylist.setSelectedIndex(0);
}
return displaylist.getSelectedValue();
}
/**
* Selects the relation <code>relation</code> in the list of relations.
*
* @param relation the relation
*/
public void selectRelation(Relation relation) {
selectRelations(Collections.singleton(relation));
}
/**
* Selects the relations in the list of relations.
* @param relations the relations to be selected
*/
public void selectRelations(Collection<Relation> relations) {
if (relations == null || relations.isEmpty()) {
model.setSelectedRelations(null);
} else {
model.setSelectedRelations(relations);
Integer i = model.getVisibleRelationIndex(relations.iterator().next());
if (i != null) {
// Not all relations have to be in the list
// (for example when the relation list is hidden, it's not updated with new relations)
displaylist.scrollRectToVisible(displaylist.getCellBounds(i, i));
}
}
}
private JosmTextField setupFilter() {
final JosmTextField f = new DisableShortcutsOnFocusGainedTextField();
f.setToolTipText(tr("Relation list filter"));
final CompileSearchTextDecorator decorator = CompileSearchTextDecorator.decorate(f);
f.addPropertyChangeListener("filter", evt -> model.setFilter(decorator.getMatch()));
return f;
}
static final class NoTooltipOsmRenderer extends OsmPrimitivRenderer {
@Override
protected String getComponentToolTipText(OsmPrimitive value) {
// Don't show the default tooltip in the relation list
return null;
}
}
class MouseEventHandler extends PopupMenuLauncher {
MouseEventHandler() {
super(popupMenu);
}
@Override
public void mouseExited(MouseEvent me) {
if (highlightEnabled) highlightHelper.clear();
}
protected void setCurrentRelationAsSelection() {
Main.getLayerManager().getEditDataSet().setSelected(displaylist.getSelectedValue());
}
protected void editCurrentRelation() {
EditRelationAction.launchEditor(getSelected());
}
@Override
public void mouseClicked(MouseEvent e) {
if (Main.getLayerManager().getEditLayer() == null) return;
if (isDoubleClick(e)) {
if (e.isControlDown()) {
editCurrentRelation();
} else {
setCurrentRelationAsSelection();
}
}
}
}
/**
* The action for creating a new relation.
*/
static class NewAction extends AbstractAction implements LayerChangeListener, ActiveLayerChangeListener {
NewAction() {
putValue(SHORT_DESCRIPTION, tr("Create a new relation"));
putValue(NAME, tr("New"));
new ImageProvider("dialogs", "addrelation").getResource().attachImageIcon(this, true);
updateEnabledState();
}
public void run() {
RelationEditor.getEditor(Main.getLayerManager().getEditLayer(), null, null).setVisible(true);
}
@Override
public void actionPerformed(ActionEvent e) {
run();
}
protected void updateEnabledState() {
setEnabled(Main.getLayerManager().getEditLayer() != null);
}
@Override
public void activeOrEditLayerChanged(ActiveLayerChangeEvent e) {
updateEnabledState();
}
@Override
public void layerAdded(LayerAddEvent e) {
updateEnabledState();
}
@Override
public void layerRemoving(LayerRemoveEvent e) {
updateEnabledState();
}
@Override
public void layerOrderChanged(LayerOrderChangeEvent e) {
// Do nothing
}
}
/**
* The list model for the list of relations displayed in the relation list dialog.
*/
private class RelationListModel extends AbstractListModel<Relation> {
private final transient List<Relation> relations = new ArrayList<>();
private transient List<Relation> filteredRelations;
private final DefaultListSelectionModel selectionModel;
private transient SearchCompiler.Match filter;
RelationListModel(DefaultListSelectionModel selectionModel) {
this.selectionModel = selectionModel;
}
/**
* Clears the model.
*/
public void clear() {
relations.clear();
if (filteredRelations != null)
filteredRelations.clear();
filter = null;
}
/**
* Sorts the model using {@link DefaultNameFormatter} relation comparator.
*/
public void sort() {
relations.sort(DefaultNameFormatter.getInstance().getRelationComparator());
}
private boolean isValid(Relation r) {
return !r.isDeleted() && r.isVisible() && !r.isIncomplete();
}
public void setRelations(Collection<Relation> relations) {
List<Relation> sel = getSelectedRelations();
this.relations.clear();
this.filteredRelations = null;
if (relations == null) {
selectionModel.clearSelection();
fireContentsChanged(this, 0, getSize());
return;
}
for (Relation r: relations) {
if (isValid(r)) {
this.relations.add(r);
}
}
sort();
updateFilteredRelations();
fireIntervalAdded(this, 0, getSize());
setSelectedRelations(sel);
}
/**
* Add all relations in <code>addedPrimitives</code> to the model for the
* relation list dialog
*
* @param addedPrimitives the collection of added primitives. May include nodes,
* ways, and relations.
*/
public void addRelations(Collection<? extends OsmPrimitive> addedPrimitives) {
boolean added = false;
for (OsmPrimitive p: addedPrimitives) {
if (!(p instanceof Relation)) {
continue;
}
Relation r = (Relation) p;
if (relations.contains(r)) {
continue;
}
if (isValid(r)) {
relations.add(r);
added = true;
}
}
if (added) {
List<Relation> sel = getSelectedRelations();
sort();
updateFilteredRelations();
fireIntervalAdded(this, 0, getSize());
setSelectedRelations(sel);
}
}
/**
* Removes all relations in <code>removedPrimitives</code> from the model
*
* @param removedPrimitives the removed primitives. May include nodes, ways,
* and relations
*/
public void removeRelations(Collection<? extends OsmPrimitive> removedPrimitives) {
if (removedPrimitives == null) return;
// extract the removed relations
//
Set<Relation> removedRelations = new HashSet<>();
for (OsmPrimitive p: removedPrimitives) {
if (!(p instanceof Relation)) {
continue;
}
removedRelations.add((Relation) p);
}
if (removedRelations.isEmpty())
return;
int size = relations.size();
relations.removeAll(removedRelations);
if (filteredRelations != null) {
filteredRelations.removeAll(removedRelations);
}
if (size != relations.size()) {
List<Relation> sel = getSelectedRelations();
sort();
fireContentsChanged(this, 0, getSize());
setSelectedRelations(sel);
}
}
private void updateFilteredRelations() {
if (filter != null) {
filteredRelations = new ArrayList<>(SubclassFilteredCollection.filter(relations, filter::match));
} else if (filteredRelations != null) {
filteredRelations = null;
}
}
public void setFilter(final SearchCompiler.Match filter) {
this.filter = filter;
updateFilteredRelations();
List<Relation> sel = getSelectedRelations();
fireContentsChanged(this, 0, getSize());
setSelectedRelations(sel);
updateTitle();
}
private List<Relation> getVisibleRelations() {
return filteredRelations == null ? relations : filteredRelations;
}
private Relation getVisibleRelation(int index) {
if (index < 0 || index >= getVisibleRelations().size()) return null;
return getVisibleRelations().get(index);
}
@Override
public Relation getElementAt(int index) {
return getVisibleRelation(index);
}
@Override
public int getSize() {
return getVisibleRelations().size();
}
/**
* Replies the list of selected relations. Empty list,
* if there are no selected relations.
*
* @return the list of selected, non-new relations.
*/
public List<Relation> getSelectedRelations() {
List<Relation> ret = new ArrayList<>();
for (int i = 0; i < getSize(); i++) {
if (!selectionModel.isSelectedIndex(i)) {
continue;
}
ret.add(getVisibleRelation(i));
}
return ret;
}
/**
* Sets the selected relations.
*
* @param sel the list of selected relations
*/
public void setSelectedRelations(Collection<Relation> sel) {
selectionModel.setValueIsAdjusting(true);
selectionModel.clearSelection();
if (sel != null && !sel.isEmpty()) {
if (!getVisibleRelations().containsAll(sel)) {
resetFilter();
}
for (Relation r: sel) {
Integer i = getVisibleRelationIndex(r);
if (i != null) {
selectionModel.addSelectionInterval(i, i);
}
}
}
selectionModel.setValueIsAdjusting(false);
}
private Integer getVisibleRelationIndex(Relation rel) {
int i = getVisibleRelations().indexOf(rel);
if (i < 0)
return null;
return i;
}
public void updateTitle() {
if (!relations.isEmpty() && relations.size() != getSize()) {
RelationListDialog.this.setTitle(tr("Relations: {0}/{1}", getSize(), relations.size()));
} else if (getSize() > 0) {
RelationListDialog.this.setTitle(tr("Relations: {0}", getSize()));
} else {
RelationListDialog.this.setTitle(tr("Relations"));
}
}
}
private void setupPopupMenuHandler() {
// -- select action
popupMenuHandler.addAction(selectRelationAction);
popupMenuHandler.addAction(addRelationToSelectionAction);
// -- select members action
popupMenuHandler.addAction(selectMembersAction);
popupMenuHandler.addAction(addMembersToSelectionAction);
popupMenuHandler.addSeparator();
// -- download members action
popupMenuHandler.addAction(downloadMembersAction);
// -- download incomplete members action
popupMenuHandler.addAction(downloadSelectedIncompleteMembersAction);
popupMenuHandler.addSeparator();
popupMenuHandler.addAction(editAction).setVisible(false);
popupMenuHandler.addAction(duplicateAction).setVisible(false);
popupMenuHandler.addAction(deleteRelationsAction).setVisible(false);
addSelectionToRelationMenuItem = popupMenuHandler.addAction(addSelectionToRelations);
}
/* ---------------------------------------------------------------------------------- */
/* Methods that can be called from plugins */
/* ---------------------------------------------------------------------------------- */
/**
* Replies the popup menu handler.
* @return The popup menu handler
*/
public PopupMenuHandler getPopupMenuHandler() {
return popupMenuHandler;
}
/**
* Replies the list of selected relations. Empty list, if there are no selected relations.
* @return the list of selected, non-new relations.
*/
public Collection<Relation> getSelectedRelations() {
return model.getSelectedRelations();
}
/* ---------------------------------------------------------------------------------- */
/* DataSetListener */
/* ---------------------------------------------------------------------------------- */
@Override
public void nodeMoved(NodeMovedEvent event) {
/* irrelevant in this context */
}
@Override
public void wayNodesChanged(WayNodesChangedEvent event) {
/* irrelevant in this context */
}
@Override
public void primitivesAdded(final PrimitivesAddedEvent event) {
model.addRelations(event.getPrimitives());
model.updateTitle();
}
@Override
public void primitivesRemoved(final PrimitivesRemovedEvent event) {
model.removeRelations(event.getPrimitives());
model.updateTitle();
}
@Override
public void relationMembersChanged(final RelationMembersChangedEvent event) {
List<Relation> sel = model.getSelectedRelations();
model.sort();
model.setSelectedRelations(sel);
displaylist.repaint();
}
@Override
public void tagsChanged(TagsChangedEvent event) {
OsmPrimitive prim = event.getPrimitive();
if (!(prim instanceof Relation))
return;
// trigger a sort of the relation list because the display name may have changed
//
List<Relation> sel = model.getSelectedRelations();
model.sort();
model.setSelectedRelations(sel);
displaylist.repaint();
}
@Override
public void dataChanged(DataChangedEvent event) {
initFromLayer(Main.getLayerManager().getEditLayer());
}
@Override
public void otherDatasetChange(AbstractDatasetChangedEvent event) {
/* ignore */
}
@Override
public void zoomChanged() {
// re-filter relations
if (model.filter != null) {
model.setFilter(model.filter);
}
}
@Override
public void expertChanged(boolean isExpert) {
addSelectionToRelationMenuItem.setVisible(isExpert);
}
}