XmlTree (Unidata IDV API v6.2u2)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JTree
      - ucar.unidata.ui.XmlTree

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable
```
public class XmlTree
extends javax.swing.JTree
```
A generic JTree that displays an xml document. Can be configured in a variety of ways to show or not show certain tags, etc.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`XmlTree.MyRenderer` Class MyRenderer is used to return the correct image icon for certain jtree nodes
`static class`	`XmlTree.XlinkTreeNode` Class XlinkTreeNode.
`static class`	`XmlTree.XmlTreeNode` Class XmlTreeNode

Nested classes/interfaces inherited from class javax.swing.JTree
javax.swing.JTree.AccessibleJTree, javax.swing.JTree.DropLocation, javax.swing.JTree.DynamicUtilTreeNode, javax.swing.JTree.EmptySelectionModel, javax.swing.JTree.TreeModelHandler, javax.swing.JTree.TreeSelectionRedirector

Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTR_LABEL` xml attribute
`static java.lang.String`	`ATTR_NAME` xml attribute
`static java.lang.String`	`ATTR_XLINKHREF` xml attribute
`static java.lang.String`	`NULL_STRING` the null string

Fields inherited from class javax.swing.JTree
ANCHOR_SELECTION_PATH_PROPERTY, CELL_EDITOR_PROPERTY, CELL_RENDERER_PROPERTY, cellEditor, cellRenderer, editable, EDITABLE_PROPERTY, EXPANDS_SELECTED_PATHS_PROPERTY, INVOKES_STOP_CELL_EDITING_PROPERTY, invokesStopCellEditing, LARGE_MODEL_PROPERTY, largeModel, LEAD_SELECTION_PATH_PROPERTY, ROOT_VISIBLE_PROPERTY, rootVisible, ROW_HEIGHT_PROPERTY, rowHeight, SCROLLS_ON_EXPAND_PROPERTY, scrollsOnExpand, SELECTION_MODEL_PROPERTY, selectionModel, selectionRedirector, SHOWS_ROOT_HANDLES_PROPERTY, showsRootHandles, TOGGLE_CLICK_COUNT_PROPERTY, toggleClickCount, TREE_MODEL_PROPERTY, treeModelListener, VISIBLE_ROW_COUNT_PROPERTY, visibleRowCount

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
`XmlTree(org.w3c.dom.Element xmlRoot)` ctor
`XmlTree(org.w3c.dom.Element xmlRoot, boolean openFirstLevel)` ctor
`XmlTree(org.w3c.dom.Element xmlRoot, boolean openFirstLevel, java.lang.String basePath)` ctor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTagsToNotProcess(java.util.List tags)` Define the set of tags we should NOT process
`void`	`addTagsToNotProcessButRecurse(java.util.List tags)` Define the set of tags that we don't want to add to the jtree but do want to recurse
`void`	`addTagsToNotRecurse(java.util.List tags)` Define the set of tags whose children we should NOT process
`void`	`addTagsToProcess(java.util.List tags)` Define the set of tags who we should process
`void`	`addTagsToRecurse(java.util.List tags)` Define the set of tags whose child elements we should process
`void`	`addTagToNotProcess(java.lang.String tag)` Define a tag we should NOT process
`void`	`addTagToNotRecurse(java.lang.String tag)` Define a tag whose children we should NOT process
`void`	`addTagToProcess(java.lang.String tag)` Define a tag who we should process
`void`	`addTagToRecurse(java.lang.String tag)` Define a tag whose child elements we should process
`void`	`addXlinkTag(java.lang.String tagName)` Define a tag name that holds xlink references to other xml files
`void`	`defineLabelAttr(java.lang.String tagName, java.lang.String attrName)` Define the name of the attribute to use for a label for elements with the given tag name
`void`	`defineLabelChild(java.lang.String tagName, java.lang.String childTag)` Where do we get the label for the tag
`void`	`defineTooltipChild(java.lang.String tagName, java.lang.String childTag)` Where do we get the tooltip text
`void`	`doClick(XmlTree tree, org.w3c.dom.Element element)` tree node was clicked
`void`	`doClick(XmlTree tree, XmlTree.XmlTreeNode node, org.w3c.dom.Element element)` tree node was clicked
`void`	`doDoubleClick(XmlTree tree, org.w3c.dom.Element element)` Gets called when an Xml Element has been double clicked.
`void`	`doDoubleClick(XmlTree tree, XmlTree.XmlTreeNode node, org.w3c.dom.Element element)` Gets called when an Xml Element has been double clicked.
`void`	`doRightClick(XmlTree tree, org.w3c.dom.Element element, java.awt.event.MouseEvent event)` Handle right click
`void`	`doRightClick(XmlTree tree, XmlTree.XmlTreeNode node, org.w3c.dom.Element element, java.awt.event.MouseEvent event)` Handle right click
`java.lang.String`	`expandRelativeUrl(java.lang.String href)` Utility to expand a relative url wrt to a base url
`static java.lang.String`	`expandRelativeUrl(java.lang.String href, java.lang.String baseUrlPath)` Utility to expand a relative url wrt to a base url
`java.lang.String`	`expandRelativeUrl(XmlTree.XmlTreeNode node, java.lang.String href)` Expand the relative url
`protected void`	`expandXlink(XmlTree.XlinkTreeNode node, java.lang.String href)` expand the xlink node
`void`	`fireTreeWillExpand(javax.swing.tree.TreePath treePath)` Fire the event
`java.awt.Component`	`getContents()` Return the gui component.
`protected javax.swing.ImageIcon`	`getIcon(org.w3c.dom.Element xmlNode, boolean isLeaf)` Get the icon used for the node
`javax.swing.ImageIcon`	`getIconForNode(org.w3c.dom.Element node)` Get the icon for a node
`boolean`	`getIncludeAttributes()` Get the IncludeAttributes property.
`java.lang.String`	`getLabel(org.w3c.dom.Element n)` Return the String used for the JTree node.
`javax.swing.JScrollPane`	`getScroller()` Get the scrollpane the xmltree is in
`org.w3c.dom.Element`	`getSelectedElement()` Find the xml element that corresponds to the selected jtree node
`java.util.List`	`getSelectedElements()` Return a list of the xml Element nodes that have been selected.
`java.lang.String`	`getToolTipText(org.w3c.dom.Element n)` A hook to allow subclasses to get tooltip text for a particular xml element
`java.lang.String`	`getToolTipText(java.awt.event.MouseEvent event)` Get the tooltip at the mouse
`boolean`	`getUseTagNameAsLabel()` Get the UseTagNameAsLabel property.
`org.w3c.dom.NodeList`	`getXlinkImportElements(org.w3c.dom.Element root)` Find the xml elements to use when we have an xlink to an xml doc
`protected int`	`getXlinkImportLevel()` When we load in an xlinked document how far down do we go before we start displaying the nodes
`org.w3c.dom.Element`	`getXmlElement(javax.swing.tree.TreeNode treeNode)` Return the xml Element that corresponds to the given tree node
`org.w3c.dom.Element`	`getXmlNodeAt(int x, int y)` Return the xml Element located at the given position
`protected org.w3c.dom.Element`	`getXmlNodeAtPath(javax.swing.tree.TreePath path)` Return the xml Element located at the given position
`org.w3c.dom.Element`	`getXmlRoot()` Return the root element of the xml dom
`XmlTree.XmlTreeNode`	`getXmlTreeNodeAt(int x, int y)` Return the xml tree node located at the given position
`protected XmlTree.XmlTreeNode`	`getXmlTreeNodeAtPath(javax.swing.tree.TreePath path)` Return the xml tree node located at the given position
`protected boolean`	`initXlinkRoot(org.w3c.dom.Element root, org.w3c.dom.Document doc, java.lang.String url)` Allows derived classes to initialize the xlink loaded xml
`void`	`loadTree()` Reload the xml into the jtree
`static void`	`main(java.lang.String[] args)` Test
`protected void`	`process(XmlTree.XmlTreeNode parentTreeNode, org.w3c.dom.Element xmlNode)` Walk the xml tree at the given xmlNode and create the JTree
`protected org.w3c.dom.Document`	`readXlinkXml(java.lang.String href)` Process the xlink href
`void`	`selectElement(org.w3c.dom.Element element)` Select in the jtree the node that corresponds to the given xml element
`void`	`setIconForTag(javax.swing.ImageIcon icon, java.lang.String tagName)` Associate the icon with the tag
`void`	`setIncludeAttributes(boolean value)` Set the IncludeAttributes property.
`void`	`setMultipleSelect(boolean v)` Set tree select mode
`void`	`setUseTagNameAsLabel(boolean value)` Set the UseTagNameAsLabel property.
`void`	`setXmlRoot(org.w3c.dom.Element newRoot)` Set the root and reinitialize
`protected boolean`	`shouldProcess(org.w3c.dom.Element xmlNode)` Should we show the given xml Element
`protected boolean`	`shouldRecurse(org.w3c.dom.Element xmlNode)` Should we recursiely descend the children of the given xml Element
`protected void`	`treeClick(java.awt.event.MouseEvent event)` Gets called when the tree is clicked.

