// License: GPL. For details, see LICENSE file. package org.openstreetmap.josm.gui; import static org.openstreetmap.josm.tools.I18n.tr; import java.awt.BorderLayout; import java.awt.Component; import java.awt.Container; import java.awt.Dimension; import java.awt.Font; import java.awt.GridBagLayout; import java.awt.Rectangle; import java.awt.event.ActionEvent; import java.awt.event.KeyEvent; import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.concurrent.CopyOnWriteArrayList; import javax.swing.AbstractAction; import javax.swing.AbstractButton; import javax.swing.Action; import javax.swing.BorderFactory; import javax.swing.BoxLayout; import javax.swing.ButtonGroup; import javax.swing.ImageIcon; import javax.swing.JButton; import javax.swing.JCheckBoxMenuItem; import javax.swing.JComponent; import javax.swing.JPanel; import javax.swing.JPopupMenu; import javax.swing.JSplitPane; import javax.swing.JToggleButton; import javax.swing.JToolBar; import javax.swing.KeyStroke; import javax.swing.border.Border; import javax.swing.event.PopupMenuEvent; import javax.swing.event.PopupMenuListener; import javax.swing.plaf.basic.BasicSplitPaneDivider; import javax.swing.plaf.basic.BasicSplitPaneUI; import org.openstreetmap.josm.actions.LassoModeAction; import org.openstreetmap.josm.actions.mapmode.DeleteAction; import org.openstreetmap.josm.actions.mapmode.DrawAction; import org.openstreetmap.josm.actions.mapmode.ExtrudeAction; import org.openstreetmap.josm.actions.mapmode.ImproveWayAccuracyAction; import org.openstreetmap.josm.actions.mapmode.MapMode; import org.openstreetmap.josm.actions.mapmode.ParallelWayAction; import org.openstreetmap.josm.actions.mapmode.SelectAction; import org.openstreetmap.josm.actions.mapmode.ZoomAction; import org.openstreetmap.josm.spi.preferences.PreferenceChangedListener; import org.openstreetmap.josm.data.ViewportData; import org.openstreetmap.josm.data.preferences.BooleanProperty; import org.openstreetmap.josm.data.preferences.IntegerProperty; import org.openstreetmap.josm.gui.dialogs.ChangesetDialog; import org.openstreetmap.josm.gui.dialogs.CommandStackDialog; import org.openstreetmap.josm.gui.dialogs.ConflictDialog; import org.openstreetmap.josm.gui.dialogs.DialogsPanel; import org.openstreetmap.josm.gui.dialogs.FilterDialog; import org.openstreetmap.josm.gui.dialogs.LayerListDialog; import org.openstreetmap.josm.gui.dialogs.MapPaintDialog; import org.openstreetmap.josm.gui.dialogs.MinimapDialog; import org.openstreetmap.josm.gui.dialogs.NotesDialog; import org.openstreetmap.josm.gui.dialogs.RelationListDialog; import org.openstreetmap.josm.gui.dialogs.SelectionListDialog; import org.openstreetmap.josm.gui.dialogs.ToggleDialog; import org.openstreetmap.josm.gui.dialogs.UserListDialog; import org.openstreetmap.josm.gui.dialogs.ValidatorDialog; import org.openstreetmap.josm.gui.dialogs.properties.PropertiesDialog; import org.openstreetmap.josm.gui.layer.Layer; import org.openstreetmap.josm.gui.layer.LayerManager; 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.util.AdvancedKeyPressDetector; import org.openstreetmap.josm.spi.preferences.Config; import org.openstreetmap.josm.tools.Destroyable; import org.openstreetmap.josm.tools.GBC; import org.openstreetmap.josm.tools.ImageProvider; import org.openstreetmap.josm.tools.Shortcut; /** * One Map frame with one dataset behind. This is the container gui class whose * display can be set to the different views. * * @author imi */ public class MapFrame extends JPanel implements Destroyable, ActiveLayerChangeListener, LayerChangeListener { /** * Default width of the toggle dialog area. */ public static final int DEF_TOGGLE_DLG_WIDTH = 330; private static final IntegerProperty TOGGLE_DIALOGS_WIDTH = new IntegerProperty("toggleDialogs.width", DEF_TOGGLE_DLG_WIDTH); /** * Do not require to switch modes (potlatch style workflow) for drawing/selecting map modes. * @since 12347 */ public static final BooleanProperty MODELESS = new BooleanProperty("modeless", false); /** * The current mode, this frame operates. */ public MapMode mapMode; /** * The view control displayed. *
* Accessing this is discouraged. Use the {@link LayerManager} to access map data.
*/
public final MapView mapView;
/**
* This object allows to detect key press and release events
*/
public final transient AdvancedKeyPressDetector keyDetector = new AdvancedKeyPressDetector();
/**
* The toolbar with the action icons. To add new toggle dialog buttons,
* use addToggleDialog, to add a new map mode button use addMapMode.
*/
private JComponent sideToolBar = new JToolBar(JToolBar.VERTICAL);
private final ButtonGroup toolBarActionsGroup = new ButtonGroup();
private final JToolBar toolBarActions = new JToolBar(JToolBar.VERTICAL);
private final JToolBar toolBarToggle = new JToolBar(JToolBar.VERTICAL);
private final Listtrue
if it is selected
*/
public boolean selectSelectTool(boolean onlyIfModeless) {
if (onlyIfModeless && !MODELESS.get())
return false;
return selectMapMode(mapModeSelect);
}
/**
* Enables the draw tool
* @param onlyIfModeless Only enable if modeless mode is active
* @return true
if it is selected
*/
public boolean selectDrawTool(boolean onlyIfModeless) {
if (onlyIfModeless && !MODELESS.get())
return false;
return selectMapMode(mapModeDraw);
}
/**
* Enables the zoom tool
* @param onlyIfModeless Only enable if modeless mode is active
* @return true
if it is selected
*/
public boolean selectZoomTool(boolean onlyIfModeless) {
if (onlyIfModeless && !MODELESS.get())
return false;
return selectMapMode(mapModeZoom);
}
/**
* Called as some kind of destructor when the last layer has been removed.
* Delegates the call to all Destroyables within this component (e.g. MapModes)
*/
@Override
public void destroy() {
MainApplication.getLayerManager().removeLayerChangeListener(this);
MainApplication.getLayerManager().removeActiveLayerChangeListener(this);
dialogsPanel.destroy();
Config.getPref().removePreferenceChangeListener(sidetoolbarPreferencesChangedListener);
for (int i = 0; i < toolBarActions.getComponentCount(); ++i) {
if (toolBarActions.getComponent(i) instanceof Destroyable) {
((Destroyable) toolBarActions.getComponent(i)).destroy();
}
}
for (int i = 0; i < toolBarToggle.getComponentCount(); ++i) {
if (toolBarToggle.getComponent(i) instanceof Destroyable) {
((Destroyable) toolBarToggle.getComponent(i)).destroy();
}
}
statusLine.destroy();
mapView.destroy();
keyDetector.unregister();
}
/**
* Gets the action of the default (first) map mode
* @return That action
*/
public Action getDefaultButtonAction() {
return ((AbstractButton) toolBarActions.getComponent(0)).getAction();
}
/**
* Open all ToggleDialogs that have their preferences property set. Close all others.
*/
public void initializeDialogsPane() {
dialogsPanel.initialize(allDialogs);
}
/**
* Adds a new toggle dialog to the left button list. It is displayed in expert and normal mode
* @param dlg The dialog
* @return The button
*/
public IconToggleButton addToggleDialog(final ToggleDialog dlg) {
return addToggleDialog(dlg, false);
}
/**
* Call this to add new toggle dialogs to the left button-list
* @param dlg The toggle dialog. It must not be in the list already.
* @param isExpert {@code true} if it's reserved to expert mode
* @return button allowing to toggle the dialog
*/
public IconToggleButton addToggleDialog(final ToggleDialog dlg, boolean isExpert) {
final IconToggleButton button = new IconToggleButton(dlg.getToggleAction(), isExpert);
button.setShowHideButtonListener(dlg);
button.setInheritsPopupMenu(true);
dlg.setButton(button);
toolBarToggle.add(button);
allDialogs.add(dlg);
allDialogButtons.add(button);
button.applyButtonHiddenPreferences();
if (dialogsPanel.initialized) {
dialogsPanel.add(dlg);
}
return button;
}
/**
* Call this to remove existing toggle dialog from the left button-list
* @param dlg The toggle dialog. It must be already in the list.
* @since 10851
*/
public void removeToggleDialog(final ToggleDialog dlg) {
final JToggleButton button = dlg.getButton();
if (button != null) {
allDialogButtons.remove(button);
toolBarToggle.remove(button);
}
dialogsPanel.remove(dlg);
allDialogs.remove(dlg);
}
/**
* Adds a new map mode button
* @param b The map mode button with a {@link MapMode} action.
*/
public void addMapMode(IconToggleButton b) {
if (!(b.getAction() instanceof MapMode))
throw new IllegalArgumentException("MapMode action must be subclass of MapMode");
allMapModeButtons.add(b);
toolBarActionsGroup.add(b);
toolBarActions.add(b);
b.applyButtonHiddenPreferences();
b.setInheritsPopupMenu(true);
}
/**
* Fires an property changed event "visible".
* @param aFlag {@code true} if display should be visible
*/
@Override public void setVisible(boolean aFlag) {
boolean old = isVisible();
super.setVisible(aFlag);
if (old != aFlag) {
firePropertyChange("visible", old, aFlag);
}
}
/**
* Change the operating map mode for the view. Will call unregister on the
* old MapMode and register on the new one. Now this function also verifies
* if new map mode is correct mode for current layer and does not change mode
* in such cases.
* @param newMapMode The new mode to set.
* @return {@code true} if mode is really selected
*/
public boolean selectMapMode(MapMode newMapMode) {
return selectMapMode(newMapMode, mapView.getLayerManager().getActiveLayer());
}
/**
* Another version of the selectMapMode for changing layer action.
* Pass newly selected layer to this method.
* @param newMapMode The new mode to set.
* @param newLayer newly selected layer
* @return {@code true} if mode is really selected
*/
public boolean selectMapMode(MapMode newMapMode, Layer newLayer) {
if (newMapMode == null || !newMapMode.layerIsSupported(newLayer))
return false;
MapMode oldMapMode = this.mapMode;
if (newMapMode == oldMapMode)
return true;
if (oldMapMode != null) {
oldMapMode.exitMode();
}
this.mapMode = newMapMode;
newMapMode.enterMode();
lastMapMode.put(newLayer, newMapMode);
fireMapModeChanged(oldMapMode, newMapMode);
return true;
}
/**
* Fill the given panel by adding all necessary components to the different
* locations.
*
* @param panel The container to fill. Must have a BorderLayout.
*/
public void fillPanel(Container panel) {
panel.add(this, BorderLayout.CENTER);
/**
* sideToolBar: add map modes icons
*/
if (Config.getPref().getBoolean("sidetoolbar.mapmodes.visible", true)) {
toolBarActions.setAlignmentX(0.5f);
toolBarActions.setBorder(null);
toolBarActions.setInheritsPopupMenu(true);
sideToolBar.add(toolBarActions);
listAllMapModesButton.setAlignmentX(0.5f);
listAllMapModesButton.setBorder(null);
listAllMapModesButton.setFont(listAllMapModesButton.getFont().deriveFont(Font.PLAIN));
listAllMapModesButton.setInheritsPopupMenu(true);
sideToolBar.add(listAllMapModesButton);
}
/**
* sideToolBar: add toggle dialogs icons
*/
if (Config.getPref().getBoolean("sidetoolbar.toggledialogs.visible", true)) {
((JToolBar) sideToolBar).addSeparator(new Dimension(0, 18));
toolBarToggle.setAlignmentX(0.5f);
toolBarToggle.setBorder(null);
toolBarToggle.setInheritsPopupMenu(true);
sideToolBar.add(toolBarToggle);
listAllToggleDialogsButton.setAlignmentX(0.5f);
listAllToggleDialogsButton.setBorder(null);
listAllToggleDialogsButton.setFont(listAllToggleDialogsButton.getFont().deriveFont(Font.PLAIN));
listAllToggleDialogsButton.setInheritsPopupMenu(true);
sideToolBar.add(listAllToggleDialogsButton);
}
/**
* sideToolBar: add dynamic popup menu
*/
sideToolBar.setComponentPopupMenu(new SideToolbarPopupMenu());
((JToolBar) sideToolBar).setFloatable(false);
sideToolBar.setBorder(BorderFactory.createEmptyBorder(0, 1, 0, 1));
/**
* sideToolBar: decide scroll- and visibility
*/
if (Config.getPref().getBoolean("sidetoolbar.scrollable", true)) {
final ScrollViewport svp = new ScrollViewport(sideToolBar, ScrollViewport.VERTICAL_DIRECTION);
sideToolBar = svp;
}
sideToolBar.setVisible(Config.getPref().getBoolean("sidetoolbar.visible", true));
sidetoolbarPreferencesChangedListener = e -> {
if ("sidetoolbar.visible".equals(e.getKey())) {
sideToolBar.setVisible(Config.getPref().getBoolean("sidetoolbar.visible"));
}
};
Config.getPref().addPreferenceChangeListener(sidetoolbarPreferencesChangedListener);
/**
* sideToolBar: add it to the panel
*/
panel.add(sideToolBar, BorderLayout.WEST);
/**
* statusLine: add to panel
*/
if (statusLine != null && Config.getPref().getBoolean("statusline.visible", true)) {
panel.add(statusLine, BorderLayout.SOUTH);
}
}
static final class NoBorderSplitPaneUI extends BasicSplitPaneUI {
static final class NoBorderBasicSplitPaneDivider extends BasicSplitPaneDivider {
NoBorderBasicSplitPaneDivider(BasicSplitPaneUI ui) {
super(ui);
}
@Override
public void setBorder(Border b) {
// Do nothing
}
}
@Override
public BasicSplitPaneDivider createDefaultDivider() {
return new NoBorderBasicSplitPaneDivider(this);
}
}
private final class SideToolbarPopupMenu extends JPopupMenu {
private static final int staticMenuEntryCount = 2;
private final JCheckBoxMenuItem doNotHide = new JCheckBoxMenuItem(new AbstractAction(tr("Do not hide toolbar")) {
@Override
public void actionPerformed(ActionEvent e) {
boolean sel = ((JCheckBoxMenuItem) e.getSource()).getState();
Config.getPref().putBoolean("sidetoolbar.always-visible", sel);
}
});
{
addPopupMenuListener(new PopupMenuListener() {
@Override
public void popupMenuWillBecomeVisible(PopupMenuEvent e) {
final Object src = ((JPopupMenu) e.getSource()).getInvoker();
if (src instanceof IconToggleButton) {
insert(new Separator(), 0);
insert(new AbstractAction() {
{
putValue(NAME, tr("Hide this button"));
putValue(SHORT_DESCRIPTION, tr("Click the arrow at the bottom to show it again."));
}
@Override
public void actionPerformed(ActionEvent e) {
((IconToggleButton) src).setButtonHidden(true);
validateToolBarsVisibility();
}
}, 0);
}
doNotHide.setSelected(Config.getPref().getBoolean("sidetoolbar.always-visible", true));
}
@Override
public void popupMenuWillBecomeInvisible(PopupMenuEvent e) {
while (getComponentCount() > staticMenuEntryCount) {
remove(0);
}
}
@Override
public void popupMenuCanceled(PopupMenuEvent e) {
// Do nothing
}
});
add(new AbstractAction(tr("Hide edit toolbar")) {
@Override
public void actionPerformed(ActionEvent e) {
Config.getPref().putBoolean("sidetoolbar.visible", false);
}
});
add(doNotHide);
}
}
class ListAllButtonsAction extends AbstractAction {
private JButton button;
private final transient Collection extends HideableButton> buttons;
ListAllButtonsAction(Collection extends HideableButton> buttons) {
this.buttons = buttons;
}
public void setButton(JButton button) {
this.button = button;
final ImageIcon icon = ImageProvider.get("audio-fwd");
putValue(SMALL_ICON, icon);
button.setPreferredSize(new Dimension(icon.getIconWidth(), icon.getIconHeight() + 64));
}
@Override
public void actionPerformed(ActionEvent e) {
JPopupMenu menu = new JPopupMenu();
for (HideableButton b : buttons) {
final HideableButton t = b;
menu.add(new JCheckBoxMenuItem(new AbstractAction() {
{
putValue(NAME, t.getActionName());
putValue(SMALL_ICON, t.getIcon());
putValue(SELECTED_KEY, t.isButtonVisible());
putValue(SHORT_DESCRIPTION, tr("Hide or show this toggle button"));
}
@Override
public void actionPerformed(ActionEvent e) {
if ((Boolean) getValue(SELECTED_KEY)) {
t.showButton();
} else {
t.hideButton();
}
validateToolBarsVisibility();
}
}));
}
if (button != null) {
Rectangle bounds = button.getBounds();
menu.show(button, bounds.x + bounds.width, 0);
}
}
}
/**
* Validate the visibility of all tool bars and hide the ones that should be hidden
*/
public void validateToolBarsVisibility() {
for (IconToggleButton b : allDialogButtons) {
b.applyButtonHiddenPreferences();
}
toolBarToggle.repaint();
for (IconToggleButton b : allMapModeButtons) {
b.applyButtonHiddenPreferences();
}
toolBarActions.repaint();
}
/**
* Replies the instance of a toggle dialog of type type
managed by this map frame
*
* @param type
managed by this
* map frame; null, if no such dialog exists
*
*/
public