com.lf.commons.table

Class TablePanelCellRenderer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLabel

javax.swing.table.DefaultTableCellRenderer

com.lf.commons.table.TablePanelCellRenderer

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.SwingConstants, javax.swing.table.TableCellRenderer

public class TablePanelCellRenderer
extends javax.swing.table.DefaultTableCellRenderer

Implements the TableCellRenderer interface for the TablePanel class.

This renderer is called whenever a cell from the parent class is to be rendered. The user may specify specific renderers on a per-column basis instead of the per-class basis provided by the JTable class. This is more flexible since large tables may have one and the same column classes used by multiple columns.

Also this class is not nailed to fixed types per colum but calls appropriate sub-renderers base don the object type to be renderer. This means that cells of one single column may contain objects of different type. If the user registered special renderer for this column, then these renderers are delegated to do the work.

Since:

1.6

Version:

$Revision: 1.18 $, $Date: 2016/01/01 15:43:01 $

Author:

Axel Schwolow

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.table.DefaultTableCellRenderer

javax.swing.table.DefaultTableCellRenderer.UIResource

Nested classes/interfaces inherited from class javax.swing.JLabel

javax.swing.JLabel.AccessibleJLabel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Hashtable<java.lang.String,javax.swing.table.TableCellRenderer>	cacheDedicatedRenderers The dedicated renderers used for the various columns (optional).
protected java.util.Hashtable<java.lang.String,javax.swing.table.TableCellRenderer>	cacheDefaultRenderers Remembers the default renderers used for the table.
protected TablePanel	parent The parental component.

Fields inherited from class javax.swing.table.DefaultTableCellRenderer

noFocusBorder

Fields inherited from class javax.swing.JLabel

labelFor

Fields inherited from class javax.swing.JComponent

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

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from 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

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
TablePanelCellRenderer() Constructor method for i18n purposes only.
TablePanelCellRenderer(TablePanel parent) Constructor of this class.

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.swing.table.TableCellRenderer	chooseRenderer(java.lang.String key, java.lang.Object value) Determines a renderer for the given key.
protected javax.swing.table.TableCellRenderer	createDefaultTableCellRenderer(java.lang.Class clazz) Creates a renderer implementation instance based on a type.
protected javax.swing.table.TableCellRenderer	createDefaultTableCellRenderer(java.lang.String type) Creates a renderer implementation instance based on a type.
protected void	finalize() Clean-up method to help the gc.
protected void	flushDedicatedTableCellRenderer() Removes the dedicated cell renderer implementation instance if such is installed.
protected void	flushDefaultTableCellRenderer() Removes the shared cell renderer implementation instance if such is installed.
protected javax.swing.table.TableCellRenderer	getDedicatedTableCellRenderer(java.lang.String key) Provides the dedicated cell renderer implementation instance if such is installed.
java.awt.Component	getTableCellRendererComponent(javax.swing.JTable table, java.lang.Object value, boolean isSelected, boolean hasFocus, int row, int column) Method with rendering functionality.
protected boolean	hasDedicatedTableCellRenderer(java.lang.String type) Determines whether a dedicated cell renderer implementation instance has already been created.
protected boolean	hasDefaultTableCellRenderer(java.lang.Class clazz) Determines whether a shared cell renderer implementation instance has already been created.
protected boolean	hasDefaultTableCellRenderer(java.lang.String type) Determines whether a shared cell renderer implementation instance has already been created.
protected void	setDedicatedTableCellRenderer(java.lang.String key, javax.swing.table.TableCellRenderer renderer) Sets a cell renderer for a specific column.
protected void	updateRenderer(CellSearchHighlighter highlighter, Configuration config) Updates the renderer implementing the CellSearchHighlighter interface.
protected void	updateRenderers(Configuration config) Updates the renderers implementing the CellSearchHighlighter interface.

Methods inherited from class javax.swing.table.DefaultTableCellRenderer

firePropertyChange, firePropertyChange, invalidate, isOpaque, repaint, repaint, repaint, revalidate, setBackground, setForeground, setValue, updateUI, validate

Methods inherited from 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 inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, 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, 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 inherited from 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 inherited from 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, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

parent

protected TablePanel parent

The parental component.

cacheDefaultRenderers

protected java.util.Hashtable<java.lang.String,javax.swing.table.TableCellRenderer> cacheDefaultRenderers

Remembers the default renderers used for the table.

cacheDedicatedRenderers

protected java.util.Hashtable<java.lang.String,javax.swing.table.TableCellRenderer> cacheDedicatedRenderers

The dedicated renderers used for the various columns (optional).

Constructor Detail

TablePanelCellRenderer

public TablePanelCellRenderer()
                       throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

TablePanelCellRenderer

public TablePanelCellRenderer(TablePanel parent)

Constructor of this class.

Parameters:

