echopoint.tree
Class DefaultTreeCellRenderer

java.lang.Object
  nextapp.echo.AbstractComponent
      nextapp.echo.Label
          echopoint.tree.DefaultTreeCellRenderer

All Implemented Interfaces:

TreeCellRenderer, ReflectionSetter, java.io.Serializable, Component

public class DefaultTreeCellRenderer
extends Label
implements TreeCellRenderer, ReflectionSetter

Used to display an entry in a tree. If the tree cell value is a DefaultMutableTreeNode and its user object is a Component then the DefaultTreeCellRenderer will return null on getTreeCellRenderText and return the Component in getTreeCellRendererComponent.

Otherwise it will "cast" the cell value to a String via toString() and return a Label via the getTreeCellRenderText method. It uses the Tree's TreeIcon object to obtain an icon for "parent" and "leaf" nodes.

You can derived your own TreeCellRendererclass from this one and specify your own icons for each node if you wish.

Note that this class also has Style support so you can set appearance attributes via a Style object or the EchoPoint CSS support.

See Also:

Serialized Form

Nested Class Summary

static class

DefaultTreeCellRenderer.NestedStyleInfo Nested public static StyleInfo class.

Field Summary

static java.lang.String	STYLE_BACKGROUND_NON_SELECTION_COLOR A style constant for the Background Non Selection Color property.
static java.lang.String	STYLE_BACKGROUND_SELECTION_COLOR A style constant for the Background Selection Color property.
static java.lang.String	STYLE_TEXT_NON_SELECTION_COLOR A style constant for the Text Non Selection Color property.
static java.lang.String	STYLE_TEXT_SELECTION_COLOR A style constant for the Text Selection Color property.

Fields inherited from class nextapp.echo.Label

HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, ICON_TEXT_MARGIN_CHANGED_PROPERTY, STYLE_HORIZONTAL_ALIGNMENT, STYLE_HORIZONTAL_TEXT_POSITION, STYLE_ICON_TEXT_MARGIN, STYLE_VERTICAL_ALIGNMENT, STYLE_VERTICAL_TEXT_POSITION, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

Fields inherited from interface nextapp.echo.Component

BACKGROUND_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FONT_CHANGED_PROPERTY, FOREGROUND_CHANGED_PROPERTY, IDENTIFIER_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, SELECTABLE_CHANGED_PROPERTY, STYLE_BACKGROUND, STYLE_FONT, STYLE_FOREGROUND, UPDATE_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

DefaultTreeCellRenderer()
Creates a new instance of DefaultTreeCellRenderer.

Method Summary

void	applyStyle(Style style) Sets stylistic properties of this component based on a Style object.
Color	getBackgroundNonSelectionColor() Returns the background color to be used for non selected nodes.
Color	getBackgroundSelectionColor() Returns the color to use for the background if node is selected.
Color	getTextNonSelectionColor() Returns the color the text is drawn with when the node isn't selected.
Color	getTextSelectionColor() Returns the color the text is drawn with when the node is selected.
Component	getTreeCellRendererComponent(Tree tree, java.lang.Object node, boolean selected, boolean expanded, boolean leaf) If the value is a Component then it will be returned as is, otherwise it returns null.
Label	getTreeCellRendererText(Tree tree, java.lang.Object node, boolean sel, boolean expanded, boolean leaf) Configures the renderer based on the passed in parameters.
java.lang.Object	set(java.lang.reflect.Field field, java.lang.Object newValue) Called to save the old value of a field, set in a new value and return the old value of a field.
void	setBackgroundNonSelectionColor(Color newColor) Sets the background color to be used for non selected nodes.
void	setBackgroundSelectionColor(Color newColor) Sets the color to use for the background if node is selected.
void	setTextNonSelectionColor(Color newColor) Sets the color the text is drawn with when the node isn't selected.
void	setTextSelectionColor(Color newColor) Sets the color the text is drawn with when the node is selected.

Methods inherited from class nextapp.echo.Label

getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextMargin, getText, getVerticalAlignment, getVerticalTextPosition, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextMargin, setText, setVerticalAlignment, setVerticalTextPosition

Methods inherited from class nextapp.echo.AbstractComponent

add, add, addHierarchyListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getClientId, getComponent, getComponentCount, getComponents, getEchoInstance, getFont, getForeground, getIdentifier, getListenerList, getLocale, getParent, indexOf, init, isAncestorOf, isDifferent, isEnabled, isFocused, isRecursivelyVisible, isRegistered, isSelectableForScriptRecorder, isShowing, isVisible, processHierarchyEvent, remove, remove, removeAll, removeHierarchyListener, removePropertyChangeListener, setBackground, setClientId, setEnabled, setFocused, setFont, setForeground, setIdentifier, setLocale, setParent, setRegistered, setSelectableForScriptRecorder, setVisible, update, validate