Methods inherited from class javax.swing.JTree
addSelectionInterval, addSelectionPath, addSelectionPaths, addSelectionRow, addSelectionRows, addTreeExpansionListener, addTreeSelectionListener, addTreeWillExpandListener, cancelEditing, clearSelection, clearToggledPaths, collapsePath, collapseRow, convertValueToText, createTreeModel, createTreeModelListener, expandPath, expandRow, fireTreeCollapsed, fireTreeExpanded, fireTreeWillCollapse, fireValueChanged, getAccessibleContext, getAnchorSelectionPath, getCellEditor, getCellRenderer, getClosestPathForLocation, getClosestRowForLocation, getDefaultTreeModel, getDescendantToggledPaths, getDragEnabled, getDropLocation, getDropMode, getEditingPath, getExpandedDescendants, getExpandsSelectedPaths, getInvokesStopCellEditing, getLastSelectedPathComponent, getLeadSelectionPath, getLeadSelectionRow, getMaxSelectionRow, getMinSelectionRow, getModel, getNextMatch, getPathBetweenRows, getPathBounds, getPathForLocation, getPathForRow, getPreferredScrollableViewportSize, getRowBounds, getRowCount, getRowForLocation, getRowForPath, getRowHeight, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getScrollsOnExpand, getSelectionCount, getSelectionModel, getSelectionPath, getSelectionPaths, getSelectionRows, getShowsRootHandles, getToggleClickCount, getTreeExpansionListeners, getTreeSelectionListeners, getTreeWillExpandListeners, getUI, getUIClassID, getVisibleRowCount, hasBeenExpanded, isCollapsed, isCollapsed, isEditable, isEditing, isExpanded, isExpanded, isFixedRowHeight, isLargeModel, isPathEditable, isPathSelected, isRootVisible, isRowSelected, isSelectionEmpty, isVisible, makeVisible, paramString, removeDescendantSelectedPaths, removeDescendantToggledPaths, removeSelectionInterval, removeSelectionPath, removeSelectionPaths, removeSelectionRow, removeSelectionRows, removeTreeExpansionListener, removeTreeSelectionListener, removeTreeWillExpandListener, scrollPathToVisible, scrollRowToVisible, setAnchorSelectionPath, setCellEditor, setCellRenderer, setDragEnabled, setDropMode, setEditable, setExpandedState, setExpandsSelectedPaths, setInvokesStopCellEditing, setLargeModel, setLeadSelectionPath, setModel, setRootVisible, setRowHeight, setScrollsOnExpand, setSelectionInterval, setSelectionModel, setSelectionPath, setSelectionPaths, setSelectionRow, setSelectionRows, setShowsRootHandles, setToggleClickCount, setUI, setVisibleRowCount, startEditingAtPath, stopEditing, treeDidChange, 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, 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, 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
  - ATTR_NAME
