org.mdiutil.swing

Class JPropertyTreePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JSplitPane

org.mdiutil.swing.JPropertyTreePanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class JPropertyTreePanel
extends JSplitPane

User-interface component which presents settings in a tree.

There are three ways to add property nodes to the tree :

• directly adding nodes containing properties : this is done by using either the addPropertyListNode(DefaultMutableTreeNode, String, Icon, PropertyEditor) or addPropertyListNode(DefaultMutableTreeNode, String, PropertyEditor) methods.
  • The DefaultMutableTreeNode is the parent node (which can be the rootNode of the tree),
  • The Icon is the icon associated with the node,
  • The String is the name which will be presented with the node on the tree,
  • The PropertyEditor is the editor associated with the node
• adding empty nodes : this is done by using either the addEmptyNode(DefaultMutableTreeNode, String, Icon) or addEmptyNode(DefaultMutableTreeNode, String) methods.
  • The DefaultMutableTreeNode is the parent node,
  • The Icon is the icon associated with the node,
  • The String is the name which will be presented with the node on the tree
• adding a whole node structure : this is done by using either the addNode(DefaultMutableTreeNode, DefaultMutableTreeNode, Icon) or addNode(DefaultMutableTreeNode, DefaultMutableTreeNode) methods.
  • The first DefaultMutableTreeNode is the parent node,
  • The first DefaultMutableTreeNode is the child node to add. It can contain other nodes, and the UserObjects associated with the nodes are the PropertyEditors associated with the nodes,
  • The Icon is the icon associated with the node,

For each node of the tree there is a corresponding PropertyEditor.

Example: To create a new JPropertyTreePanel :

• Create the PropertyEditors and set them visible

       PropertyEditor p1 = new PropertyEditor();
       JTextField tf = new JTextField("1");
       p1.addProperty(tf,"1","prop 1");
       p1.setVisible(true);

       PropertyEditor p2 = new PropertyEditor();
       JTextField tf2 = new JTextField("2");
       p2.addProperty(tf2,"2","prop 2");
       p2.setVisible(true);
 

• Create the JPropertyTreePanel

      JPropertyTreePanel panel = new JPropertyTreePanel();
 

• Associate editors with nodes :

     panel.addPropertyListNode(panel.getRootNode(), "node 1", p1);
     DefaultMutableTreeNode node = panel.addEmptyNode(panel.getRootNode(), "sub-node");
     panel.addPropertyListNode(node, "node 2", p2);
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JPropertyTreePanel.PropertyTreeRenderer This internal class is responsble for nodes rendering.

Nested classes/interfaces inherited from class javax.swing.JSplitPane

JSplitPane.AccessibleJSplitPane

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

Modifier and Type	Field and Description
protected DefaultTreeModel	model
protected Map<DefaultMutableTreeNode,Object>	props
protected JPropertyTreePanel.PropertyTreeRenderer	renderer
protected JSplitPane	split
protected JTree	tree

Fields inherited from class javax.swing.JSplitPane

BOTTOM, CONTINUOUS_LAYOUT_PROPERTY, continuousLayout, DIVIDER, DIVIDER_LOCATION_PROPERTY, DIVIDER_SIZE_PROPERTY, dividerSize, HORIZONTAL_SPLIT, LAST_DIVIDER_LOCATION_PROPERTY, lastDividerLocation, LEFT, leftComponent, ONE_TOUCH_EXPANDABLE_PROPERTY, oneTouchExpandable, orientation, ORIENTATION_PROPERTY, RESIZE_WEIGHT_PROPERTY, RIGHT, rightComponent, TOP, VERTICAL_SPLIT

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
JPropertyTreePanel() Constructor.

Method Summary

Modifier and Type	Method and Description
DefaultMutableTreeNode	addEmptyNode(DefaultMutableTreeNode parentnode, String listname) Add an empty node to the tree, with no icon.
DefaultMutableTreeNode	addEmptyNode(DefaultMutableTreeNode parentnode, String listname, Icon icon) Add an empty node to the tree, and associate this node with an icon.
DefaultMutableTreeNode	addNode(DefaultMutableTreeNode parentnode, DefaultMutableTreeNode childNode) Add a custom node to the tree, with no icon.
DefaultMutableTreeNode	addNode(DefaultMutableTreeNode parentnode, DefaultMutableTreeNode childNode, Icon icon) Add a custom node to the tree, and associate it with an icon.
DefaultMutableTreeNode	addPropertyListNode(DefaultMutableTreeNode parentnode, String listname, Icon icon, PropertyEditor editor) Add a node to the tree, and associate this node with a PropertyEditor, and an icon.
DefaultMutableTreeNode	addPropertyListNode(DefaultMutableTreeNode parentnode, String listname, PropertyEditor editor) Add a node to the tree, with an associated PropertyEditor, but no icon.
protected void	changePropertyView(DefaultMutableTreeNode node) This method is used internally to manage node selections in the tree :
void	collapseAll()
void	expandAll()
DefaultMutableTreeNode	getRootNode() Return the root node of the tree.
JSplitPane	getSplitPane() Return the internal JSplitPane.
JTree	getTree()
TreeModel	getTreeModel() Return the internal TreeModel.

Methods inherited from class javax.swing.JSplitPane

