001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.gui;
003
004import java.awt.Component;
005import java.awt.Rectangle;
006
007import javax.swing.DefaultListCellRenderer;
008import javax.swing.ImageIcon;
009import javax.swing.JLabel;
010import javax.swing.JList;
011import javax.swing.JTable;
012import javax.swing.ListCellRenderer;
013import javax.swing.table.DefaultTableCellRenderer;
014import javax.swing.table.TableCellRenderer;
015
016import org.openstreetmap.josm.Main;
017import org.openstreetmap.josm.data.osm.OsmPrimitive;
018import org.openstreetmap.josm.data.osm.history.HistoryOsmPrimitive;
019import org.openstreetmap.josm.tools.ImageProvider;
020
021/**
022 * Renderer that renders the objects from an OsmPrimitive as data.
023 *
024 * Can be used in lists and tables.
025 *
026 * @author imi
027 * @author Frederik Ramm
028 */
029public class OsmPrimitivRenderer implements ListCellRenderer<OsmPrimitive>, TableCellRenderer {
030    private DefaultNameFormatter formatter = DefaultNameFormatter.getInstance();
031
032    /**
033     * Default list cell renderer - delegate for ListCellRenderer operation
034     */
035    private DefaultListCellRenderer defaultListCellRenderer = new DefaultListCellRenderer();
036
037    /**
038     * Default table cell renderer - delegate for TableCellRenderer operation
039     */
040    private DefaultTableCellRenderer defaultTableCellRenderer = new DefaultTableCellRenderer();
041
042    /**
043     * Adapter method supporting the ListCellRenderer interface.
044     */
045    @Override
046    public Component getListCellRendererComponent(JList<? extends OsmPrimitive> list, OsmPrimitive value, int index,
047            boolean isSelected, boolean cellHasFocus) {
048        Component def = defaultListCellRenderer.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);
049        return renderer(def, value);
050    }
051
052    /**
053     * Adapter method supporting the TableCellRenderer interface.
054     */
055    @Override
056    public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column) {
057        Component def = defaultTableCellRenderer.getTableCellRendererComponent(table, value, isSelected, hasFocus, row, column);
058        if (value instanceof OsmPrimitive)
059            return renderer(def, (OsmPrimitive) value);
060        else if (value instanceof HistoryOsmPrimitive)
061            return renderer(def, (HistoryOsmPrimitive) value);
062        else
063            return def;
064    }
065
066    /**
067     * Internal method that stuffs information into the rendering component
068     * provided that it's a kind of JLabel.
069     * @param def the rendering component
070     * @param value the OsmPrimitive to render
071     * @return the modified rendering component
072     */
073    private Component renderer(Component def, OsmPrimitive value) {
074        if (value != null && def instanceof JLabel) {
075            ((JLabel) def).setText(getComponentText(value));
076            ImageIcon icon = ImageProvider.getPadded(value,
077                // Height of component no yet known, assume the default 16px.
078                new Rectangle(16, 16));
079            if (icon != null) {
080                ((JLabel) def).setIcon(icon);
081            } else {
082                Main.warn("Null icon for "+value.getDisplayType());
083            }
084            ((JLabel) def).setToolTipText(getComponentToolTipText(value));
085        }
086        return def;
087    }
088
089    /**
090     * Internal method that stuffs information into the rendering component
091     * provided that it's a kind of JLabel.
092     * @param def the rendering component
093     * @param value the HistoryOsmPrimitive to render
094     * @return the modified rendering component
095     */
096    private Component renderer(Component def, HistoryOsmPrimitive value) {
097        if (value != null && def instanceof JLabel) {
098            ((JLabel) def).setText(value.getDisplayName(DefaultNameFormatter.getInstance()));
099            ((JLabel) def).setIcon(ImageProvider.get(value.getType()));
100            ((JLabel) def).setToolTipText(formatter.buildDefaultToolTip(value));
101        }
102        return def;
103    }
104
105    /**
106     * Returns the text representing an OSM primitive in a component.
107     * Can be overridden to customize the text
108     * @param value OSM primitive
109     * @return text representing the OSM primitive
110     */
111    protected String getComponentText(OsmPrimitive value) {
112        return value.getDisplayName(DefaultNameFormatter.getInstance());
113    }
114
115    /**
116     * Returns the text representing an OSM primitive in a tooltip.
117     * Can be overridden to customize the ToolTipText
118     * @param value OSM primitive
119     * @return text representing the OSM primitive
120     */
121    protected String getComponentToolTipText(OsmPrimitive value) {
122        return formatter.buildDefaultToolTip(value);
123    }
124}