001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.gui.preferences.display;
003
004import static org.openstreetmap.josm.tools.I18n.tr;
005
006import java.awt.Color;
007import java.awt.Component;
008import java.awt.Dimension;
009import java.awt.GridBagLayout;
010import java.awt.event.ActionEvent;
011import java.awt.event.ActionListener;
012import java.util.ArrayList;
013import java.util.HashMap;
014import java.util.List;
015import java.util.Map;
016import java.util.TreeMap;
017import java.util.Vector;
018
019import javax.swing.BorderFactory;
020import javax.swing.Box;
021import javax.swing.JButton;
022import javax.swing.JColorChooser;
023import javax.swing.JLabel;
024import javax.swing.JOptionPane;
025import javax.swing.JPanel;
026import javax.swing.JScrollPane;
027import javax.swing.JTable;
028import javax.swing.ListSelectionModel;
029import javax.swing.event.ListSelectionEvent;
030import javax.swing.table.DefaultTableModel;
031import javax.swing.table.TableCellRenderer;
032
033import org.openstreetmap.josm.Main;
034import org.openstreetmap.josm.data.osm.visitor.paint.PaintColors;
035import org.openstreetmap.josm.data.validation.Severity;
036import org.openstreetmap.josm.gui.MapScaler;
037import org.openstreetmap.josm.gui.MapStatus;
038import org.openstreetmap.josm.gui.conflict.ConflictColors;
039import org.openstreetmap.josm.gui.dialogs.ConflictDialog;
040import org.openstreetmap.josm.gui.layer.ImageryLayer;
041import org.openstreetmap.josm.gui.layer.OsmDataLayer;
042import org.openstreetmap.josm.gui.layer.gpx.GpxDrawHelper;
043import org.openstreetmap.josm.gui.layer.markerlayer.MarkerLayer;
044import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
045import org.openstreetmap.josm.gui.preferences.PreferenceSettingFactory;
046import org.openstreetmap.josm.gui.preferences.PreferenceTabbedPane;
047import org.openstreetmap.josm.gui.preferences.SubPreferenceSetting;
048import org.openstreetmap.josm.gui.preferences.TabPreferenceSetting;
049import org.openstreetmap.josm.tools.ColorHelper;
050import org.openstreetmap.josm.tools.GBC;
051
052/**
053 * Color preferences.
054 */
055public class ColorPreference implements SubPreferenceSetting {
056
057    /**
058     * Factory used to create a new {@code ColorPreference}.
059     */
060    public static class Factory implements PreferenceSettingFactory {
061        @Override
062        public PreferenceSetting createPreferenceSetting() {
063            return new ColorPreference();
064        }
065    }
066
067    private DefaultTableModel tableModel;
068    private JTable colors;
069    private List<String> del = new ArrayList<>();
070
071    private JButton colorEdit;
072    private JButton defaultSet;
073    private JButton remove;
074
075    /**
076     * Set the colors to be shown in the preference table. This method creates a table model if
077     * none exists and overwrites all existing values.
078     * @param colorMap the map holding the colors
079     * (key = color id (without prefixes, so only <code>background</code>; not <code>color.background</code>),
080     * value = html representation of the color.
081     */
082    public void setColorModel(Map<String, String> colorMap) {
083        if (tableModel == null) {
084            tableModel = new DefaultTableModel();
085            tableModel.addColumn(tr("Name"));
086            tableModel.addColumn(tr("Color"));
087        }
088
089        // clear old model:
090        while (tableModel.getRowCount() > 0) {
091            tableModel.removeRow(0);
092        }
093        // fill model with colors:
094        Map<String, String> colorKeyList = new TreeMap<>();
095        Map<String, String> colorKeyList_mappaint = new TreeMap<>();
096        Map<String, String> colorKeyList_layer = new TreeMap<>();
097        for (String key : colorMap.keySet()) {
098            if (key.startsWith("layer ")) {
099                colorKeyList_layer.put(getName(key), key);
100            } else if (key.startsWith("mappaint.")) {
101                // use getName(key)+key, as getName() may be ambiguous
102                colorKeyList_mappaint.put(getName(key)+key, key);
103            } else {
104                colorKeyList.put(getName(key), key);
105            }
106        }
107        addColorRows(colorMap, colorKeyList);
108        addColorRows(colorMap, colorKeyList_mappaint);
109        addColorRows(colorMap, colorKeyList_layer);
110        if (this.colors != null) {
111            this.colors.repaint();
112        }
113    }
114
115    private void addColorRows(Map<String, String> colorMap, Map<String, String> keyMap) {
116        for (String value : keyMap.values()) {
117            Vector<Object> row = new Vector<>(2);
118            String html = colorMap.get(value);
119            Color color = ColorHelper.html2color(html);
120            if (color == null) {
121                Main.warn("Unable to get color from '"+html+"' for color preference '"+value+'\'');
122            }
123            row.add(value);
124            row.add(color);
125            tableModel.addRow(row);
126        }
127    }
128
129    /**
130     * Returns a map with the colors in the table (key = color name without prefix, value = html color code).
131     * @return a map holding the colors.
132     */
133    public Map<String, String> getColorModel() {
134        String key;
135        String value;
136        Map<String, String> colorMap = new HashMap<>();
137        for (int row = 0; row < tableModel.getRowCount(); ++row) {
138            key = (String) tableModel.getValueAt(row, 0);
139            value = ColorHelper.color2html((Color) tableModel.getValueAt(row, 1));
140            colorMap.put(key, value);
141        }
142        return colorMap;
143    }
144
145    private static String getName(String o) {
146        return Main.pref.getColorName(o);
147    }
148
149    @Override
150    public void addGui(final PreferenceTabbedPane gui) {
151        fixColorPrefixes();
152        setColorModel(Main.pref.getAllColors());
153
154        colorEdit = new JButton(tr("Choose"));
155        colorEdit.addActionListener(new ActionListener() {
156            @Override
157            public void actionPerformed(ActionEvent e) {
158                int sel = colors.getSelectedRow();
159                JColorChooser chooser = new JColorChooser((Color) colors.getValueAt(sel, 1));
160                int answer = JOptionPane.showConfirmDialog(
161                        gui, chooser,
162                        tr("Choose a color for {0}", getName((String) colors.getValueAt(sel, 0))),
163                        JOptionPane.OK_CANCEL_OPTION,
164                        JOptionPane.PLAIN_MESSAGE);
165                if (answer == JOptionPane.OK_OPTION) {
166                    colors.setValueAt(chooser.getColor(), sel, 1);
167                }
168            }
169        });
170        defaultSet = new JButton(tr("Set to default"));
171        defaultSet.addActionListener(new ActionListener() {
172            @Override
173            public void actionPerformed(ActionEvent e) {
174                int sel = colors.getSelectedRow();
175                String name = (String) colors.getValueAt(sel, 0);
176                Color c = Main.pref.getDefaultColor(name);
177                if (c != null) {
178                    colors.setValueAt(c, sel, 1);
179                }
180            }
181        });
182        JButton defaultAll = new JButton(tr("Set all to default"));
183        defaultAll.addActionListener(new ActionListener() {
184            @Override
185            public void actionPerformed(ActionEvent e) {
186                for (int i = 0; i < colors.getRowCount(); ++i) {
187                    String name = (String) colors.getValueAt(i, 0);
188                    Color c = Main.pref.getDefaultColor(name);
189                    if (c != null) {
190                        colors.setValueAt(c, i, 1);
191                    }
192                }
193            }
194        });
195        remove = new JButton(tr("Remove"));
196        remove.addActionListener(new ActionListener() {
197            @Override
198            public void actionPerformed(ActionEvent e) {
199                int sel = colors.getSelectedRow();
200                del.add((String) colors.getValueAt(sel, 0));
201                tableModel.removeRow(sel);
202            }
203        });
204        remove.setEnabled(false);
205        colorEdit.setEnabled(false);
206        defaultSet.setEnabled(false);
207
208        colors = new JTable(tableModel) {
209            @Override
210            public boolean isCellEditable(int row, int column) {
211                return false;
212            }
213
214            @Override public void valueChanged(ListSelectionEvent e) {
215                super.valueChanged(e);
216                int sel = getSelectedRow();
217                remove.setEnabled(sel >= 0 && isRemoveColor(sel));
218                colorEdit.setEnabled(sel >= 0);
219                defaultSet.setEnabled(sel >= 0);
220            }
221        };
222        colors.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
223        final TableCellRenderer oldColorsRenderer = colors.getDefaultRenderer(Object.class);
224        colors.setDefaultRenderer(Object.class, new TableCellRenderer() {
225            @Override
226            public Component getTableCellRendererComponent(JTable t, Object o, boolean selected, boolean focus, int row, int column) {
227                if (o == null)
228                    return new JLabel();
229                if (column == 1) {
230                    JLabel l = new JLabel(ColorHelper.color2html((Color) o));
231                    l.setBackground((Color) o);
232                    l.setOpaque(true);
233                    return l;
234                }
235                return oldColorsRenderer.getTableCellRendererComponent(t, getName(o.toString()), selected, focus, row, column);
236            }
237        });
238        colors.getColumnModel().getColumn(1).setWidth(100);
239        colors.setToolTipText(tr("Colors used by different objects in JOSM."));
240        colors.setPreferredScrollableViewportSize(new Dimension(100, 112));
241
242        JPanel panel = new JPanel(new GridBagLayout());
243        panel.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
244        JScrollPane scrollpane = new JScrollPane(colors);
245        scrollpane.setBorder(BorderFactory.createEmptyBorder(0, 0, 0, 0));
246        panel.add(scrollpane, GBC.eol().fill(GBC.BOTH));
247        JPanel buttonPanel = new JPanel(new GridBagLayout());
248        panel.add(buttonPanel, GBC.eol().insets(5, 0, 5, 5).fill(GBC.HORIZONTAL));
249        buttonPanel.add(Box.createHorizontalGlue(), GBC.std().fill(GBC.HORIZONTAL));
250        buttonPanel.add(colorEdit, GBC.std().insets(0, 5, 0, 0));
251        buttonPanel.add(defaultSet, GBC.std().insets(5, 5, 5, 0));
252        buttonPanel.add(defaultAll, GBC.std().insets(0, 5, 0, 0));
253        buttonPanel.add(remove, GBC.std().insets(0, 5, 0, 0));
254        gui.getDisplayPreference().addSubTab(this, tr("Colors"), panel);
255    }
256
257    Boolean isRemoveColor(int row) {
258        return ((String) colors.getValueAt(row, 0)).startsWith("layer ");
259    }
260
261    /**
262     * Add all missing color entries.
263     */
264    private static void fixColorPrefixes() {
265        PaintColors.getColors();
266        ConflictColors.getColors();
267        Severity.getColors();
268        MarkerLayer.getGenericColor();
269        GpxDrawHelper.getGenericColor();
270        OsmDataLayer.getOutsideColor();
271        ImageryLayer.getFadeColor();
272        MapScaler.getColor();
273        MapStatus.getColors();
274        ConflictDialog.getColor();
275    }
276
277    @Override
278    public boolean ok() {
279        boolean ret = false;
280        for (String d : del) {
281            Main.pref.put("color."+d, null);
282        }
283        for (int i = 0; i < colors.getRowCount(); ++i) {
284            String key = (String) colors.getValueAt(i, 0);
285            if (Main.pref.putColor(key, (Color) colors.getValueAt(i, 1))) {
286                if (key.startsWith("mappaint.")) {
287                    ret = true;
288                }
289            }
290        }
291        OsmDataLayer.createHatchTexture();
292        return ret;
293    }
294
295    @Override
296    public boolean isExpert() {
297        return false;
298    }
299
300    @Override
301    public TabPreferenceSetting getTabPreferenceSetting(final PreferenceTabbedPane gui) {
302        return gui.getDisplayPreference();
303    }
304}