```
public static final java.lang.String ATTR_NAME
```
    xml attribute
    
    See Also:
    
    Constant Field Values
  - ATTR_LABEL
```
public static final java.lang.String ATTR_LABEL
```
    xml attribute
    
    See Also:
    
    Constant Field Values
  - ATTR_XLINKHREF
```
public static final java.lang.String ATTR_XLINKHREF
```
    xml attribute
    
    See Also:
    
    Constant Field Values
  - NULL_STRING
```
public static final java.lang.String NULL_STRING
```
    the null string
- Constructor Detail
  - XmlTree
```
public XmlTree(org.w3c.dom.Element xmlRoot)
```
    ctor
    
    Parameters:
    
    xmlRoot - The root of the xml dom tree
  - XmlTree
```
public XmlTree(org.w3c.dom.Element xmlRoot,
               boolean openFirstLevel)
```
    ctor
    
    Parameters:
    
    xmlRoot - The root of the xml dom tree
    
    openFirstLevel - Should the first level of the jtree be opened
  - XmlTree
```
public XmlTree(org.w3c.dom.Element xmlRoot,
               boolean openFirstLevel,
               java.lang.String basePath)
```
    ctor
    
    Parameters:
    
    xmlRoot - The root of the xml dom tree
    
    openFirstLevel - Should the first level of the jtree be opened
    
    basePath - Where the xml came from
