MasterDetailTreeNode

java.lang.Object
- com.databasesandlife.util.swing.MasterDetailTreeNode

All Implemented Interfaces:

Serializable, TreeNode
```
public abstract class MasterDetailTreeNode
extends Object
implements TreeNode, Serializable
```
Represents a tree node in a hierarchy/detail situation, such as in the Windows Explorer. Has following features:
- Each node belongs to exactly one JTree with exactly one TreeModel. The root node stores these. Through a node's parents one gets to the root, and thus these.
- Assumes that children are cached, and that subclass implements fetchChildren, called once.
- Assumes that per program only one such tree exists (public static TreeModel).
- Assumes that parent is known at node creation time. Parent can be changed later.
- If parent==null then this node is root. In which case it stores table model and tree. All nodes have getTableModel etc methods, they just call parent.getTableModel until root is found.
- Has utility methods such as deleteNode0, redraw, getTreePath etc.
- Comes with a Node.CellRenderer, allowing icon,text,extra-text to be displayed
- Supports creation of context menus, through newPopupMenu
- Installs itself into a Tree (e.g. created in NetBeans), remembers static TreeModel.
- On tree right-click, pop-up menu opened
- On tree left-click, detail panel changed (with default "no detail panel")
Usage:
```
    Tree t = new Tree(); // from NetBeans UI designer
    MyRootNode n = new MyNode(null); // extends MasterDetailTreeNode, parent==null
    n.installIntoTreeAsRootNode(t);
 
```
Author:

This source is copyright Adrian Smith and licensed under the LGPL 3.

See Also:

Project on GitHub, Serialized Form

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Enumeration<MasterDetailTreeNode>`	`children()`
`void`	`expandAllChildren()`
`int`	`getAcceptableDropActions()` Returns a bitmask of acceptable actions such as `DnDConstants.ACTION_COPY`.
`DataFlavor[]`	`getAcceptableDropFlavors()` Returns array of Flavors which can be accepted, in the case a drag & drop attempts to drop on this node.
`TreeNode`	`getChildAt(int param)`
`int`	`getChildCount()`
`MasterDetailTreeNode[]`	`getChildren()`
`String`	`getExtraText()` Returns the text which is in color at the end of the name.
`Color`	`getExtraTextColor()` Returns the color which should be used for the extra text.
`int`	`getIndex(TreeNode treeNode)`
`TreeNode`	`getParent()`
`MasterDetailTreeNode`	`getSelectedNode()` Can be called anywhere on the tree.
`abstract ImageIcon`	`getTreeIcon()` Returns an ImageIcon which represents this icon, to be displayed to the left of it in the tree-view
`abstract String`	`getTreeText()` Returns the text which can be used to display this icon in the tree-view
`void`	`installIntoTreeAsRootNode(JTree tree, JPanel detailPanelContainer, JPanel defaultDetailPanel)` Sets `Node.treeModel` and makes this the first node of it.
`boolean`	`isLeaf()`
`abstract JPanel`	`newDetailJPanel()` Create and return a Panel which can be displayed on the right hand side of the window, when this node is selected.
`JPopupMenu`	`newPopupMenu()` Create and return a JPopupMenu which can be displayed when the user right-clicks on this node, or null for no pop-up menu
`TreePath`	`newTreePath()`
`void`	`redraw()`
`void`	`select()`
`void`	`setParent(MasterDetailTreeNode n)`
`void`	`transferrableHasBeenDropped(DropTargetDropEvent e)` When a `Transferrable` is dropped on this node, this method is called.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.swing.tree.TreeNode
getAllowsChildren

- Method Detail
  - getChildren
```
public MasterDetailTreeNode[] getChildren()
```
  - setParent
```
public void setParent(MasterDetailTreeNode n)
```
  - installIntoTreeAsRootNode
```
public void installIntoTreeAsRootNode(JTree tree,
                                      JPanel detailPanelContainer,
                                      JPanel defaultDetailPanel)
```
    Sets Node.treeModel and makes this the first node of it. Also sets some properties of the tree such as the cell renderer. This can only be called on root nodes (where parent==null)
    
    Parameters:
    
    detailPanelContainer - panel which should contain the detail panels
    
    defaultDetailPanel - if no node selected, this panel is shown in detailContainingPanel
  - newTreePath
```
public TreePath newTreePath()
```
  - select
```
public void select()
```
  - redraw
```
public void redraw()
```
  - expandAllChildren
```
public void expandAllChildren()
```
  - getSelectedNode
```
public MasterDetailTreeNode getSelectedNode()
```
    Can be called anywhere on the tree. Assumes only one node selected. Returns null if no node selected.
  - newDetailJPanel
```
public abstract JPanel newDetailJPanel()
```
    Create and return a Panel which can be displayed on the right hand side of the window, when this node is selected.
  - newPopupMenu
```
public JPopupMenu newPopupMenu()
```
    Create and return a JPopupMenu which can be displayed when the user right-clicks on this node, or null for no pop-up menu
  - getTreeIcon
```
public abstract ImageIcon getTreeIcon()
```
    Returns an ImageIcon which represents this icon, to be displayed to the left of it in the tree-view
  - getTreeText
```
public abstract String getTreeText()
```
    Returns the text which can be used to display this icon in the tree-view
  - getExtraText
```
public String getExtraText()
```
    Returns the text which is in color at the end of the name.
  - getExtraTextColor
```
public Color getExtraTextColor()
```
    Returns the color which should be used for the extra text.
  - getAcceptableDropFlavors
```
public DataFlavor[] getAcceptableDropFlavors()
```
    Returns array of Flavors which can be accepted, in the case a drag & drop attempts to drop on this node.
  - getAcceptableDropActions
```
public int getAcceptableDropActions()
```
    Returns a bitmask of acceptable actions such as DnDConstants.ACTION_COPY.
  - transferrableHasBeenDropped
```
public void transferrableHasBeenDropped(DropTargetDropEvent e)
```
    When a Transferrable is dropped on this node, this method is called. In the default implementation this should never be reached, as a default node cannot accept any DataFlavors or accept any actions.
  - children
```
public Enumeration<MasterDetailTreeNode> children()
```
    Specified by:
    
    children in interface TreeNode
  - getChildAt
```
public TreeNode getChildAt(int param)
```
    Specified by:
    
    getChildAt in interface TreeNode
  - getChildCount
```
public int getChildCount()
```
    Specified by:
    
    getChildCount in interface TreeNode
  - getParent
```
public TreeNode getParent()
```
    Specified by:
    
    getParent in interface TreeNode
  - isLeaf
```
public boolean isLeaf()
```
    Specified by:
    
    isLeaf in interface TreeNode
  - getIndex
```
public int getIndex(TreeNode treeNode)
```
    Specified by:
    
    getIndex in interface TreeNode

Class MasterDetailTreeNode

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface javax.swing.tree.TreeNode

Method Detail

getChildren

setParent

installIntoTreeAsRootNode

newTreePath

select

redraw

expandAllChildren

getSelectedNode

newDetailJPanel

newPopupMenu

getTreeIcon

getTreeText

getExtraText

getExtraTextColor

getAcceptableDropFlavors

getAcceptableDropActions

transferrableHasBeenDropped

children

getChildAt

getChildCount

getParent

isLeaf

getIndex