ilog.views.util.swing.tree

Class IlvDefaultTreeCellRenderer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLabel

javax.swing.tree.DefaultTreeCellRenderer

ilog.views.util.swing.tree.IlvDefaultTreeCellRenderer

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants, TreeCellRenderer

Direct Known Subclasses:

IlvDefaultJTreeCellRenderer

public class IlvDefaultTreeCellRenderer
extends DefaultTreeCellRenderer

IlvDefaultTreeCellRenderer is an extension of the Swing DefaultTreeCellRenderer class that provides the following additional capabilities:

• The renderer can have its width automatically track the width of the tree. The usefulness of this feature is explained in more detail in the Renderer Auto-Width Notes below.
• If an explicit tooltip has not been explicitly set on the renderer, then the renderer uses the text value being rendered as its tooltip.
• Implement a fix for JavaSoft bug 4373575.
• The rendering of nodes that have an empty text value has been greatly optimized

Renderer Auto-Width Notes: The following paragraphs describe standard tree rendering behavior and then the auto-width enhancement provided by this class. First, it is important to understand the standard sizing behavior of the Swing JTree and DefaultTreeCellRenderer classes. JTree computes its preferred size from the preferred sizes of all its cell renderers. The preferred width of the tree will always be the maximum preferred width of all its cell renderers, plus some additional space for the expand/collapse icons, nested indentation, and so on. Similarly, the preferred height of the tree will be the sum of the preferred heights of all its cell renderers. However, if an explicit row height is set on the tree, the tree uses it to calculate its preferred height instead. Because DefaultTreeCellRenderer is a JLabel, it computes its preferred size from the font and string it is displaying. Immediately before a tree renders a cell, the tree explicitly sizes the renderer to the renderer's preferred size.

When a JTree is placed in a default JScrollPane, the scrollpane sizes the tree to its preferred size. From the tree's perspective, all of its cells are visible. The scrollpane can then position the tree so any portion is visible in the viewport. Cells that are positioned outside of the viewport appear truncated at the viewport edges. When a JTree is placed in another type of container that does not observe the tree's preferred size, rendering issues may arise. If the tree is sized to be narrower than its preferred width, the tree will still size each DefaultTreeCellRenderer to the renderer's preferred width and the cell will appear truncated at the container's right edge. This class provides an alternative behavior in this last case. If auto-width is enabled (it is by default), the renderer will extend or shrink its right edge to match the right edge of the tree. If the tree is narrower than the preferred width of the renderer, the renderer will use the standard JLabel technique of appending ellipses (i.e. "...") to the truncated text. This provides a better appearance than merely truncating the text rendition, possibly in mid-letter.

Since:

JViews 6.5

See Also:

Serialized Form

Nested Class Summary

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

Fields inherited from class javax.swing.tree.DefaultTreeCellRenderer

backgroundNonSelectionColor, backgroundSelectionColor, borderSelectionColor, closedIcon, hasFocus, leafIcon, openIcon, selected, textNonSelectionColor, textSelectionColor

Fields inherited from class javax.swing.JLabel

labelFor

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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
IlvDefaultTreeCellRenderer() Creates a new IlvDefaultTreeCellRenderer.

Method Summary

Modifier and Type	Method and Description
void	addNotify() Notifies this component that it now has a parent component.
Font	getFont() Returns the font of the renderer.
Dimension	getPreferredSize() Returns the preferred size of the renderer.
String	getToolTipText() Returns the tooltip string for the renderer.
boolean	isAutoWidthFromTree() Returns whether the renderer sets its width to the width of the tree.
void	paint(Graphics g) Paints the rendered value.
void	setAutoWidthFromTree(boolean enable) Sets whether the renderer sets its width to the width of the tree.
void	setBounds(int x, int y, int w, int h) Moves and resizes this component.

Methods inherited from class javax.swing.tree.DefaultTreeCellRenderer

firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackgroundNonSelectionColor, getBackgroundSelectionColor, getBorderSelectionColor, getClosedIcon, getDefaultClosedIcon, getDefaultLeafIcon, getDefaultOpenIcon, getLeafIcon, getOpenIcon, getTextNonSelectionColor, getTextSelectionColor, getTreeCellRendererComponent, invalidate, repaint, repaint, repaint, revalidate, setBackground, setBackgroundNonSelectionColor, setBackgroundSelectionColor, setBorderSelectionColor, setClosedIcon, setFont, setLeafIcon, setOpenIcon, setTextNonSelectionColor, setTextSelectionColor, 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, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, 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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, 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, setForeground, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, 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, 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, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IlvDefaultTreeCellRenderer

public IlvDefaultTreeCellRenderer()

Creates a new IlvDefaultTreeCellRenderer.

Method Detail

isAutoWidthFromTree

public boolean isAutoWidthFromTree()

Returns whether the renderer sets its width to the width of the tree. The default value is true. See the class implementation notes for more information.

See Also:

setAutoWidthFromTree(boolean)

setAutoWidthFromTree

public void setAutoWidthFromTree(boolean enable)

Sets whether the renderer sets its width to the width of the tree. The default value is true. See the class implementation notes for more information.

Parameters:

enable - Set true to enable auto-width mode or false to disable and revert to standard DefaultTreeCellRenderer behavior.

See Also:

isAutoWidthFromTree()

setBounds

public void setBounds(int x,
                      int y,
                      int w,
                      int h)

Moves and resizes this component. This method is invoked by the JTree immediately before it asks the renderer to paint. This method is overridden to support auto-width mode. See the class implementation notes for more information.

Overrides:

setBounds in class Component

Parameters:

x - The new x-coordinate.

y - The new y-coordinate.

w - The new width.

h - The new height.

getPreferredSize

public Dimension getPreferredSize()

Returns the preferred size of the renderer. This method is overridden to optimize the case when rendering empty string values.

Overrides:

getPreferredSize in class DefaultTreeCellRenderer

Returns:

The preferred size of the renderer.

Since:

JViews 8.5

paint

public void paint(Graphics g)

Paints the rendered value. This method is overridden to support auto-width mode. See the class implementation notes for more information.

Overrides:

paint in class DefaultTreeCellRenderer

Parameters:

g - The graphics context to use for painting.

addNotify

public void addNotify()

Notifies this component that it now has a parent component. This method is overridden to support auto-width mode. See the class implementation notes for more information.

Overrides:

addNotify in class JComponent

getFont

public Font getFont()

Returns the font of the renderer. If a font has not been explicitly set for this renderer, the font of it's parent JTree is returned. This method is overridden to fix JavaSoft bug 4373575.

Specified by:

getFont in interface MenuContainer

Overrides:

getFont in class DefaultTreeCellRenderer

getToolTipText

public String getToolTipText()

Returns the tooltip string for the renderer. This method first checks if a tooltip was explicitly set by the setToolTipText method. If no tooltip has been explicitly set, then this method returns the text value being rendered.

Overrides:

getToolTipText in class JComponent

Returns:

The tooltip text.