Index: /trunk/src/org/openstreetmap/josm/gui/dialogs/LayerListDialog.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/dialogs/LayerListDialog.java (revision 10010) +++ /trunk/src/org/openstreetmap/josm/gui/dialogs/LayerListDialog.java (revision 10011) @@ -8,4 +8,5 @@ import java.awt.Dimension; import java.awt.Font; +import java.awt.GridBagLayout; import java.awt.Point; import java.awt.Rectangle; @@ -19,4 +20,5 @@ import java.util.ArrayList; import java.util.Arrays; +import java.util.Collection; import java.util.Collections; import java.util.List; @@ -24,4 +26,5 @@ import javax.swing.AbstractAction; +import javax.swing.BorderFactory; import javax.swing.DefaultCellEditor; import javax.swing.DefaultListSelectionModel; @@ -31,4 +34,5 @@ import javax.swing.JLabel; import javax.swing.JMenuItem; +import javax.swing.JPanel; import javax.swing.JPopupMenu; import javax.swing.JSlider; @@ -67,4 +71,5 @@ import org.openstreetmap.josm.gui.widgets.PopupMenuLauncher; import org.openstreetmap.josm.tools.CheckParameterUtil; +import org.openstreetmap.josm.tools.GBC; import org.openstreetmap.josm.tools.ImageProvider; import org.openstreetmap.josm.tools.InputMapUtils; @@ -264,15 +269,8 @@ adaptTo(showHideLayerAction, selectionModel); - // -- layer opacity action - LayerOpacityAction layerOpacityAction = new LayerOpacityAction(model); - adaptTo(layerOpacityAction, selectionModel); - SideButton opacityButton = new SideButton(layerOpacityAction, false); - layerOpacityAction.setCorrespondingSideButton(opacityButton); - - // -- layer gamma action - LayerGammaAction layerGammaAction = new LayerGammaAction(model); - adaptTo(layerGammaAction, selectionModel); - SideButton gammaButton = new SideButton(layerGammaAction, false); - layerGammaAction.setCorrespondingSideButton(gammaButton); + LayerVisibilityAction visibilityAction = new LayerVisibilityAction(model); + adaptTo(visibilityAction, selectionModel); + SideButton visibilityButton = new SideButton(visibilityAction, false); + visibilityAction.setCorrespondingSideButton(visibilityButton); // -- delete layer action @@ -301,7 +299,5 @@ new SideButton(moveDownAction, false), new SideButton(activateLayerAction, false), - new SideButton(showHideLayerAction, false), - opacityButton, - gammaButton, + visibilityButton, new SideButton(deleteLayerAction, false) )); @@ -529,45 +525,105 @@ /** - * Abstract action which allows to adjust a double value using a slider - */ - public abstract static class AbstractLayerPropertySliderAction extends AbstractAction implements IEnabledStateUpdating, LayerAction { - protected final LayerListModel model; - protected final JPopupMenu popup; - protected final JSlider slider; - private final double factor; + * This is a menu that includes all settings for the layer visibility. It combines gamma/opacity sliders and the visible-checkbox. + * + * @author Michael Zangl + */ + public static final class LayerVisibilityAction extends AbstractAction implements IEnabledStateUpdating, LayerAction { + protected static final int SLIDER_STEPS = 100; + private static final double MAX_GAMMA_FACTOR = 2; + private final LayerListModel model; + private final JPopupMenu popup; + private JSlider opacitySlider; + private JSlider gammaSlider; private SideButton sideButton; - - protected AbstractLayerPropertySliderAction(LayerListModel model, String name, final double factor) { - super(name); + private JCheckBox visibilityCheckbox; + + /** + * Creates a new {@link LayerVisibilityAction} + * @param model The list to get the selection from. + */ + public LayerVisibilityAction(LayerListModel model) { this.model = model; - this.factor = factor; - updateEnabledState(); - popup = new JPopupMenu(); - slider = new JSlider(JSlider.VERTICAL); - slider.addChangeListener(new ChangeListener() { + + // just to add a border + JPanel content = new JPanel(); + popup.add(content); + content.setBorder(BorderFactory.createEmptyBorder(10, 10, 10, 10)); + content.setLayout(new GridBagLayout()); + + putValue(SMALL_ICON, ImageProvider.get("dialogs/layerlist", "visibility")); + putValue(SHORT_DESCRIPTION, tr("Change visibility of the selected layer.")); + + visibilityCheckbox = new JCheckBox(tr("Show layer")); + visibilityCheckbox.addChangeListener(new ChangeListener() { @Override public void stateChanged(ChangeEvent e) { - setValue(slider.getValue() / factor); + setVisible(visibilityCheckbox.isSelected()); } }); - popup.add(slider); - } - - protected abstract void setValue(double value); - - protected abstract double getValue(); - - /** - * Sets the corresponding side button. - * @param sideButton the corresponding side button - */ - final void setCorrespondingSideButton(SideButton sideButton) { - this.sideButton = sideButton; + content.add(visibilityCheckbox, GBC.eop()); + + content.add(new JLabel(ImageProvider.get("dialogs/layerlist", "transparency")), GBC.std().span(1, 2).insets(0, 0, 5, 0)); + content.add(new JLabel(tr("Opacity")), GBC.eol()); + opacitySlider = new JSlider(JSlider.HORIZONTAL); + opacitySlider.setMaximum(SLIDER_STEPS); + opacitySlider.addChangeListener(new ChangeListener() { + @Override + public void stateChanged(ChangeEvent e) { + setOpacityValue(readOpacityValue(), opacitySlider.getValueIsAdjusting()); + } + }); + opacitySlider.setToolTipText(tr("Adjust opacity of the layer.")); + content.add(opacitySlider, GBC.eop()); + + content.add(new JLabel(ImageProvider.get("dialogs/layerlist", "gamma")), GBC.std().span(1, 2).insets(0, 0, 5, 0)); + content.add(new JLabel(tr("Gamma")), GBC.eol()); + gammaSlider = new JSlider(JSlider.HORIZONTAL); + gammaSlider.setMaximum(SLIDER_STEPS); + gammaSlider.addChangeListener(new ChangeListener() { + @Override + public void stateChanged(ChangeEvent e) { + setGammaValue(readGammaValue()); + } + }); + gammaSlider.setToolTipText(tr("Adjust gamma value of the layer.")); + content.add(gammaSlider, GBC.eol()); + } + + protected double readOpacityValue() { + return (double) opacitySlider.getValue() / SLIDER_STEPS; + } + + protected double readGammaValue() { + return (double) gammaSlider.getValue() / SLIDER_STEPS * MAX_GAMMA_FACTOR; + } + + protected void setVisible(boolean visible) { + for (Layer l : model.getSelectedLayers()) { + l.setVisible(visible); + } + updateValues(); + } + + protected void setOpacityValue(double value, boolean adjusting) { + if (value <= 0 && !adjusting) { + setVisible(false); + } else { + for (Layer l : model.getSelectedLayers()) { + l.setOpacity(value); + } + } + } + + protected void setGammaValue(double value) { + for (ImageryLayer imageryLayer : Utils.filteredCollection(model.getSelectedLayers(), ImageryLayer.class)) { + imageryLayer.setGamma(value); + } } @Override public void actionPerformed(ActionEvent e) { - slider.setValue((int) (getValue() * factor)); + updateValues(); if (e.getSource() == sideButton) { popup.show(sideButton, 0, sideButton.getHeight()); @@ -579,116 +635,72 @@ } + protected void updateValues() { + List layers = model.getSelectedLayers(); + + visibilityCheckbox.setEnabled(!layers.isEmpty()); + boolean allVisible = true; + boolean allHidden = true; + for (Layer l : layers) { + allVisible &= l.isVisible(); + allHidden &= !l.isVisible(); + } + // TODO: Indicate tristate. + visibilityCheckbox.setSelected(allVisible && !allHidden); + + updateOpacitySlider(layers, allHidden); + + updateGammaSlider(layers, allHidden); + } + + private void updateGammaSlider(List layers, boolean allHidden) { + Collection gammaLayers = Utils.filteredCollection(layers, ImageryLayer.class); + if (gammaLayers.isEmpty() || allHidden) { + gammaSlider.setEnabled(false); + } else { + gammaSlider.setEnabled(true); + double gamma = gammaLayers.iterator().next().getGamma(); + gammaSlider.setValue((int) (gamma * SLIDER_STEPS / MAX_GAMMA_FACTOR)); + } + } + + private void updateOpacitySlider(List layers, boolean allHidden) { + if (layers.isEmpty() || allHidden) { + opacitySlider.setEnabled(false); + } else { + opacitySlider.setEnabled(true); + double opacity = 0; + for (Layer l : layers) { + opacity += l.getOpacity(); + } + opacity /= layers.size(); + if (opacity == 0) { + opacity = 1; + setOpacityValue(opacity, false); + } + opacitySlider.setValue((int) (opacity * SLIDER_STEPS)); + } + } + + @Override + public boolean supportLayers(List layers) { + return !layers.isEmpty(); + } + @Override public Component createMenuComponent() { return new JMenuItem(this); } - } - - /** - * Action which allows to change the opacity of one or more layers. - */ - public static final class LayerOpacityAction extends AbstractLayerPropertySliderAction { - private transient Layer layer; - - /** - * Creates a {@link LayerOpacityAction} which allows to change the opacity of one or more layers. - * - * @param model layer list model - * @param layer the layer. Must not be null. - * @throws IllegalArgumentException if layer is null - */ - public LayerOpacityAction(LayerListModel model, Layer layer) { - this(model); - CheckParameterUtil.ensureParameterNotNull(layer, "layer"); - this.layer = layer; - updateEnabledState(); - } - - /** - * Creates a {@link ShowHideLayerAction} which will toggle the visibility of the currently selected layers - * @param model layer list model - */ - public LayerOpacityAction(LayerListModel model) { - super(model, tr("Opacity"), 100); - putValue(SHORT_DESCRIPTION, tr("Adjust opacity of the layer.")); - putValue(SMALL_ICON, ImageProvider.get("dialogs/layerlist", "transparency")); - } - - @Override - protected void setValue(double value) { - if (!isEnabled()) return; - if (layer != null) { - layer.setOpacity(value); - } else { - for (Layer l : model.getSelectedLayers()) { - l.setOpacity(value); - } - } - } - - @Override - protected double getValue() { - if (layer != null) - return layer.getOpacity(); - else { - double opacity = 0; - List layers = model.getSelectedLayers(); - for (Layer l : layers) { - opacity += l.getOpacity(); - } - return opacity / layers.size(); - } - } @Override public void updateEnabledState() { - if (layer == null) { - setEnabled(!model.getSelectedLayers().isEmpty()); - } else { - setEnabled(true); - } - } - - @Override - public boolean supportLayers(List layers) { - return true; - } - } - - /** - * Action which allows to change the gamma of one imagery layer. - */ - public static final class LayerGammaAction extends AbstractLayerPropertySliderAction { - - /** - * Constructs a new {@code LayerGammaAction}. - * @param model layer list model - */ - public LayerGammaAction(LayerListModel model) { - super(model, tr("Gamma"), 50); - putValue(SHORT_DESCRIPTION, tr("Adjust gamma value of the layer.")); - putValue(SMALL_ICON, ImageProvider.get("dialogs/layerlist", "gamma")); - } - - @Override - protected void setValue(double value) { - for (ImageryLayer imageryLayer : Utils.filteredCollection(model.getSelectedLayers(), ImageryLayer.class)) { - imageryLayer.setGamma(value); - } - } - - @Override - protected double getValue() { - return Utils.filteredCollection(model.getSelectedLayers(), ImageryLayer.class).iterator().next().getGamma(); - } - - @Override - public void updateEnabledState() { - setEnabled(!Utils.filteredCollection(model.getSelectedLayers(), ImageryLayer.class).isEmpty()); - } - - @Override - public boolean supportLayers(List layers) { - return !Utils.filteredCollection(layers, ImageryLayer.class).isEmpty(); + setEnabled(!model.getSelectedLayers().isEmpty()); + } + + /** + * Sets the corresponding side button. + * @param sideButton the corresponding side button + */ + void setCorrespondingSideButton(SideButton sideButton) { + this.sideButton = sideButton; } } Index: /trunk/src/org/openstreetmap/josm/gui/layer/Layer.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/layer/Layer.java (revision 10010) +++ /trunk/src/org/openstreetmap/josm/gui/layer/Layer.java (revision 10011) @@ -361,8 +361,17 @@ } + /** + * Gets the opacity of the layer, in range 0...1 + * @return The opacity + */ public double getOpacity() { return opacity; } + /** + * Sets the opacity of the layer, in range 0...1 + * @param opacity The opacity + * @throws IllegalArgumentException if the opacity is out of range + */ public void setOpacity(double opacity) { if (!(opacity >= 0 && opacity <= 1)) Index: /trunk/test/unit/org/openstreetmap/josm/gui/dialogs/LayerListDialogTest.java =================================================================== --- /trunk/test/unit/org/openstreetmap/josm/gui/dialogs/LayerListDialogTest.java (revision 10010) +++ /trunk/test/unit/org/openstreetmap/josm/gui/dialogs/LayerListDialogTest.java (revision 10011) @@ -3,4 +3,5 @@ import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertTrue; @@ -9,7 +10,6 @@ import org.openstreetmap.josm.JOSMFixture; import org.openstreetmap.josm.Main; -import org.openstreetmap.josm.gui.dialogs.LayerListDialog.LayerGammaAction; import org.openstreetmap.josm.gui.dialogs.LayerListDialog.LayerListModel; -import org.openstreetmap.josm.gui.dialogs.LayerListDialog.LayerOpacityAction; +import org.openstreetmap.josm.gui.dialogs.LayerListDialog.LayerVisibilityAction; import org.openstreetmap.josm.gui.layer.TMSLayer; import org.openstreetmap.josm.gui.layer.TMSLayerTest; @@ -29,40 +29,60 @@ /** - * Unit test of {@link LayerGammaAction} class. + * Unit test of {@link LayerVisibilityAction} class. */ @Test - public void testLayerGammaAction() { + public void testLayerVisibilityAction() { TMSLayer layer = TMSLayerTest.createTmsLayer(); try { + LayerListModel model = LayerListDialog.getInstance().getModel(); + LayerVisibilityAction action = new LayerVisibilityAction(model); + action.updateEnabledState(); + assertFalse(action.isEnabled()); + Main.map.mapView.addLayer(layer); - LayerListModel model = LayerListDialog.getInstance().getModel(); - LayerGammaAction action = new LayerGammaAction(model); action.updateEnabledState(); assertTrue(action.isEnabled()); assertTrue(action.supportLayers(model.getSelectedLayers())); - assertEquals(1.0, action.getValue(), 1e-15); - action.setValue(0.5); - assertEquals(0.5, action.getValue(), 1e-15); - } finally { - Main.map.mapView.removeLayer(layer); - } - } - /** - * Unit test of {@link LayerOpacityAction} class. - */ - @Test - public void testLayerOpacityAction() { - TMSLayer layer = TMSLayerTest.createTmsLayer(); - try { - Main.map.mapView.addLayer(layer); - LayerListModel model = LayerListDialog.getInstance().getModel(); - LayerOpacityAction action = new LayerOpacityAction(model); - action.updateEnabledState(); - assertTrue(action.isEnabled()); - assertTrue(action.supportLayers(model.getSelectedLayers())); - assertEquals(1.0, action.getValue(), 1e-15); - action.setValue(0.5); - assertEquals(0.5, action.getValue(), 1e-15); + // now check values + action.updateValues(); + assertEquals(1.0, action.readOpacityValue(), 1e-15); + assertEquals(1.0, action.readGammaValue(), 1e-15); + + action.setOpacityValue(.5, false); + action.setGammaValue(1.5); + action.updateValues(); + + assertEquals(0.5, action.readOpacityValue(), 1e-15); + assertEquals(1.5, action.readGammaValue(), 1e-15); + + action.setVisible(false); + action.updateValues(); + assertFalse(layer.isVisible()); + + action.setVisible(true); + action.updateValues(); + assertTrue(layer.isVisible()); + + // layer stays visible during adjust + action.setOpacityValue(0, true); + assertEquals(0, layer.getOpacity(), 1e-15); + layer.setOpacity(.1); // to make layer.isVisible work + assertTrue(layer.isVisible()); + layer.setOpacity(0); + + action.setOpacityValue(0, false); + assertEquals(0, layer.getOpacity(), 1e-15); + layer.setOpacity(.1); // to make layer.isVisible work + assertFalse(layer.isVisible()); + layer.setOpacity(0); + action.updateValues(); + + // Opacity reset when it was 0 and user set layer to visible. + action.setVisible(true); + action.updateValues(); + assertEquals(1.0, action.readOpacityValue(), 1e-15); + assertEquals(1.0, layer.getOpacity(), 1e-15); + } finally { Main.map.mapView.removeLayer(layer);