Class DefaultTableCellRenderer

javax.swing.table.DefaultTableCellRenderer

All Implemented Interfaces:: ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants, TableCellRenderer

Direct Known Subclasses:: DefaultTableCellRenderer.UIResource

public class DefaultTableCellRenderer extends JLabel implements TableCellRenderer, Serializable

The standard class for rendering (displaying) individual cells in a JTable.

Implementation Note: This class inherits from JLabel, a standard component class. However JTable employs a unique mechanism for rendering its cells and therefore requires some slightly modified behavior from its cell renderer. The table class defines a single cell renderer and uses it as a as a rubber-stamp for rendering all cells in the table; it renders the first cell, changes the contents of that cell renderer, shifts the origin to the new location, re-draws it, and so on. The standard JLabel component was not designed to be used this way and we want to avoid triggering a revalidate each time the cell is drawn. This would greatly decrease performance because the revalidate message would be passed up the hierarchy of the container to determine whether any other components would be affected. As the renderer is only parented for the lifetime of a painting operation we similarly want to avoid the overhead associated with walking the hierarchy for painting operations. So this class overrides the validate, invalidate, revalidate, repaint, and firePropertyChange methods to be no-ops and override the isOpaque method solely to improve performance. If you write your own renderer, please keep this performance consideration in mind.

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.

See Also:

JTable

Nested Class Summary

Modifier and Type	Class	Description
`static class`	`DefaultTableCellRenderer.UIResource`	A subclass of `DefaultTableCellRenderer` that implements `UIResource`.

Nested classes/interfaces declared in class javax.swing.JLabel

JLabel.AccessibleJLabel

Nested classes/interfaces declared in class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces declared in class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces declared in class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Modifier and Type	Field	Description
`protected static Border`	`noFocusBorder`	A border without focus.

Fields declared in class javax.swing.JLabel

labelFor

Fields declared in class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields declared in class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields declared in interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields declared in interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructor	Description
`DefaultTableCellRenderer()`	Creates a default table cell renderer.

Method Summary

Modifier and Type	Method	Description
`void`	`firePropertyChange(String propertyName, boolean oldValue, boolean newValue)`	Overridden for performance reasons.
`protected void`	`firePropertyChange(String propertyName, Object oldValue, Object newValue)`	Overridden for performance reasons.
`Component`	`getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column)`	Returns the default table cell renderer.
`void`	`invalidate()`	Overridden for performance reasons.
`boolean`	`isOpaque()`	Overridden for performance reasons.
`void`	`repaint()`	Overridden for performance reasons.
`void`	`repaint(long tm, int x, int y, int width, int height)`	Overridden for performance reasons.
`void`	`repaint(Rectangle r)`	Overridden for performance reasons.
`void`	`revalidate()`	Overridden for performance reasons.
`void`	`setBackground(Color c)`	Overrides `JComponent.setBackground` to assign the unselected-background color to the specified color.
`void`	`setForeground(Color c)`	Overrides `JComponent.setForeground` to assign the unselected-foreground color to the specified color.
`protected void`	`setValue(Object value)`	Sets the `String` object for the cell being rendered to `value`.
`void`	`updateUI()`	Notification from the `UIManager` that the look and feel [L&F] has changed.
`void`	`validate()`	Overridden for performance reasons.

Methods declared in class javax.swing.JLabel

checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPosition

Methods declared in class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods declared in class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validateTree

Methods declared in class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

noFocusBorder

protected static Border noFocusBorder

A border without focus.

Constructor Details

DefaultTableCellRenderer

public DefaultTableCellRenderer()

Creates a default table cell renderer.

Method Details

setForeground

public void setForeground(Color c)

Overrides JComponent.setForeground to assign the unselected-foreground color to the specified color.

Overrides:

setForeground in class JComponent

Parameters:

c - set the foreground color to this value

See Also:

Component.getForeground()

setBackground

public void setBackground(Color c)

Overrides JComponent.setBackground to assign the unselected-background color to the specified color.

Overrides:

setBackground in class JComponent

Parameters:

c - set the background color to this value

See Also:

updateUI

public void updateUI()

Notification from the UIManager that the look and feel [L&F] has changed. Replaces the current UI object with the latest version from the UIManager.

Overrides:

updateUI in class JLabel

See Also:

JComponent.updateUI()

getTableCellRendererComponent

public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column)

Returns the default table cell renderer.

During a printing operation, this method will be called with isSelected and hasFocus values of false to prevent selection and focus from appearing in the printed output. To do other customization based on whether or not the table is being printed, check the return value from JComponent.isPaintingForPrint().

Specified by:

getTableCellRendererComponent in interface TableCellRenderer

Parameters:

table - the JTable

value - the value to assign to the cell at [row, column]

isSelected - true if cell is selected

hasFocus - true if cell has focus

row - the row of the cell to render

column - the column of the cell to render

Returns:

the default table cell renderer

See Also:

JComponent.isPaintingForPrint()

isOpaque

public boolean isOpaque()

Overridden for performance reasons. See the Implementation Note for more information.

Overrides:

isOpaque in class JComponent

Returns:

true if this component is completely opaque

See Also:

JComponent.setOpaque(boolean)

invalidate

public void invalidate()

Overridden for performance reasons. See the Implementation Note for more information.

Overrides:

invalidate in class Container

Since:

1.5

See Also:

validate

public void validate()

Overridden for performance reasons. See the Implementation Note for more information.

Overrides:

validate in class Container

See Also:

revalidate

public void revalidate()

Overridden for performance reasons. See the Implementation Note for more information.

Overrides:

revalidate in class JComponent

See Also:

repaint

public void repaint(long tm, int x, int y, int width, int height)

Overridden for performance reasons. See the Implementation Note for more information.

Overrides:

repaint in class JComponent

Parameters:

tm - this parameter is not used

x - the x value of the dirty region

y - the y value of the dirty region

width - the width of the dirty region

height - the height of the dirty region

See Also:

repaint

public void repaint(Rectangle r)

Overridden for performance reasons. See the Implementation Note for more information.

Overrides:

repaint in class JComponent

Parameters:

r - a Rectangle containing the dirty region

See Also:

repaint

public void repaint()

Overridden for performance reasons. See the Implementation Note for more information.

Overrides:

repaint in class Component

Since:

1.5

See Also:

Component.update(Graphics)

firePropertyChange

protected void firePropertyChange(String propertyName, Object oldValue, Object newValue)

Overridden for performance reasons. See the Implementation Note for more information.

Overrides:: firePropertyChange in class Component
Parameters:: propertyName - the property whose value has changed; oldValue - the property's previous value; newValue - the property's new value

firePropertyChange

public void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)

Overridden for performance reasons. See the Implementation Note for more information.

Overrides:: firePropertyChange in class JComponent
Parameters:: propertyName - the property whose value has changed; oldValue - the property's previous value; newValue - the property's new value

setValue

protected void setValue(Object value)

Sets the String object for the cell being rendered to value.

Parameters:

value - the string value for this cell; if value is null it sets the text value to an empty string

See Also:

JLabel.setText(java.lang.String)

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/swing/table/DefaultTableCellRenderer.html