Class RadiancePanelTreeCellRenderer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.pushingpixels.radiance.theming.api.renderer.RadiancePanelTreeCellRenderer

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, TreeCellRenderer

public abstract class RadiancePanelTreeCellRenderer
extends JPanel
implements TreeCellRenderer

Base class for tree renderers that are more complex than what is provided by RadianceDefaultTreeCellRenderer. Extend this class to have consistent highlight visuals and animations under all Radiance skins. The flow of layout and data is:

• In the constructor, add all sub-components to your renderer and define the layout logic.
• In bindData(JTree, Object, int) bind the relevant data fields to those sub-components.
• Use registerThemeAwareLabelsWithText(JLabel...) in the constructor to "mark" those sub-component labels that should participate in highlight animations on their text based on the current state (rollover, selection, etc). In case a specific label is using a fixed foreground / text color for some of the rows in your tree, use registerThemeAwareLabelsWithText(JLabel...) and unregisterThemeAwareLabelsWithText(JLabel...) in onPreRender(JTree, Object, int) instead of in the constructor.
• Use registerThemeAwareLabelWithIcon(JLabel, RadianceIcon.Factory, Dimension) in the constructor to "mark" those sub-component labels that should participate in highlight animations on their icons based on the current state (rollover, selection, etc). In case a specific label is using a fixed icon for some of the rows in your tree or different icon sources for different rows, use registerThemeAwareLabelWithIcon(JLabel, RadianceIcon.Factory, Dimension) and unregisterThemeAwareLabelWithIcon(JLabel) in onPreRender(JTree, Object, int) instead of in the constructor.

Note that getTreeCellRendererComponent(JTree, Object, boolean, boolean, boolean, int, boolean) in this class is marked as final and can not be overriden in the application code.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	RadiancePanelTreeCellRenderer.IconData

Nested classes/interfaces inherited from class JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

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

Field Summary

Fields

Modifier and Type	Field	Description
private Set<JLabel>	themeAwareLabels
private Map<JLabel, RadiancePanelTreeCellRenderer.IconData>	themeAwareLabelsWithIcons

Fields inherited from class JComponent

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

Fields inherited from class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
RadiancePanelTreeCellRenderer()

Method Summary

Modifier and Type	Method	Description
protected abstract void	bindData(JTree tree, Object value, int row)
private ContainerColorTokens	getContainerTokensForState(JTree tree, RadianceTreeUI ui, ComponentState activeState)
Component	getTreeCellRendererComponent(JTree tree, Object value, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus)
protected void	onPreRender(JTree tree, Object value, int row)
protected void	registerThemeAwareLabelsWithText(JLabel... labels)
protected void	registerThemeAwareLabelWithIcon(JLabel label, RadianceIcon.Factory radianceIconFactory, Dimension iconDimension)
protected void	unregisterThemeAwareLabelsWithText(JLabel... labels)
protected void	unregisterThemeAwareLabelWithIcon(JLabel label)

Methods inherited from class JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, 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, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class 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, invalidate, 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, validate, validateTree

Methods inherited from class 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, imageUpdate, 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, 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 inherited from class Object

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

Field Details

themeAwareLabels

private Set<JLabel> themeAwareLabels

themeAwareLabelsWithIcons

private Map<JLabel, RadiancePanelTreeCellRenderer.IconData> themeAwareLabelsWithIcons

Constructor Details

RadiancePanelTreeCellRenderer

public RadiancePanelTreeCellRenderer()

Method Details

registerThemeAwareLabelsWithText

protected void registerThemeAwareLabelsWithText(JLabel... labels)

unregisterThemeAwareLabelsWithText

protected void unregisterThemeAwareLabelsWithText(JLabel... labels)

registerThemeAwareLabelWithIcon

protected void registerThemeAwareLabelWithIcon(JLabel label,
 RadianceIcon.Factory radianceIconFactory,
 Dimension iconDimension)

unregisterThemeAwareLabelWithIcon

protected void unregisterThemeAwareLabelWithIcon(JLabel label)

getTreeCellRendererComponent

public Component getTreeCellRendererComponent(JTree tree,
 Object value,
 boolean selected,
 boolean expanded,
 boolean leaf,
 int row,
 boolean hasFocus)

Specified by:

getTreeCellRendererComponent in interface TreeCellRenderer

bindData

protected abstract void bindData(JTree tree,
 Object value,
 int row)

onPreRender

protected void onPreRender(JTree tree,
 Object value,
 int row)

getContainerTokensForState

private ContainerColorTokens getContainerTokensForState(JTree tree,
 RadianceTreeUI ui,
 ComponentState activeState)