Package org.opensourcephysics.controls

Class XMLTreePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.opensourcephysics.controls.XMLTreePanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class XMLTreePanel
extends JPanel

This is a split pane view of an XML tree and its contents.

Author:

Douglas Brown

See Also:

• Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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	Description
protected XMLControl	control
protected boolean	editable
protected Icon	folderIcon
protected JTextField	input
protected Icon	inspectFolderIcon
protected Icon	inspectIcon
protected JLabel	label
protected JPopupMenu	popup
protected XMLProperty	property
protected JTree	tree
protected JScrollPane	treeScroller
protected Icon	valueIcon
protected JTextPane	xmlPane

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	Description
XMLTreePanel(XMLControl control)	Constructs a tree panel with an XMLControl
XMLTreePanel(XMLControl control, boolean editable)	Constructs a tree panel with an XMLControl

Method Summary

Modifier and Type	Method	Description
protected void	createGUI()	Creates the GUI and listeners.
protected void	displayProperty(XMLTreeNode node, boolean editable)	Displays the property data for the specified node.
XMLTreeNode	getChildNode(XMLTreeNode root, String name)	Returns the first child of a specified root node that has a given name.
XMLControl	getControl()	Gets the control displayed in the tree.
protected String	getDisplay(String xml)	Gets the xml to be displayed.
protected MouseListener	getMouseListener()
void	refresh()	Refreshes the tree.
XMLTreeNode	setSelectedNode(String propertyName)	Selects and returns the first node with the specified property name.
XMLTreeNode	setSelectedNode(TreePath treePath)	Selects and returns the node with the specified TreePath.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, 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, isValidateRoot, paint, paintBorder, paintChildren, 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, addImpl, 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, remove, remove, removeAll, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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 Details

label

protected JLabel label

input

protected JTextField input

xmlPane

protected JTextPane xmlPane

tree

protected JTree tree

treeScroller

protected JScrollPane treeScroller

valueIcon

protected Icon valueIcon

inspectIcon

protected Icon inspectIcon

inspectFolderIcon

protected Icon inspectFolderIcon

folderIcon

protected Icon folderIcon

control

protected XMLControl control

property

protected XMLProperty property

editable

protected boolean editable

popup

protected JPopupMenu popup

Constructor Details

XMLTreePanel

public XMLTreePanel(XMLControl control)

Constructs a tree panel with an XMLControl

Parameters:

control - the XMLControl

XMLTreePanel

public XMLTreePanel(XMLControl control,
 boolean editable)

Constructs a tree panel with an XMLControl

Parameters:

control - the XMLControl

editable - true to enable xml edits via the input field

Method Details

refresh

public void refresh()

Refreshes the tree. Called after changing the control externally.

getControl

public XMLControl getControl()

Gets the control displayed in the tree.

setSelectedNode

public XMLTreeNode setSelectedNode(String propertyName)

Selects and returns the first node with the specified property name.

Parameters:

propertyName - the property name

Returns:

the selected node, or null if none found

setSelectedNode

public XMLTreeNode setSelectedNode(TreePath treePath)

Selects and returns the node with the specified TreePath. This uses only the names of the nodes in the path so it can be used after creating a new similar Tree.

Parameters:

treePath - the TreePath

Returns:

the selected node, or null if none found

getChildNode

public XMLTreeNode getChildNode(XMLTreeNode root,
 String name)

Returns the first child of a specified root node that has a given name.

Parameters:

root - the node to search

name - the name

Returns:

the node, or null if none found

displayProperty

protected void displayProperty(XMLTreeNode node,
 boolean editable)

Displays the property data for the specified node.

Parameters:

node - the XMLTreeNode

editable - true if the input field is editable

getDisplay

protected String getDisplay(String xml)

Gets the xml to be displayed.

Parameters:

xml - the raw xml

Returns:

the displayed xml

createGUI

protected void createGUI()

Creates the GUI and listeners.

getMouseListener

protected MouseListener getMouseListener()