01 /*
02 * Copyright 1997-2005 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.swing.table;
27
28 import java.awt.Component;
29 import javax.swing.*;
30
31 /**
32 * This interface defines the method required by any object that
33 * would like to be a renderer for cells in a <code>JTable</code>.
34 *
35 * @version 1.28 05/05/07
36 * @author Alan Chung
37 */
38
39 public interface TableCellRenderer {
40
41 /**
42 * Returns the component used for drawing the cell. This method is
43 * used to configure the renderer appropriately before drawing.
44 * <p>
45 * The <code>TableCellRenderer</code> is also responsible for rendering the
46 * the cell representing the table's current DnD drop location if
47 * it has one. If this renderer cares about rendering
48 * the DnD drop location, it should query the table directly to
49 * see if the given row and column represent the drop location:
50 * <pre>
51 * JTable.DropLocation dropLocation = table.getDropLocation();
52 * if (dropLocation != null
53 * && !dropLocation.isInsertRow()
54 * && !dropLocation.isInsertColumn()
55 * && dropLocation.getRow() == row
56 * && dropLocation.getColumn() == column) {
57 *
58 * // this cell represents the current drop location
59 * // so render it specially, perhaps with a different color
60 * }
61 * </pre>
62 * <p>
63 * During a printing operation, this method will be called with
64 * <code>isSelected</code> and <code>hasFocus</code> values of
65 * <code>false</code> to prevent selection and focus from appearing
66 * in the printed output. To do other customization based on whether
67 * or not the table is being printed, check the return value from
68 * {@link javax.swing.JComponent#isPaintingForPrint()}.
69 *
70 * @param table the <code>JTable</code> that is asking the
71 * renderer to draw; can be <code>null</code>
72 * @param value the value of the cell to be rendered. It is
73 * up to the specific renderer to interpret
74 * and draw the value. For example, if
75 * <code>value</code>
76 * is the string "true", it could be rendered as a
77 * string or it could be rendered as a check
78 * box that is checked. <code>null</code> is a
79 * valid value
80 * @param isSelected true if the cell is to be rendered with the
81 * selection highlighted; otherwise false
82 * @param hasFocus if true, render cell appropriately. For
83 * example, put a special border on the cell, if
84 * the cell can be edited, render in the color used
85 * to indicate editing
86 * @param row the row index of the cell being drawn. When
87 * drawing the header, the value of
88 * <code>row</code> is -1
89 * @param column the column index of the cell being drawn
90 * @see javax.swing.JComponent#isPaintingForPrint()
91 */
92 Component getTableCellRendererComponent(JTable table, Object value,
93 boolean isSelected, boolean hasFocus, int row, int column);
94 }
|