Methods inherited from class java.lang.Object

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

Field Detail

STYLE_BACKGROUND_NON_SELECTION_COLOR

public static final java.lang.String STYLE_BACKGROUND_NON_SELECTION_COLOR

A style constant for the Background Non Selection Color property. Values of this key must be of type nextapp.echo.Color.

See Also:

Constant Field Values

STYLE_BACKGROUND_SELECTION_COLOR

public static final java.lang.String STYLE_BACKGROUND_SELECTION_COLOR

A style constant for the Background Selection Color property. Values of this key must be of type nextapp.echo.Color.

See Also:

Constant Field Values

STYLE_TEXT_NON_SELECTION_COLOR

public static final java.lang.String STYLE_TEXT_NON_SELECTION_COLOR

A style constant for the Text Non Selection Color property. Values of this key must be of type nextapp.echo.Color.

See Also:

Constant Field Values

STYLE_TEXT_SELECTION_COLOR

public static final java.lang.String STYLE_TEXT_SELECTION_COLOR

A style constant for the Text Selection Color property. Values of this key must be of type nextapp.echo.Color.

See Also:

Constant Field Values

Constructor Detail

DefaultTreeCellRenderer

public DefaultTreeCellRenderer()

Creates a new instance of DefaultTreeCellRenderer.

Method Detail

applyStyle

public void applyStyle(Style style)

Description copied from interface: Component

Sets stylistic properties of this component based on a Style object. The version of this method in Component will set foreground and background colors and the font from the style if they are present. Components should override this method if they allow more properties to be set from a style object, and should call super.applyStyle() if necessary.

Specified by:

applyStyle in interface Component

Overrides:

applyStyle in class Label

Parameters:

style - The style object from which to retrieve properties for this Component.

See Also:

Component.applyStyle(nextapp.echo.Style)

getBackgroundNonSelectionColor

public Color getBackgroundNonSelectionColor()

Returns the background color to be used for non selected nodes.

getBackgroundSelectionColor

public Color getBackgroundSelectionColor()

Returns the color to use for the background if node is selected.

getTextNonSelectionColor

public Color getTextNonSelectionColor()

Returns the color the text is drawn with when the node isn't selected.

getTextSelectionColor

public Color getTextSelectionColor()

Returns the color the text is drawn with when the node is selected.

getTreeCellRendererComponent

public Component getTreeCellRendererComponent(Tree tree,
                                              java.lang.Object node,
                                              boolean selected,
                                              boolean expanded,
                                              boolean leaf)

If the value is a Component then it will be returned as is, otherwise it returns null.

Specified by:

getTreeCellRendererComponent in interface TreeCellRenderer

Returns:

Component that is used to draw the value.

getTreeCellRendererText

public Label getTreeCellRendererText(Tree tree,
                                     java.lang.Object node,
                                     boolean sel,
                                     boolean expanded,
                                     boolean leaf)

Configures the renderer based on the passed in parameters. The foreground color of the Label is set based on the selection while the icon is set based on on leaf and expanded.

The same Label object is returned for each call to this method. The Tree rendering code uses only the public properties of the return Label. In fact since DefaultTreeCellRenderer is derived from Label it simply returns itself.

Specified by:

getTreeCellRendererText in interface TreeCellRenderer

Returns:

Label that is used to draw the Tree cell.

setBackgroundNonSelectionColor

public void setBackgroundNonSelectionColor(Color newColor)

Sets the background color to be used for non selected nodes.

setBackgroundSelectionColor

public void setBackgroundSelectionColor(Color newColor)

Sets the color to use for the background if node is selected.

setTextNonSelectionColor

public void setTextNonSelectionColor(Color newColor)

Sets the color the text is drawn with when the node isn't selected.

setTextSelectionColor

public void setTextSelectionColor(Color newColor)

Sets the color the text is drawn with when the node is selected.

set

public java.lang.Object set(java.lang.reflect.Field field,
                            java.lang.Object newValue)
                     throws java.lang.Exception

Description copied from interface: ReflectionSetter

Called to save the old value of a field, set in a new value and return the old value of a field. This interface allows a field set operation to be "delegated" back into the class that has permission to perform the field set.

 public Object set(Field f, Object newValue) throws Exception {
      Object oldValue = f.get(this);
      f.set(this,newValue);
      return oldValue;
 }
 

Specified by:

set in interface ReflectionSetter

Parameters:

field - - the field to be set

newValue - - the new value to be set

Returns:

the oldValue of the field

Throws:

java.lang.IllegalAccessException

java.lang.IllegalArgumentException

java.lang.NullPointerException

java.lang.Exception

See Also:

ReflectionSetter.set(Field, Object)