com.ehsbe.commons.gui.util
Class ObjectTableCellRenderer

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JLabel
                  javax.swing.table.DefaultTableCellRenderer
                      com.ehsbe.commons.gui.util.ObjectTableCellRenderer

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants, TableCellRenderer

Direct Known Subclasses:

NumberTableCellRenderer

public class ObjectTableCellRenderer
extends DefaultTableCellRenderer

A renderer, which allows one to query the table model for its state and rendering an appropriate border or colored text.

Version:

$Revision: 432 $

Author:

Jens Elkner

See Also:

CellTableThreshold, Serialized Form

Nested Class Summary

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

DefaultTableCellRenderer.UIResource

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

JLabel.AccessibleJLabel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

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

Field Summary

protected static CompoundBorder	ALERT_BORDER default border to be used for cells in alert state - the outer border has to be a line border and should match the insets of EMPTY_BORDER
protected static Border	EMPTY_BORDER default border to use
protected static CompoundBorder	WARN_BORDER default border to be used for cells in warn state - the outer border has to be a line border and should match the insets of EMPTY_BORDER

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

ObjectTableCellRenderer()
Default Renderer with default borders.

ObjectTableCellRenderer(Border border)
Default Renderer with the given border.

Method Summary

Border	getAlertBorder() Get the border, which should be used, if the given cell is in alert state.
Border	getBorder() Get the default Border for this renderer, used to draw the cell in normal state.
Component	getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column)
Border	getWarnBorder() Get the border, which should be used, if the given cell is in warning state.
boolean	isIgnoreState() Set whether states of the cell should be ignored.
void	setAlertBorder(Border alertBorder) Set the border, which should be used, if the given cell is in alert state.
void	setBorder(Border border) Set the default Border for this renderer, used to draw the cell in normal state.
void	setIgnoreState(boolean ignoreState) Set whether states of the cell should be obtained and the text or border should be decorated, depending on the state.
protected void	setValue(Object value)
void	setWarnBorder(Border warnBorder) Set the border, which should be used, if the given cell is in warn state.

Methods inherited from class javax.swing.table.DefaultTableCellRenderer

firePropertyChange, firePropertyChange, invalidate, isOpaque, repaint, repaint, repaint, revalidate, setBackground, setForeground, 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, 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, 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, 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, transferFocusBackward, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_BORDER

protected static final Border EMPTY_BORDER

default border to use

WARN_BORDER

protected static CompoundBorder WARN_BORDER

default border to be used for cells in warn state - the outer border has to be a line border and should match the insets of EMPTY_BORDER

ALERT_BORDER

protected static CompoundBorder ALERT_BORDER

default border to be used for cells in alert state - the outer border has to be a line border and should match the insets of EMPTY_BORDER

Constructor Detail

ObjectTableCellRenderer

public ObjectTableCellRenderer()

Default Renderer with default borders.

ObjectTableCellRenderer

public ObjectTableCellRenderer(Border border)

Default Renderer with the given border.

Parameters:

border - border to set. If null, default borders will be used for normal, warn and alert states.

See Also:

setIgnoreState(boolean)

Method Detail

getTableCellRendererComponent

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

Specified by:

getTableCellRendererComponent in interface TableCellRenderer

Overrides:

getTableCellRendererComponent in class DefaultTableCellRenderer

setValue

protected void setValue(Object value)

Overrides:

setValue in class DefaultTableCellRenderer

getAlertBorder

public Border getAlertBorder()

Get the border, which should be used, if the given cell is in alert state.

Returns:

the alertBorder or null if not set.

setAlertBorder

public void setAlertBorder(Border alertBorder)

Set the border, which should be used, if the given cell is in alert state. Ignored if ignore state is set. Otherwise, if this null, the text gets decorated instead of the border.

Parameters:

alertBorder - alertBorder to set. Might be null.

getWarnBorder

public Border getWarnBorder()

Get the border, which should be used, if the given cell is in warning state.

Returns:

the warnBorder or null if not set.

setWarnBorder

public void setWarnBorder(Border warnBorder)

Set the border, which should be used, if the given cell is in warn state. Ignored if ignore state is set. Otherwise, if this null, the text gets decorated instead of the border.

Parameters:

warnBorder - warnBorder to set. Might be null.

setBorder

public void setBorder(Border border)

Set the default Border for this renderer, used to draw the cell in normal state.

Overrides:

setBorder in class JComponent

Parameters:

border - border to set.

getBorder

public Border getBorder()

Get the default Border for this renderer, used to draw the cell in normal state.

Overrides:

getBorder in class JComponent

Returns:

the border or null if not set.

isIgnoreState

public boolean isIgnoreState()

Set whether states of the cell should be ignored.

Returns:

true if the state of cells gets ignored.

setIgnoreState

public void setIgnoreState(boolean ignoreState)

Set whether states of the cell should be obtained and the text or border should be decorated, depending on the state.

Parameters:

ignoreState - if true, dont ask and render always as in the normal state.

See Also:

setBorder(Border), setWarnBorder(Border), setAlertBorder(Border)