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