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 java.beans.XMLEncoder.

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected class	CellRendererPane.AccessibleCellRendererPane This class implements accessibility support for the `CellRendererPane` class.

Field Summary

Modifier and Type	Field and Description
protected AccessibleContext	accessibleContext Hides java.awt.Component.accessibleContext. `AccessibleContext` associated with this `CellRendererPan`

Constructor Summary

Access	Constructor and Description
public	CellRendererPane() Construct a CellRendererPane object.

Method Summary

Modifier and Type	Method and Description
protected void	addImpl(Component x, Object constraints, int index) Overrides java.awt.Container.addImpl. If the specified component is already a child of this then we don't bother doing anything - stacking order doesn't matter for cell renderer components (CellRendererPane doesn't paint anyway).
public AccessibleContext	Returns: an AccessibleCellRendererPane that serves as the AccessibleContext of this CellRendererPane getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext associated with this CellRendererPane.
public void	invalidate() Overrides java.awt.Container.invalidate. Overridden to avoid propagating a invalidate up the tree when the cell renderer child is configured.
public void	paint(Graphics g) Overrides java.awt.Container.paint. Shouldn't be called.
public void	paintComponent(Graphics the `Graphics` object to draw on g, Component the `Component` to draw c, Container the `Container` component actually drawn on p, int an int specifying the left side of the area draw in, in pixels, measured from the left edge of the graphics context x, int an int specifying the top of the area to draw in, in pixels measured down from the top edge of the graphics context y, int an int specifying the width of the area draw in, in pixels w, int an int specifying the height of the area draw in, in pixels h, boolean if true, component `c` will be validated before being painted shouldValidate) Paint a cell renderer component c on graphics object g.
public void	paintComponent(Graphics the `Graphics` object to draw on g, Component the `Component` to draw c, Container the `Container` component actually drawn on p, int an int specifying the left side of the area draw in, in pixels, measured from the left edge of the graphics context x, int an int specifying the top of the area to draw in, in pixels measured down from the top edge of the graphics context y, int an int specifying the width of the area draw in, in pixels w, int an int specifying the height of the area draw in, in pixels h) Calls this.paintComponent(g, c, p, x, y, w, h, false).
public void	paintComponent(Graphics the `Graphics` object to draw on g, Component the `Component` to draw c, Container the `Container` component actually drawn on p, Rectangle the `Rectangle` to draw in r) Calls this.paintComponent(g, c, p, r.x, r.y, r.width, r.height) where `r` is the input `Rectangle` parameter.
public void	update(Graphics g) Overrides java.awt.Container.update. Shouldn't be called.
private void	writeObject(ObjectOutputStream s) Hides java.awt.Container.writeObject. Serializes this `Container` to the specified `ObjectOutputStream`.

Inherited from java.awt.Container:: add add add add add addContainerListener addNotify addPropertyChangeListener addPropertyChangeListener applyComponentOrientation areFocusTraversalKeysSet countComponents deliverEvent doLayout findComponentAt findComponentAt getAlignmentX getAlignmentY getComponent getComponentAt getComponentAt getComponentCount getComponents getComponentZOrder getContainerListeners getFocusTraversalKeys getFocusTraversalPolicy getInsets getLayout getListeners getMaximumSize getMinimumSize getMousePosition getPreferredSize insets isAncestorOf isFocusCycleRoot isFocusCycleRoot isFocusTraversalPolicyProvider isFocusTraversalPolicySet isValidateRoot layout list list locate minimumSize paintComponents paramString preferredSize print printComponents processContainerEvent processEvent remove remove removeAll removeContainerListener removeNotify setComponentZOrder setFocusCycleRoot setFocusTraversalKeys setFocusTraversalPolicy setFocusTraversalPolicyProvider setFont setLayout transferFocusDownCycle validate validateTree

Field Detail

accessibleContext back to summary

accessibleContext	back to summary
protected AccessibleContext accessibleContext Hides java.awt.Component.accessibleContext. `AccessibleContext` associated with this `CellRendererPan`

protected AccessibleContext accessibleContext

Hides java.awt.Component.accessibleContext.

AccessibleContext associated with this CellRendererPan

Constructor Detail

CellRendererPane	back to summary
public CellRendererPane() Construct a CellRendererPane object.

Method Detail

addImpl	back to summary
protected void addImpl(Component x, Object constraints, int index) Overrides java.awt.Container.addImpl. If the specified component is already a child of this then we don't bother doing anything - stacking order doesn't matter for cell renderer components (CellRendererPane doesn't paint anyway).

addImpl

back to summary

protected void addImpl(Component x, Object constraints, int index)

Overrides java.awt.Container.addImpl.

If the specified component is already a child of this then we don't bother doing anything - stacking order doesn't matter for cell renderer components (CellRendererPane doesn't paint anyway).

getAccessibleContext	back to summary
public AccessibleContext getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.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. Returns:AccessibleContext an AccessibleCellRendererPane that serves as the AccessibleContext of this CellRendererPane

getAccessibleContext

back to summary

public AccessibleContext getAccessibleContext()

Overrides java.awt.Component.getAccessibleContext.

Implements javax.accessibility.Accessible.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.

Returns:AccessibleContext: an AccessibleCellRendererPane that serves as the AccessibleContext of this CellRendererPane

invalidate	back to summary
public void invalidate() Overrides java.awt.Container.invalidate. Overridden to avoid propagating a invalidate up the tree when the cell renderer child is configured.

invalidate

back to summary

public void invalidate()

Overrides java.awt.Container.invalidate.

Overridden to avoid propagating a invalidate up the tree when the cell renderer child is configured.

paint	back to summary
public void paint(Graphics g) Overrides java.awt.Container.paint. Shouldn't be called.

paint

back to summary

public void paint(Graphics g)

Overrides java.awt.Container.paint.

Shouldn't be called.

paintComponent back to summary

paintComponent	back to summary
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:Graphics the `Graphics` object to draw on c:Component the `Component` to draw p:Container the `Container` component actually drawn on x:int an int specifying the left side of the area draw in, in pixels, measured from the left edge of the graphics context y:int an int specifying the top of the area to draw in, in pixels measured down from the top edge of the graphics context w:int an int specifying the width of the area draw in, in pixels h:int an int specifying the height of the area draw in, in pixels shouldValidate:boolean if true, component `c` will be validated before being painted

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:Graphics: the Graphics object to draw on
c:Component: the Component to draw
p:Container: the Container component actually drawn on
x:int: an int specifying the left side of the area draw in, in pixels, measured from the left edge of the graphics context
y:int: an int specifying the top of the area to draw in, in pixels measured down from the top edge of the graphics context
w:int: an int specifying the width of the area draw in, in pixels
h:int: an int specifying the height of the area draw in, in pixels
shouldValidate:boolean: if true, component c will be validated before being painted

paintComponent back to summary

paintComponent	back to summary
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:Graphics the `Graphics` object to draw on c:Component the `Component` to draw p:Container the `Container` component actually drawn on x:int an int specifying the left side of the area draw in, in pixels, measured from the left edge of the graphics context y:int an int specifying the top of the area to draw in, in pixels measured down from the top edge of the graphics context w:int an int specifying the width of the area draw in, in pixels h:int an int specifying the height of the area draw in, in pixels

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:Graphics: the Graphics object to draw on
c:Component: the Component to draw
p:Container: the Container component actually drawn on
x:int: an int specifying the left side of the area draw in, in pixels, measured from the left edge of the graphics context
y:int: an int specifying the top of the area to draw in, in pixels measured down from the top edge of the graphics context
w:int: an int specifying the width of the area draw in, in pixels
h:int: an int specifying the height of the area draw in, in pixels

paintComponent back to summary

paintComponent	back to summary
public void paintComponent(Graphics g, Component c, Container p, Rectangle r) Calls this.paintComponent(g, c, p, r.x, r.y, r.width, r.height) where `r` is the input `Rectangle` parameter. Parameters g:Graphics the `Graphics` object to draw on c:Component the `Component` to draw p:Container the `Container` component actually drawn on r:Rectangle the `Rectangle` to draw in

public void paintComponent(Graphics g, Component c, Container p, Rectangle r)

Calls this.paintComponent(g, c, p, r.x, r.y, r.width, r.height) where r is the input Rectangle parameter.

Parameters

g:Graphics: the Graphics object to draw on
c:Component: the Component to draw
p:Container: the Container component actually drawn on
r:Rectangle: the Rectangle to draw in

update	back to summary
public void update(Graphics g) Overrides java.awt.Container.update. Shouldn't be called.

update

back to summary

public void update(Graphics g)

Overrides java.awt.Container.update.

Shouldn't be called.

writeObject back to summary

writeObject	back to summary
private void writeObject(ObjectOutputStream s) throws IOException Hides java.awt.Container.writeObject. Doc from java.awt.Container.writeObject. Serializes this `Container` to the specified `ObjectOutputStream`. Writes default serializable fields to the stream. Writes a list of serializable ContainerListener(s) as optional data. The non-serializable ContainerListener(s) are detected and no attempt is made to serialize them. Write this Container's FocusTraversalPolicy if and only if it is Serializable; otherwise, `null` is written. Annotations @Serial Exceptions IOException: if an I/O error occurs

private void writeObject(ObjectOutputStream s) throws IOException

Hides java.awt.Container.writeObject.

Doc from java.awt.Container.writeObject.

Serializes this Container to the specified ObjectOutputStream.

Writes default serializable fields to the stream.
Writes a list of serializable ContainerListener(s) as optional data. The non-serializable ContainerListener(s) are detected and no attempt is made to serialize them.
Write this Container's FocusTraversalPolicy if and only if it is Serializable; otherwise, null is written.

Annotations

@Serial

Exceptions

IOException:: if an I/O error occurs

javax.swing back to summary

protected Class CellRendererPane.AccessibleCellRendererPane

Class Inheritance

extends AccessibleAWTContainer

java.lang.Object
javax.accessibility.AccessibleContext
java.awt.Component.AccessibleAWTComponent
java.awt.Container.AccessibleAWTContainer
javax.swing.CellRendererPane.AccessibleCellRendererPane

This class implements accessibility support for the CellRendererPane class.

Field Summary

Inherited from java.awt.Container.AccessibleAWTContainer:: accessibleContainerHandler

Constructor Summary

Access	Constructor and Description
protected	AccessibleCellRendererPane() Constructs an `AccessibleCellRendererPane`.

Method Summary

Modifier and Type	Method and Description
public AccessibleRole	Returns: an instance of AccessibleRole describing the role of the object getAccessibleRole() Overrides java.awt.Component.AccessibleAWTComponent.getAccessibleRole. Get the role of this object.

Inherited from java.awt.Container.AccessibleAWTContainer:: addPropertyChangeListener getAccessibleAt getAccessibleChild getAccessibleChildrenCount removePropertyChangeListener

Constructor Detail

AccessibleCellRendererPane	back to summary
protected AccessibleCellRendererPane() Constructs an `AccessibleCellRendererPane`.

Method Detail

getAccessibleRole back to summary

getAccessibleRole	back to summary
public AccessibleRole getAccessibleRole() Overrides java.awt.Component.AccessibleAWTComponent.getAccessibleRole. Get the role of this object. Returns:AccessibleRole an instance of AccessibleRole describing the role of the object See Also `AccessibleRole`

public AccessibleRole getAccessibleRole()

Overrides java.awt.Component.AccessibleAWTComponent.getAccessibleRole.

Get the role of this object.

Returns:AccessibleRole: an instance of AccessibleRole describing the role of the object
See Also: AccessibleRole

public Class CellRendererPane

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class CellRendererPane.AccessibleCellRendererPane

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail