org.jdesktop.swingx.renderer
Class TreeCellContext

java.lang.Object
  extended by org.jdesktop.swingx.renderer.CellContext<javax.swing.JTree>
      extended by org.jdesktop.swingx.renderer.TreeCellContext
All Implemented Interfaces:
java.io.Serializable

public class TreeCellContext
extends CellContext<javax.swing.JTree>

Tree specific cellContext.

See Also:
Serialized Form

Nested Class Summary
 class TreeCellContext.TreeFocusBorder
          Border used to draw around the content of the node.
 
Field Summary
protected  javax.swing.Icon closedIcon
          the default icon to use for a closed folder.
protected  javax.swing.Icon leafIcon
          the icon to use for a leaf node.
protected  javax.swing.Icon openIcon
          the default icon to use for a open folder.
 
Fields inherited from class org.jdesktop.swingx.renderer.CellContext
column, component, expanded, focused, leaf, noFocusBorder, row, selected, value
 
Constructor Summary
TreeCellContext()
           
 
Method Summary
protected  javax.swing.Icon getClosedIcon()
          Returns the default icon to use for closed cell.
protected  javax.swing.border.Border getFocusBorder()
          Returns the default focus border of the renderered component.
 javax.swing.Icon getIcon()
          Returns the icon.
protected  javax.swing.Icon getLeafIcon()
          Returns the default icon to use for leaf cell.
protected  javax.swing.Icon getOpenIcon()
          Returns the default icon to use for open cell.
protected  java.awt.Color getSelectionBackground()
          Returns the default selection background color of the renderered component.
protected  java.awt.Color getSelectionForeground()
          Returns the default selection foreground color of the renderered component.
 javax.swing.tree.TreePath getTreePath()
          Returns the treePath for the row or null if invalid.
protected  java.lang.String getUIPrefix()
          Returns the component type specific prefix of keys for lookup in the UIManager.
 boolean isEditable()
          Returns the cell's editability.
 
Methods inherited from class org.jdesktop.swingx.renderer.CellContext
getBackground, getBorder, getColumn, getComponent, getFocusBackground, getFocusForeground, getForeground, getRow, getUIKey, getValue, installContext, isExpanded, isFocused, isLeaf, isSelected, replaceValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

leafIcon

protected javax.swing.Icon leafIcon
the icon to use for a leaf node.


closedIcon

protected javax.swing.Icon closedIcon
the default icon to use for a closed folder.


openIcon

protected javax.swing.Icon openIcon
the default icon to use for a open folder.

Constructor Detail

TreeCellContext

public TreeCellContext()
Method Detail

getTreePath

public javax.swing.tree.TreePath getTreePath()
Returns the treePath for the row or null if invalid.


isEditable

public boolean isEditable()
Returns the cell's editability. Subclasses should override to return a reasonable cell-related state.

Here: false.

PENDING: implement to return the tree cell editability!

Overrides:
isEditable in class CellContext<javax.swing.JTree>
Returns:
the cell's editable property.

getSelectionBackground

protected java.awt.Color getSelectionBackground()
Returns the default selection background color of the renderered component. Typically, the color is LF specific. It's up to subclasses to look it up. Here: returns null.

PENDING: return UI properties here?

Overrides:
getSelectionBackground in class CellContext<javax.swing.JTree>
Returns:
the selection background color of the rendered component.

getSelectionForeground

protected java.awt.Color getSelectionForeground()
Returns the default selection foreground color of the renderered component. Typically, the color is LF specific. It's up to subclasses to look it up. Here: returns null.

PENDING: return UI properties here?

Overrides:
getSelectionForeground in class CellContext<javax.swing.JTree>
Returns:
the selection foreground color of the rendered component.

getUIPrefix

protected java.lang.String getUIPrefix()
Returns the component type specific prefix of keys for lookup in the UIManager. Subclasses must override, here: returns the empty String.

Overrides:
getUIPrefix in class CellContext<javax.swing.JTree>
Returns:
the component type specific prefix.

getLeafIcon

protected javax.swing.Icon getLeafIcon()
Returns the default icon to use for leaf cell.

Returns:
the icon to use for leaf cell.

getOpenIcon

protected javax.swing.Icon getOpenIcon()
Returns the default icon to use for open cell.

Returns:
the icon to use for open cell.

getClosedIcon

protected javax.swing.Icon getClosedIcon()
Returns the default icon to use for closed cell.

Returns:
the icon to use for closed cell.

getIcon

public javax.swing.Icon getIcon()
Returns the icon. Subclasses should override to return a reasonable cell-related state.

Here: null.

Overridden to return a default depending for the leaf/open cell state.

Overrides:
getIcon in class CellContext<javax.swing.JTree>
Returns:
the cell's icon.

getFocusBorder

protected javax.swing.border.Border getFocusBorder()
Description copied from class: CellContext
Returns the default focus border of the renderered component. Typically, the border is LF specific.

Overrides:
getFocusBorder in class CellContext<javax.swing.JTree>
Returns:
the focus border of the rendered component.