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