addImpl, getAccessibleContext, getBottomComponent, getDividerLocation, getDividerSize, getLastDividerLocation, getLeftComponent, getMaximumDividerLocation, getMinimumDividerLocation, getOrientation, getResizeWeight, getRightComponent, getTopComponent, getUI, getUIClassID, isContinuousLayout, isOneTouchExpandable, isValidateRoot, paintChildren, paramString, remove, remove, removeAll, resetToPreferredSizes, setBottomComponent, setContinuousLayout, setDividerLocation, setDividerLocation, setDividerSize, setLastDividerLocation, setLeftComponent, setOneTouchExpandable, setOrientation, setResizeWeight, setRightComponent, setTopComponent, setUI, updateUI

Methods inherited from class javax.swing.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, paint, paintBorder, 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 java.awt.Container

add, add, add, add, add, addContainerListener, 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, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, 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, 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, getPeer, 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, resize, resize, setBounds, 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

Field Detail

tree

protected JTree tree

model

protected DefaultTreeModel model

renderer

protected JPropertyTreePanel.PropertyTreeRenderer renderer

split

protected JSplitPane split

props

protected Map<DefaultMutableTreeNode,Object> props

Constructor Detail

JPropertyTreePanel

public JPropertyTreePanel()

Constructor.

Method Detail

addEmptyNode

public DefaultMutableTreeNode addEmptyNode(DefaultMutableTreeNode parentnode,
                                           String listname,
                                           Icon icon)

Add an empty node to the tree, and associate this node with an icon.

Parameters:

parentnode - the parent node of the newly created node

listname - the name of the node

icon - the optional icon to associate with the node (or null if there is no icon)

Returns:

the Node

addEmptyNode

public DefaultMutableTreeNode addEmptyNode(DefaultMutableTreeNode parentnode,
                                           String listname)

Add an empty node to the tree, with no icon.

Parameters:

parentnode - the parent node of the newly created node

listname - the name of the node

Returns:

the Node

addNode

public DefaultMutableTreeNode addNode(DefaultMutableTreeNode parentnode,
                                      DefaultMutableTreeNode childNode)

Add a custom node to the tree, with no icon.

Parameters:

parentnode - the parent node of the newly created node

childNode - the child node of the newly created node

Returns:

the Node

See Also:

addNode(DefaultMutableTreeNode, DefaultMutableTreeNode, Icon)

addNode

public DefaultMutableTreeNode addNode(DefaultMutableTreeNode parentnode,
                                      DefaultMutableTreeNode childNode,
                                      Icon icon)

Add a custom node to the tree, and associate it with an icon.

This Node can contain other nodes, and each of these nodes can be associated with a PropertyEditor userObject. This allows to add easily a whole property tree structure to the node.

For example, the following code add two nodes associated with PropertyEditors :

• Create two PropertyEditors :

       PropertyEditor p1 = new PropertyEditor();
       JTextField tf = new JTextField("1");
       p1.addProperty(tf,"1","prop 1");
       p1.setVisible(true);

       PropertyEditor p2 = new PropertyEditor();
       JTextField tf2 = new JTextField("2");
       p2.addProperty(tf,"2","prop 2");
       p2.setVisible(true);
 

• Create the nodes associated to the editors :

       DefaultMutableTreeNode node1 = new DefaultMutableTreeNode("Node 1");
       node1.setUserObject(p1);
       DefaultMutableTreeNode node2 = new DefaultMutableTreeNode("Node 2");
       node2.setUserObject(p2);
 

• Create the JPropertyTreePanel

      JPropertyTreePanel panel = new JPropertyTreePanel();
      panel.addEmptyNode(panel.getRootNode(), node1, null);
      panel.addEmptyNode(panel.getRootNode(), node2, null);
 

Parameters:

parentnode - the parent node of the newly created node

childNode - the child node of the newly created node

icon - the optional icon to associate with the node (or null if there is no icon)

Returns:

the Node

addPropertyListNode

public DefaultMutableTreeNode addPropertyListNode(DefaultMutableTreeNode parentnode,
                                                  String listname,
                                                  Icon icon,
                                                  PropertyEditor editor)

Add a node to the tree, and associate this node with a PropertyEditor, and an icon.

Parameters:

parentnode - the parent node of the newly created node

listname - the name of the node

icon - the optional icon to associate with the node (or null if there is no icon)

editor - the PropertyEditor associated with the node

Returns:

the Node

addPropertyListNode

public DefaultMutableTreeNode addPropertyListNode(DefaultMutableTreeNode parentnode,
                                                  String listname,
                                                  PropertyEditor editor)

Add a node to the tree, with an associated PropertyEditor, but no icon.

Parameters:

parentnode - the parent node of the newly created node

listname - the name of the node

editor - the PropertyEditor associated with the node

Returns:

the Node

getRootNode

public DefaultMutableTreeNode getRootNode()

Return the root node of the tree.

Returns:

the root node of the tree

changePropertyView

protected void changePropertyView(DefaultMutableTreeNode node)

This method is used internally to manage node selections in the tree :

Parameters:

node - the node

getTree

public JTree getTree()

getSplitPane

public JSplitPane getSplitPane()

Return the internal JSplitPane. This method can be useful to set Divider locations for the panel.

Returns:

the internal JSplitPane

getTreeModel

public TreeModel getTreeModel()

Return the internal TreeModel.

Returns:

the internal TreeModel

expandAll

public void expandAll()

collapseAll

public void collapseAll()