Module java.desktop
Package javax.swing

Class CellRendererPane

  • All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable, Accessible
    public class CellRendererPane
extends Container
implements Accessible
    This class is inserted in between cell renderers and the components that use them. It just exists to thwart the repaint() and invalidate() methods which would otherwise propagate up the tree when the renderer was configured. It's used by the implementations of JTable, JTree, and JList. For example, here's how CellRendererPane is used in the code the paints each row in a JList: 
       cellRendererPane = new CellRendererPane();
   ...
   Component rendererComponent = renderer.getListCellRendererComponent();
   renderer.configureListCellRenderer(dataModel.getElementAt(row), row);
   cellRendererPane.paintComponent(g, rendererComponent, this, x, y, w, h);

    A renderer component must override isShowing() and unconditionally return true to work correctly because the Swing paint does nothing for components with isShowing false.

    Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.

    Since:
    1.2
    See Also:
    Serialized Form

    • Field Detail

      • accessibleContext

        protected AccessibleContext accessibleContext
        AccessibleContext associated with this CellRendererPan

    • Constructor Detail

      • CellRendererPane

        public CellRendererPane()
        Construct a CellRendererPane object.

    • Method Detail

      • paintComponent

        public void paintComponent​(Graphics g,
                           Component c,
                           Container p,
                           int x,
                           int y,
                           int w,
                           int h,
                           boolean shouldValidate)
        Paint a cell renderer component c on graphics object g. Before the component is drawn it's reparented to this (if that's necessary), it's bounds are set to w,h and the graphics object is (effectively) translated to x,y. If it's a JComponent, double buffering is temporarily turned off. After the component is painted it's bounds are reset to -w, -h, 0, 0 so that, if it's the last renderer component painted, it will not start consuming input. The Container p is the component we're actually drawing on, typically it's equal to this.getParent(). If shouldValidate is true the component c will be validated before painted.
        Parameters:
        g - the Graphics object to draw on
        c - the Component to draw
        p - the Container component actually drawn on
        x - an int specifying the left side of the area draw in, in pixels, measured from the left edge of the graphics context
        y - an int specifying the top of the area to draw in, in pixels measured down from the top edge of the graphics context
        w - an int specifying the width of the area draw in, in pixels
        h - an int specifying the height of the area draw in, in pixels
        shouldValidate - if true, component c will be validated before being painted

      • paintComponent

        public void paintComponent​(Graphics g,
                           Component c,
                           Container p,
                           int x,
                           int y,
                           int w,
                           int h)
        Calls this.paintComponent(g, c, p, x, y, w, h, false).
        Parameters:
        g - the Graphics object to draw on
        c - the Component to draw
        p - the Container component actually drawn on
        x - an int specifying the left side of the area draw in, in pixels, measured from the left edge of the graphics context
        y - an int specifying the top of the area to draw in, in pixels measured down from the top edge of the graphics context
        w - an int specifying the width of the area draw in, in pixels
        h - an int specifying the height of the area draw in, in pixels

      • paintComponent

        public void paintComponent​(Graphics g,
                           Component c,
                           Container p,
                           Rectangle r)
        Calls this.paintComponent() with the rectangles x,y,width,height fields.
        Parameters:
        g - the Graphics object to draw on
        c - the Component to draw
        p - the Container component actually drawn on
        r - the Rectangle to draw in

      • getAccessibleContext

        public AccessibleContext getAccessibleContext()
        Gets the AccessibleContext associated with this CellRendererPane. For CellRendererPanes, the AccessibleContext takes the form of an AccessibleCellRendererPane. A new AccessibleCellRendererPane instance is created if necessary.
        Specified by:
        getAccessibleContext in interface Accessible
        Overrides:
        getAccessibleContext in class Component
        Returns:
        an AccessibleCellRendererPane that serves as the AccessibleContext of this CellRendererPane