parent - The parental component

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - Error indication

Since:

1.5

getTableCellRendererComponent

public java.awt.Component getTableCellRendererComponent(javax.swing.JTable table,
                                               java.lang.Object value,
                                               boolean isSelected,
                                               boolean hasFocus,
                                               int row,
                                               int column)

Method with rendering functionality.

Specified by:

getTableCellRendererComponent in interface javax.swing.table.TableCellRenderer

Overrides:

getTableCellRendererComponent in class javax.swing.table.DefaultTableCellRenderer

Parameters:

table - The table to render a cell

value - The value to display

isSelected - The selection state

hasFocus - Is it focussed?

row - The row to render

column - The column to render

Returns:

The component reference

createDefaultTableCellRenderer

protected javax.swing.table.TableCellRenderer createDefaultTableCellRenderer(java.lang.String type)

Creates a renderer implementation instance based on a type.

Parameters:

type - Fully qualified class type like "java.lang.String"

Returns:

The shared cell renderer instance, possibly null

Throws:

java.lang.NullPointerException - If type = null

Since:

1.6

See Also:

createDefaultTableCellRenderer(Class)

createDefaultTableCellRenderer

protected javax.swing.table.TableCellRenderer createDefaultTableCellRenderer(java.lang.Class clazz)

Creates a renderer implementation instance based on a type.

Parameters:

clazz - Class type

Returns:

The shared cell renderer instance, possibly null

Throws:

java.lang.NullPointerException - If clazz = null

Since:

1.6

See Also:

createDefaultTableCellRenderer(String)

flushDefaultTableCellRenderer

protected void flushDefaultTableCellRenderer()

Removes the shared cell renderer implementation instance if such is installed.

Since:

1.6

hasDefaultTableCellRenderer

protected boolean hasDefaultTableCellRenderer(java.lang.String type)

Determines whether a shared cell renderer implementation instance has already been created.

Parameters:

type - Fully qualified class type like "java.lang.String"

Returns:

Shared instance is already installed?

Throws:

java.lang.NullPointerException - If type = null

Since:

1.6

See Also:

hasDefaultTableCellRenderer(Class)

hasDefaultTableCellRenderer

protected boolean hasDefaultTableCellRenderer(java.lang.Class clazz)

Determines whether a shared cell renderer implementation instance has already been created.

Parameters:

clazz - Class type

Returns:

Shared instance is already installed?

Throws:

java.lang.NullPointerException - If clazz = null

Since:

1.6

See Also:

hasDefaultTableCellRenderer(String)

updateRenderers

protected void updateRenderers(Configuration config)

Updates the renderers implementing the CellSearchHighlighter interface.

Here, the on-the-fly highlighting feature is activated.

Parameters:

config - Configuration from the TableSearchOptionsPanel

Since:

1.6

updateRenderer

protected void updateRenderer(CellSearchHighlighter highlighter,
                  Configuration config)

Updates the renderer implementing the CellSearchHighlighter interface.

Here, the on-the-fly highlighting feature is activated.

Parameters:

highlighter - The highlighting renderer

config - Configuration from the TableSearchOptionsPanel

Since:

1.6

setDedicatedTableCellRenderer

protected void setDedicatedTableCellRenderer(java.lang.String key,
                                 javax.swing.table.TableCellRenderer renderer)

Sets a cell renderer for a specific column.

If there already is a renderer installed for the column, then the existing renderer is overwritten.

Parameters:

key - The column key (internal identifier) e.g. from SQL

renderer - The renderer for the column

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

flushDedicatedTableCellRenderer

protected void flushDedicatedTableCellRenderer()

Removes the dedicated cell renderer implementation instance if such is installed.

Since:

1.6

hasDedicatedTableCellRenderer

protected boolean hasDedicatedTableCellRenderer(java.lang.String type)

Determines whether a dedicated cell renderer implementation instance has already been created.

Parameters:

type - Fully qualified class type like "java.lang.String"

Returns:

Shared instance is already installed?

Throws:

java.lang.NullPointerException - If type = null

Since:

1.6

See Also:

hasDefaultTableCellRenderer(Class)

getDedicatedTableCellRenderer

protected javax.swing.table.TableCellRenderer getDedicatedTableCellRenderer(java.lang.String key)

Provides the dedicated cell renderer implementation instance if such is installed.

Parameters:

key - The column key (internal identifier) e.g. from SQL

Returns:

The dedicated renderer for the column, may be null

Since:

1.6

chooseRenderer

protected javax.swing.table.TableCellRenderer chooseRenderer(java.lang.String key,
                                                 java.lang.Object value)

Determines a renderer for the given key.

The dedicated renderer has priority over the default renderer here.

Parameters:

key - The column key (internal identifier) e.g. from SQL

value - The data object to be rendered

Returns:

The renderer for the column, may be null

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6