- Method Detail
  - getIconForNode
```
public javax.swing.ImageIcon getIconForNode(org.w3c.dom.Element node)
```
    Get the icon for a node
    
    Parameters:
    
    node - the node
    
    Returns:
    
    null
  - getToolTipText
```
public java.lang.String getToolTipText(java.awt.event.MouseEvent event)
```
    Get the tooltip at the mouse
    
    Overrides:
    
    getToolTipText in class javax.swing.JTree
    
    Parameters:
    
    event - Where the mouse is
    
    Returns:
    
    The tooltip text
  - getToolTipText
```
public java.lang.String getToolTipText(org.w3c.dom.Element n)
```
    A hook to allow subclasses to get tooltip text for a particular xml element
    
    Parameters:
    
    n - The xml element
    
    Returns:
    
    The tooltip text
  - loadTree
```
public void loadTree()
```
    Reload the xml into the jtree
  - setUseTagNameAsLabel
```
public void setUseTagNameAsLabel(boolean value)
```
    Set the UseTagNameAsLabel property.
    
    Parameters:
    
    value - The new value for UseTagNameAsLabel
  - getUseTagNameAsLabel
```
public boolean getUseTagNameAsLabel()
```
    Get the UseTagNameAsLabel property.
    
    Returns:
    
    The UseTagNameAsLabel
  - setIncludeAttributes
```
public void setIncludeAttributes(boolean value)
```
    Set the IncludeAttributes property.
    
    Parameters:
    
    value - The new value for IncludeAttributes
  - getIncludeAttributes
```
public boolean getIncludeAttributes()
```
    Get the IncludeAttributes property.
    
    Returns:
    
    The IncludeAttributes
  - getSelectedElements
```
public java.util.List getSelectedElements()
```
    Return a list of the xml Element nodes that have been selected.
    
    Returns:
    
    List of selected nodes.
  - selectElement
```
public void selectElement(org.w3c.dom.Element element)
```
    Select in the jtree the node that corresponds to the given xml element
    
    Parameters:
    
    element - The xml element to select
  - getSelectedElement
```
public org.w3c.dom.Element getSelectedElement()
```
    Find the xml element that corresponds to the selected jtree node
    
    Returns:
    
    Selected xml element or null if none selected
  - getXmlRoot
```
public org.w3c.dom.Element getXmlRoot()
```
    Return the root element of the xml dom
    
    Returns:
    
    root element of the xml dom
  - setXmlRoot
```
public void setXmlRoot(org.w3c.dom.Element newRoot)
```
    Set the root and reinitialize
    
    Parameters:
    
    newRoot - The new xml root
  - treeClick
```
protected void treeClick(java.awt.event.MouseEvent event)
```
    Gets called when the tree is clicked.
    
    Parameters:
    
    event - Mouse event
  - doDoubleClick
