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.gpx.GpxDrawHelper;
041import org.openstreetmap.josm.gui.layer.GpxLayer;
042import org.openstreetmap.josm.gui.layer.ImageryLayer;
043import org.openstreetmap.josm.gui.layer.OsmDataLayer;
044import org.openstreetmap.josm.gui.layer.markerlayer.MarkerLayer;
045import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
046import org.openstreetmap.josm.gui.preferences.PreferenceSettingFactory;
047import org.openstreetmap.josm.gui.preferences.PreferenceTabbedPane;
048import org.openstreetmap.josm.gui.preferences.SubPreferenceSetting;
049import org.openstreetmap.josm.gui.preferences.TabPreferenceSetting;
050import org.openstreetmap.josm.tools.ColorHelper;
051import org.openstreetmap.josm.tools.GBC;
052
053/**
054 * Color preferences.
055 */
056public class ColorPreference implements SubPreferenceSetting {
057
058    /**
059     * Factory used to create a new {@code ColorPreference}.
060     */
061    public static class Factory implements PreferenceSettingFactory {
062        @Override
063        public PreferenceSetting createPreferenceSetting() {
064            return new ColorPreference();
065        }
066    }
067
068    private DefaultTableModel tableModel;
069    private JTable colors;
070    private List<String> del = new ArrayList<>();
071
072    private JButton colorEdit;
073    private JButton defaultSet;
074    private JButton remove;
075
076    /**
077     * Set the colors to be shown in the preference table. This method creates a table model if
078     * none exists and overwrites all existing values.
079     * @param colorMap the map holding the colors
080     * (key = color id (without prefixes, so only <code>background</code>; not <code>color.background</code>),
081     * value = html representation of the color.
082     */
083    public void setColorModel(Map<String, String> colorMap) {
084        if (tableModel == null) {
085            tableModel = new DefaultTableModel();
086            tableModel.addColumn(tr("Name"));
087            tableModel.addColumn(tr("Color"));
088        }
089
090        // clear old model:
091        while (tableModel.getRowCount() > 0) {
092            tableModel.removeRow(0);
093        }
094        // fill model with colors:
095        Map<String, String> colorKeyList = new TreeMap<>();
096        Map<String, String> colorKeyList_mappaint = new TreeMap<>();
097        Map<String, String> colorKeyList_layer = new TreeMap<>();
098        for (String key : colorMap.keySet()) {
099            if (key.startsWith("layer ")) {
100                colorKeyList_layer.put(getName(key), key);
101            } else if (key.startsWith("mappaint.")) {
102                // use getName(key)+key, as getName() may be ambiguous
103                colorKeyList_mappaint.put(getName(key)+key, key);
104            } else {
105                colorKeyList.put(getName(key), key);
106            }
107        }
108        addColorRows(colorMap, colorKeyList);
109        addColorRows(colorMap, colorKeyList_mappaint);
110        addColorRows(colorMap, colorKeyList_layer);
111        if (this.colors != null) {
112            this.colors.repaint();
113        }
114    }
115
116    private void addColorRows(Map<String, String> colorMap, Map<String, String> keyMap) {
117        for (String value : keyMap.values()) {
118            Vector<Object> row = new Vector<>(2);
119            String html = colorMap.get(value);
120            Color color = ColorHelper.html2color(html);
121            if (color == null) {
122                Main.warn("Unable to get color from '"+html+"' for color preference '"+value+"'");
123            }
124            row.add(value);
125            row.add(color);
126            tableModel.addRow(row);
127        }
128    }
129
130    /**
131     * Returns a map with the colors in the table (key = color name without prefix, value = html color code).
132     * @return a map holding the colors.
133     */
134    public Map<String, String> getColorModel() {
135        String key;
136        String value;
137        Map<String, String> colorMap = new HashMap<>();
138        for(int row = 0; row < tableModel.getRowCount(); ++row) {
139            key = (String)tableModel.getValueAt(row, 0);
140            value = ColorHelper.color2html((Color)tableModel.getValueAt(row, 1));
141            colorMap.put(key, value);
142        }
143        return colorMap;
144    }
145
146    private String getName(String o) {
147        return Main.pref.getColorName(o);
148    }
149
150    @Override
151    public void addGui(final PreferenceTabbedPane gui) {
152        fixColorPrefixes();
153        setColorModel(Main.pref.getAllColors());
154
155        colorEdit = new JButton(tr("Choose"));
156        colorEdit.addActionListener(new ActionListener(){
157            @Override
158            public void actionPerformed(ActionEvent e) {
159                int sel = colors.getSelectedRow();
160                JColorChooser chooser = new JColorChooser((Color)colors.getValueAt(sel, 1));
161                int answer = JOptionPane.showConfirmDialog(
162                        gui, chooser,
163                        tr("Choose a color for {0}", getName((String)colors.getValueAt(sel, 0))),
164                        JOptionPane.OK_CANCEL_OPTION,
165                        JOptionPane.PLAIN_MESSAGE);
166                if (answer == JOptionPane.OK_OPTION) {
167                    colors.setValueAt(chooser.getColor(), sel, 1);
168                }
169            }
170        });
171        defaultSet = new JButton(tr("Set to default"));
172        defaultSet.addActionListener(new ActionListener(){
173            @Override
174            public void actionPerformed(ActionEvent e) {
175                int sel = colors.getSelectedRow();
176                String name = (String)colors.getValueAt(sel, 0);
177                Color c = Main.pref.getDefaultColor(name);
178                if (c != null) {
179                    colors.setValueAt(c, sel, 1);
180                }
181            }
182        });
183        JButton defaultAll = new JButton(tr("Set all to default"));
184        defaultAll.addActionListener(new ActionListener(){
185            @Override
186            public void actionPerformed(ActionEvent e) {
187                for(int i = 0; i < colors.getRowCount(); ++i)
188                {
189                    String name = (String)colors.getValueAt(i, 0);
190                    Color c = Main.pref.getDefaultColor(name);
191                    if (c != null) {
192                        colors.setValueAt(c, i, 1);
193                    }
194                }
195            }
196        });
197        remove = new JButton(tr("Remove"));
198        remove.addActionListener(new ActionListener(){
199            @Override
200            public void actionPerformed(ActionEvent e) {
201                int sel = colors.getSelectedRow();
202                del.add((String)colors.getValueAt(sel, 0));
203                tableModel.removeRow(sel);
204            }
205        });
206        remove.setEnabled(false);
207        colorEdit.setEnabled(false);
208        defaultSet.setEnabled(false);
209
210        colors = new JTable(tableModel) {
211            @Override public boolean isCellEditable(int row, int column) {
212                return false;
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 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            {
287                if(key.startsWith("mappaint.")) {
288                    ret = true;
289                }
290            }
291        }
292        OsmDataLayer.createHatchTexture();
293        return ret;
294    }
295
296    @Override
297    public boolean isExpert() {
298        return false;
299    }
300
301    @Override
302    public TabPreferenceSetting getTabPreferenceSetting(final PreferenceTabbedPane gui) {
303        return gui.getDisplayPreference();
304    }
305}