001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.gui.dialogs.properties;
003
004import static org.openstreetmap.josm.tools.I18n.marktr;
005import static org.openstreetmap.josm.tools.I18n.tr;
006import static org.openstreetmap.josm.tools.I18n.trn;
007
008import java.awt.Color;
009import java.awt.Component;
010import java.awt.Font;
011import java.util.Collection;
012import java.util.Map;
013import java.util.Objects;
014import java.util.concurrent.CopyOnWriteArrayList;
015
016import javax.swing.JLabel;
017import javax.swing.JTable;
018import javax.swing.UIDefaults;
019import javax.swing.UIManager;
020import javax.swing.table.DefaultTableCellRenderer;
021import javax.swing.table.TableCellRenderer;
022
023import org.openstreetmap.josm.data.osm.OsmPrimitive;
024import org.openstreetmap.josm.data.preferences.BooleanProperty;
025import org.openstreetmap.josm.data.preferences.CachingProperty;
026import org.openstreetmap.josm.data.preferences.ColorProperty;
027
028/**
029 * Cell renderer of tags table.
030 * @since 6314
031 */
032public class PropertiesCellRenderer extends DefaultTableCellRenderer {
033
034    private static final CachingProperty<Color> SELECTED_FG
035            = new ColorProperty(marktr("Discardable key: selection Foreground"), Color.GRAY).cached();
036    private static final CachingProperty<Color> SELECTED_BG;
037    private static final CachingProperty<Color> NORMAL_FG
038            = new ColorProperty(marktr("Discardable key: foreground"), Color.GRAY).cached();
039    private static final CachingProperty<Color> NORMAL_BG;
040    private static final CachingProperty<Boolean> DISCARDABLE
041            = new BooleanProperty("display.discardable-keys", false).cached();
042
043    static {
044        UIDefaults defaults = UIManager.getDefaults();
045        SELECTED_BG = new ColorProperty(marktr("Discardable key: selection Background"),
046                defaults.getColor("Table.selectionBackground")).cached();
047        NORMAL_BG = new ColorProperty(marktr("Discardable key: background"),
048                defaults.getColor("Table.background")).cached();
049    }
050
051    private final Collection<TableCellRenderer> customRenderer = new CopyOnWriteArrayList<>();
052
053    private static void setColors(Component c, String key, boolean isSelected) {
054
055        if (OsmPrimitive.getDiscardableKeys().contains(key)) {
056            c.setForeground((isSelected ? SELECTED_FG : NORMAL_FG).get());
057            c.setBackground((isSelected ? SELECTED_BG : NORMAL_BG).get());
058        } else {
059            UIDefaults defaults = UIManager.getDefaults();
060            c.setForeground(defaults.getColor("Table."+(isSelected ? "selectionF" : "f")+"oreground"));
061            c.setBackground(defaults.getColor("Table."+(isSelected ? "selectionB" : "b")+"ackground"));
062        }
063    }
064
065    @Override
066    public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column) {
067        for (TableCellRenderer renderer : customRenderer) {
068            final Component component = renderer.getTableCellRendererComponent(table, value, isSelected, hasFocus, row, column);
069            if (component != null) {
070                return component;
071            }
072        }
073        if (value == null)
074            return this;
075        Component c = super.getTableCellRendererComponent(table, value, isSelected, false, row, column);
076        if (c instanceof JLabel) {
077            String str = null;
078            if (value instanceof String) {
079                str = (String) value;
080            } else if (value instanceof Map<?, ?>) {
081                Map<?, ?> v = (Map<?, ?>) value;
082                if (v.size() != 1) {    // Multiple values: give user a short summary of the values
083                    Integer blankCount;
084                    Integer otherCount;
085                    if (v.get("") == null) {
086                        blankCount = 0;
087                        otherCount = v.size();
088                    } else {
089                        blankCount = (Integer) v.get("");
090                        otherCount = v.size()-1;
091                    }
092                    StringBuilder sb = new StringBuilder("<");
093                    if (otherCount == 1) {
094                        // Find the non-blank value in the map
095                        v.entrySet().stream().filter(entry -> !Objects.equals(entry.getKey(), ""))
096                            /* I18n: properties display partial string joined with comma, first is count, second is value */
097                            .findAny().ifPresent(entry -> sb.append(tr("{0} ''{1}''", entry.getValue().toString(), entry.getKey())));
098                    } else {
099                        /* I18n: properties display partial string joined with comma */
100                        sb.append(trn("{0} different", "{0} different", otherCount, otherCount));
101                    }
102                    if (blankCount > 0) {
103                        /* I18n: properties display partial string joined with comma */
104                        sb.append(trn(", {0} unset", ", {0} unset", blankCount, blankCount));
105                    }
106                    sb.append('>');
107                    str = sb.toString();
108                    c.setFont(c.getFont().deriveFont(Font.ITALIC));
109
110                } else {                // One value: display the value
111                    final Map.Entry<?, ?> entry = v.entrySet().iterator().next();
112                    str = (String) entry.getKey();
113                }
114            }
115            ((JLabel) c).putClientProperty("html.disable", Boolean.TRUE); // Fix #8730
116            ((JLabel) c).setText(str);
117            if (DISCARDABLE.get()) {
118                String key = null;
119                if (column == 0) {
120                    key = str;
121                } else if (column == 1) {
122                    Object value0 = table.getModel().getValueAt(row, 0);
123                    if (value0 instanceof String) {
124                        key = (String) value0;
125                    }
126                }
127                setColors(c, key, isSelected);
128            }
129        }
130        return c;
131    }
132
133    /**
134     * Adds a custom table cell renderer to render cells of the tags table.
135     *
136     * If the renderer is not capable performing a {@link TableCellRenderer#getTableCellRendererComponent},
137     * it should return {@code null} to fall back to the
138     * {@link PropertiesCellRenderer#getTableCellRendererComponent default implementation}.
139     * @param renderer the renderer to add
140     * @since 9149
141     */
142    public void addCustomRenderer(TableCellRenderer renderer) {
143        customRenderer.add(renderer);
144    }
145
146    /**
147     * Removes a custom table cell renderer.
148     * @param renderer the renderer to remove
149     * @since 9149
150     */
151    public void removeCustomRenderer(TableCellRenderer renderer) {
152        customRenderer.remove(renderer);
153    }
154}