```
public void doDoubleClick(XmlTree tree,
                          XmlTree.XmlTreeNode node,
                          org.w3c.dom.Element element)
```
    Gets called when an Xml Element has been double clicked.
    
    Parameters:
    
    tree - The tree (this).
    
    node - The node that was clicked on
    
    element - The corresponding xml element
  - doDoubleClick
```
public void doDoubleClick(XmlTree tree,
                          org.w3c.dom.Element element)
```
    Gets called when an Xml Element has been double clicked.
    
    Parameters:
    
    tree - The tree (this)
    
    element - The xml element
  - doClick
```
public void doClick(XmlTree tree,
                    XmlTree.XmlTreeNode node,
                    org.w3c.dom.Element element)
```
    tree node was clicked
    
    Parameters:
    
    tree - The tree (this)
    
    node - Tree node that was clicked
    
    element - Corresponding xml node
  - doClick
```
public void doClick(XmlTree tree,
                    org.w3c.dom.Element element)
```
    tree node was clicked
    
    Parameters:
    
    tree - The tree (this)
    
    element - Corresponding xml node
  - doRightClick
```
public void doRightClick(XmlTree tree,
                         XmlTree.XmlTreeNode node,
                         org.w3c.dom.Element element,
                         java.awt.event.MouseEvent event)
```
    Handle right click
    
    Parameters:
    
    tree - The tree (this)
    
    node - Tree node that was clicked
    
    element - Corresponding xml node
    
    event - The mouse event
  - doRightClick
```
public void doRightClick(XmlTree tree,
                         org.w3c.dom.Element element,
                         java.awt.event.MouseEvent event)
```
    Handle right click
    
    Parameters:
    
    tree - The tree (this)
    
    element - Corresponding xml node
    
    event - The mouse event
  - getContents
```
public java.awt.Component getContents()
```
    Return the gui component. This has to be called because we create the JTree here. (We don't at construction time because of the tagsToRecurse/Process setting).
    
    Returns:
    
    The contents
  - getScroller
```
public javax.swing.JScrollPane getScroller()
```
    Get the scrollpane the xmltree is in
    
    Returns:
    
    The scroller
  - defineLabelAttr
```
public void defineLabelAttr(java.lang.String tagName,
                            java.lang.String attrName)
```
    Define the name of the attribute to use for a label for elements with the given tag name
    
    Parameters:
    
    tagName - The tag name
    
    attrName - Attribute that defines the label
  - defineLabelChild
```
public void defineLabelChild(java.lang.String tagName,
                             java.lang.String childTag)
```
    Where do we get the label for the tag
    
    Parameters:
    
    tagName - The tag name
    
    childTag - Tag name of child node to look for label
  - defineTooltipChild
```
public void defineTooltipChild(java.lang.String tagName,
                               java.lang.String childTag)
```
    Where do we get the tooltip text
    
    Parameters:
    
    tagName - The tag name
    
    childTag - Tag of the child where we get tooltip text
  - addXlinkTag
```
public void addXlinkTag(java.lang.String tagName)
```
    Define a tag name that holds xlink references to other xml files
    
    Parameters:
    
    tagName - The tag name
  - addTagsToRecurse
```
public void addTagsToRecurse(java.util.List tags)
```
    Define the set of tags whose child elements we should process
    
    Parameters:
    
    tags - List of tag names
  - setIconForTag
```
public void setIconForTag(javax.swing.ImageIcon icon,
                          java.lang.String tagName)
```
    Associate the icon with the tag
    
    Parameters:
    
    icon - The icon
    
    tagName - The tag name
  - addTagToRecurse
```
public void addTagToRecurse(java.lang.String tag)
```
    Define a tag whose child elements we should process
    
    Parameters:
    
    tag - The tag name
  - addTagsToProcess
```
public void addTagsToProcess(java.util.List tags)
```
    Define the set of tags who we should process
    
    Parameters:
    
    tags - List of tag names
  - addTagToProcess
```
public void addTagToProcess(java.lang.String tag)
```
    Define a tag who we should process
    
    Parameters:
    
    tag - the tag name
  - addTagsToNotProcessButRecurse
```
public void addTagsToNotProcessButRecurse(java.util.List tags)
```
    Define the set of tags that we don't want to add to the jtree but do want to recurse
    
    Parameters:
    
    tags - List of tag names
  - addTagsToNotRecurse
```
public void addTagsToNotRecurse(java.util.List tags)
```
    Define the set of tags whose children we should NOT process
    
    Parameters:
    
    tags - List of tag names
  - addTagToNotRecurse
```
public void addTagToNotRecurse(java.lang.String tag)
```
    Define a tag whose children we should NOT process
    
    Parameters:
    
    tag - The tag name
  - addTagsToNotProcess
```
public void addTagsToNotProcess(java.util.List tags)
```
    Define the set of tags we should NOT process
    
    Parameters:
    
    tags - List of tag names
  - addTagToNotProcess
```
public void addTagToNotProcess(java.lang.String tag)
```
    Define a tag we should NOT process
    
    Parameters:
    
    tag - The tag name
  - fireTreeWillExpand
```
public void fireTreeWillExpand(javax.swing.tree.TreePath treePath)
                        throws javax.swing.tree.ExpandVetoException
```
    Fire the event
    
    Overrides:
    
    fireTreeWillExpand in class javax.swing.JTree
    
    Parameters:
    
    treePath - Expanding path
    
    Throws:
    
    javax.swing.tree.ExpandVetoException - on badness
  - expandRelativeUrl
```
public java.lang.String expandRelativeUrl(XmlTree.XmlTreeNode node,
                                          java.lang.String href)
```
    Expand the relative url
    
    Parameters:
    
    node - the node
    
    href - the base href
    
    Returns:
    
    the expanded URL
  - expandRelativeUrl
```
public java.lang.String expandRelativeUrl(java.lang.String href)
```
    Utility to expand a relative url wrt to a base url
    
    Parameters:
    
    href - The (potentially) relative url
    
    Returns:
    
    Fully qualified url
  - expandRelativeUrl
```
public static java.lang.String expandRelativeUrl(java.lang.String href,
                                                 java.lang.String baseUrlPath)
```
    Utility to expand a relative url wrt to a base url
    
    Parameters:
    
    href - The (potentially) relative url
    
    baseUrlPath - The base path
    
    Returns:
    
    Fully qualified url
  - readXlinkXml
```
protected org.w3c.dom.Document readXlinkXml(java.lang.String href)
                                     throws java.lang.Exception
```
    Process the xlink href
    
    Parameters:
    
    href - Points to the xml file
    
    Returns:
    
    The new document
    
    Throws:
    
    java.lang.Exception - On badness
  - getXlinkImportLevel
```
protected int getXlinkImportLevel()
```
    When we load in an xlinked document how far down do we go before we start displaying the nodes
    
    Returns:
    
    import level
  - expandXlink
```
protected void expandXlink(XmlTree.XlinkTreeNode node,
                           java.lang.String href)
```
    expand the xlink node
    
    Parameters:
    
    node - The node
    
    href - The href to the xml doc
  - getXlinkImportElements
```
public org.w3c.dom.NodeList getXlinkImportElements(org.w3c.dom.Element root)
```
    Find the xml elements to use when we have an xlink to an xml doc
    
    Parameters:
    
    root - get the xlink elements
    
    Returns:
    
    element to use
  - initXlinkRoot
```
protected boolean initXlinkRoot(org.w3c.dom.Element root,
                                org.w3c.dom.Document doc,
                                java.lang.String url)
```
    Allows derived classes to initialize the xlink loaded xml
    
    Parameters:
    
    root - The root of the xlink loaded xml
    
    doc - The document the xml was created with
    
    url - The url
    
    Returns:
    
    true if the xlink tree should be added
  - shouldProcess
```
protected boolean shouldProcess(org.w3c.dom.Element xmlNode)
```
    Should we show the given xml Element
    
    Parameters:
    
    xmlNode -
    
    Returns:
    
    Should we look at this node and turn it into a jtree node
  - getIcon
```
protected javax.swing.ImageIcon getIcon(org.w3c.dom.Element xmlNode,
                                        boolean isLeaf)
```
    Get the icon used for the node
    
    Parameters:
    
    xmlNode - The node
    
    isLeaf - Is it a leaf node
    
    Returns:
    
    The icon or null
  - process
```
protected void process(XmlTree.XmlTreeNode parentTreeNode,
                       org.w3c.dom.Element xmlNode)
```
    Walk the xml tree at the given xmlNode and create the JTree
    
    Parameters:
    
    parentTreeNode - The parent jtree node
    
    xmlNode - The xml node to process
  - shouldRecurse
```
protected boolean shouldRecurse(org.w3c.dom.Element xmlNode)
```
    Should we recursiely descend the children of the given xml Element
    
    Parameters:
    
    xmlNode - The xml node
    
    Returns:
    
    Should we recurse down
  - getLabel
```
public java.lang.String getLabel(org.w3c.dom.Element n)
```
    Return the String used for the JTree node. This first looks in the tagNameToLabelAttr hashtable for an attribute name to fetch the label. If not found we try the attributes "label" and "name".
    
    Parameters:
    
    n - The node
    
    Returns:
    
    Its label
  - getXmlNodeAt
```
public org.w3c.dom.Element getXmlNodeAt(int x,
                                        int y)
```
    Return the xml Element located at the given position
    
    Parameters:
    
    x - x
    
    y - y
    
    Returns:
    
    The node
  - getXmlNodeAtPath
```
protected org.w3c.dom.Element getXmlNodeAtPath(javax.swing.tree.TreePath path)
```
    Return the xml Element located at the given position
    
    Parameters:
    
    path - The path
    
    Returns:
    
    The node or null
  - getXmlTreeNodeAt
```
public XmlTree.XmlTreeNode getXmlTreeNodeAt(int x,
                                            int y)
```
    Return the xml tree node located at the given position
    
    Parameters:
    
    x - x
    
    y - y
    
    Returns:
    
    The node or null
  - getXmlTreeNodeAtPath
```
protected XmlTree.XmlTreeNode getXmlTreeNodeAtPath(javax.swing.tree.TreePath path)
```
    Return the xml tree node located at the given position
    
    Parameters:
    
    path - The tree path
    
    Returns:
    
    The node or null
  - getXmlElement
```
public org.w3c.dom.Element getXmlElement(javax.swing.tree.TreeNode treeNode)
```
    Return the xml Element that corresponds to the given tree node
    
    Parameters:
    
    treeNode - The tree node
    
    Returns:
    
    The corresponding xml node
  - setMultipleSelect
```
public void setMultipleSelect(boolean v)
```
    Set tree select mode
    
    Parameters:
    
    v - Do multiples?
  - main
```
public static void main(java.lang.String[] args)
```
    Test
    
    Parameters:
    
    args - cmd line args

Class XmlTree

Nested Class Summary

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

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

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JTree

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JTree

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

ATTR_NAME

ATTR_LABEL

ATTR_XLINKHREF

NULL_STRING

Constructor Detail

XmlTree

XmlTree

XmlTree

Method Detail

getIconForNode

getToolTipText

getToolTipText

loadTree

setUseTagNameAsLabel

getUseTagNameAsLabel

setIncludeAttributes

getIncludeAttributes

getSelectedElements

selectElement

getSelectedElement

getXmlRoot

setXmlRoot

treeClick

doDoubleClick

doDoubleClick

doClick

doClick

doRightClick

doRightClick

getContents

getScroller

defineLabelAttr

defineLabelChild

defineTooltipChild

addXlinkTag

addTagsToRecurse

setIconForTag

addTagToRecurse

addTagsToProcess

addTagToProcess

addTagsToNotProcessButRecurse

addTagsToNotRecurse

addTagToNotRecurse

addTagsToNotProcess

addTagToNotProcess

fireTreeWillExpand

expandRelativeUrl

expandRelativeUrl

expandRelativeUrl

readXlinkXml

getXlinkImportLevel

expandXlink

getXlinkImportElements

initXlinkRoot

shouldProcess

getIcon

process

shouldRecurse

getLabel

getXmlNodeAt

getXmlNodeAtPath