com.goldencode.p2j.ui.client.widgetbrowser

Class ContainerTree

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTree

com.goldencode.p2j.ui.client.widgetbrowser.ContainerTree

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable

public class ContainerTree
extends javax.swing.JTree

The tree Widget Browser component.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ContainerTree.NodeRenderer
class	ContainerTree.WidgetWrapper Wrapper class to help store Widget references in the tree component.

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
private java.awt.event.ActionListener	actionListener Event listener.
private Container<?>	container The root container.
private java.lang.Iterable<java.lang.String>	inclusions The property table inclusion strings.
private boolean	showFullClassName Full class names flag.
private boolean	showLegacyOnly Show legacy only flag.
private PropertyTable	table Related property table components.

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, treeModel, 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
ContainerTree(Container<?> container, PropertyTable table) The constructor.

Method Summary

Modifier and Type	Method and Description
private javax.swing.tree.DefaultMutableTreeNode	buildTreeModel(Container<?> container, javax.swing.tree.DefaultMutableTreeNode parent) The worker method responsible for building the tree nodes in the tree component.
private java.lang.String	buildWidgetQualifier(Widget<?> widget) Build widget qualifier uniquely identifying its position in the object tree.
void	collapseAll() Collapse all tree nodes.
void	copyPropertiesToClipboard() Copies the filtered properties to system clipboard recursively starting from the selected node.
private void	dumpProperties(java.util.List<Widget<?>> widgets, java.lang.StringBuilder sb) Recursively dumps widget properties to the passed-in string builder.
void	expandAll() Expand all tree nodes.
private void	expandRows(java.util.List<javax.swing.tree.TreePath> paths) Expand the supplied tree paths.
private static java.util.SortedMap<java.lang.String,java.lang.Object>	filterProperties(java.util.SortedMap<java.lang.String,java.lang.Object> props, java.lang.Iterable<java.lang.String> inclusions) Filters the passed in map of properties.
javax.swing.tree.TreePath	findNode(Widget<?> subject) Returns the related tree path for the supplied widget.
private java.util.List<javax.swing.tree.TreePath>	findNodes(java.util.List<Widget<?>> subjects) Finds tree paths for the supplied list of widgets.
private void	findNodes(javax.swing.tree.TreeModel model, java.lang.Object node, java.util.List<Widget<?>> subjects, java.util.List<javax.swing.tree.TreePath> output) Recursively finds tree paths for the supplied list of widgets.
private java.lang.String	formatValue(java.lang.Object obj) Formats the supplied reference into a string.
private java.lang.String	formatWidget(Widget<?> widget) Formats the supplied reference into a string.
private void	getAllFields(java.util.Map<java.lang.String,java.lang.Object> result, java.lang.String namespace, java.lang.Object ref) Gathers all ref's fields and puts them into result.
private java.util.List<Widget<?>>	getExpandedWidgets() Returns the list of expanded widgets in the tree.
Widget<?>	getSelectedWidget() Returns widget selected in the tree.
private java.util.SortedMap<java.lang.String,java.lang.Object>	getWidgetProperties(Widget<?> widget, java.lang.Iterable<java.lang.String> inclusions) Builds map of properties to display in the property table.
boolean	isSelected(Widget<?> widget) Checks whether the supplied node is selected.
boolean	isShowFullClassName() Returns the state of show full class names flag.
void	refresh() Refreshes (rebuilds) the tree nodes.
void	refreshPropertyTable() Refreshes the property table associated with this tree component.
void	setActionListener(java.awt.event.ActionListener actionListener) Sets the event listener.
void	setPropertyInclusions(java.lang.Iterable<java.lang.String> inclusions) Setter for the property inclusions.
void	setShowFullClassName(boolean showFullClassName) Sets the state of show full class names flag.
void	setShowLegacyOnly(boolean showLegacyOnly) Sets the state of show legacy only flag.
private javax.swing.tree.DefaultMutableTreeNode	sortNodes(javax.swing.tree.DefaultMutableTreeNode node) Sorts the tree nodes.

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, fireTreeWillExpand, 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, getToolTipText, 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

showFullClassName

private boolean showFullClassName

Full class names flag.

showLegacyOnly

private boolean showLegacyOnly

Show legacy only flag.

actionListener

private java.awt.event.ActionListener actionListener

Event listener.

table

private PropertyTable table

Related property table components.

inclusions

private java.lang.Iterable<java.lang.String> inclusions

The property table inclusion strings.

container

private Container<?> container

The root container.

Constructor Detail

ContainerTree

public ContainerTree(Container<?> container,
                     PropertyTable table)

The constructor.

Parameters:

container - The root container.

table - The related property table component.

Method Detail

setActionListener

public void setActionListener(java.awt.event.ActionListener actionListener)

Sets the event listener.

Parameters:

actionListener - Valid ActionListener reference.

isShowFullClassName

public boolean isShowFullClassName()

Returns the state of show full class names flag.

Returns:

The show full class name flag.

setShowFullClassName

public void setShowFullClassName(boolean showFullClassName)

Sets the state of show full class names flag.

Parameters:

showFullClassName - The show full class name flag.

setShowLegacyOnly

public void setShowLegacyOnly(boolean showLegacyOnly)

Sets the state of show legacy only flag.

Parameters:

showLegacyOnly - The show legacy only flag.

setPropertyInclusions

public void setPropertyInclusions(java.lang.Iterable<java.lang.String> inclusions)

Setter for the property inclusions.

Parameters:

inclusions - The setter value.

refresh

public void refresh()

Refreshes (rebuilds) the tree nodes.

refreshPropertyTable

public void refreshPropertyTable()

Refreshes the property table associated with this tree component.

collapseAll

public void collapseAll()

Collapse all tree nodes.

expandAll

public void expandAll()

Expand all tree nodes.

findNode

public javax.swing.tree.TreePath findNode(Widget<?> subject)

Returns the related tree path for the supplied widget.

Parameters:

subject - The Widget reference.

Returns:

TreePath instance or null if not found.

isSelected

public boolean isSelected(Widget<?> widget)

Checks whether the supplied node is selected.

Parameters:

widget - The Widget reference.

Returns:

true if selected, false otherwise.

getSelectedWidget

public Widget<?> getSelectedWidget()

Returns widget selected in the tree.

Returns:

Widget instance of null.

copyPropertiesToClipboard

public void copyPropertiesToClipboard()

Copies the filtered properties to system clipboard recursively starting from the selected node.

dumpProperties

private void dumpProperties(java.util.List<Widget<?>> widgets,
                            java.lang.StringBuilder sb)

Recursively dumps widget properties to the passed-in string builder.

Parameters:

widgets - The widgets from where (including) to start dumping the properties.

sb - A valid string builder reference.

buildWidgetQualifier

private java.lang.String buildWidgetQualifier(Widget<?> widget)

Build widget qualifier uniquely identifying its position in the object tree.

Parameters:

widget - A valid widget reference.

Returns:

The qualifier string.

buildTreeModel

private javax.swing.tree.DefaultMutableTreeNode buildTreeModel(Container<?> container,
                                                               javax.swing.tree.DefaultMutableTreeNode parent)

The worker method responsible for building the tree nodes in the tree component.

Parameters:

container - The root container.

parent - The parent node where the built nodes will be added to.

Returns:

The root tree node.

sortNodes

private javax.swing.tree.DefaultMutableTreeNode sortNodes(javax.swing.tree.DefaultMutableTreeNode node)

Sorts the tree nodes.

Parameters:

node - The tree node where to start the sort.

Returns:

The root node of the sorted tree.

getExpandedWidgets

private java.util.List<Widget<?>> getExpandedWidgets()

Returns the list of expanded widgets in the tree.

Returns:

List of widgets.

expandRows

private void expandRows(java.util.List<javax.swing.tree.TreePath> paths)

Expand the supplied tree paths.

Parameters:

paths - List of tree paths.

findNodes

private java.util.List<javax.swing.tree.TreePath> findNodes(java.util.List<Widget<?>> subjects)

Finds tree paths for the supplied list of widgets.

Parameters:

subjects - List of Widget references.

Returns:

List of TreePath references.

findNodes

private void findNodes(javax.swing.tree.TreeModel model,
                       java.lang.Object node,
                       java.util.List<Widget<?>> subjects,
                       java.util.List<javax.swing.tree.TreePath> output)

Recursively finds tree paths for the supplied list of widgets.

Parameters:

model - TreeModel reference.

node - The root node.

subjects - List of Widget references.

output - A valid instance of List of TreePath references where to store the result.

getWidgetProperties

private java.util.SortedMap<java.lang.String,java.lang.Object> getWidgetProperties(Widget<?> widget,
                                                                                   java.lang.Iterable<java.lang.String> inclusions)

Builds map of properties to display in the property table. The map is sorted by property keys in ascending order.

The caller can pass a collection of inclusion patterns. An inclusion pattern is a string that may contain a wildcard character at the beginning or end of the string. Properties that match any of the inclusion patterns are returned.

Parameters:

widget - The widget instance which will be introspected for properties.

inclusions - The collection of inclusion patterns. May be null or empty, in which case all properties are returned.

Returns:

map of string-object entries.

getAllFields

private void getAllFields(java.util.Map<java.lang.String,java.lang.Object> result,
                          java.lang.String namespace,
                          java.lang.Object ref)

Gathers all ref's fields and puts them into result. Field name is used the key into the map. If namespace is non-empty, the key is prepended with its value.

Parameters:

result - The result map where the ref's field name-values are stored.

namespace - The string to be prepended with the field names to form a "compound" key in the resulting map. May be null.

ref - The object whose fields are introspected.

filterProperties

private static java.util.SortedMap<java.lang.String,java.lang.Object> filterProperties(java.util.SortedMap<java.lang.String,java.lang.Object> props,
                                                                                       java.lang.Iterable<java.lang.String> inclusions)

Filters the passed in map of properties.

Parameters:

props - The property map.

inclusions - The inclusion patterns applied to the property map.

Returns:

Returns the filtered property map.

formatValue

private java.lang.String formatValue(java.lang.Object obj)

Formats the supplied reference into a string.

Parameters:

obj - A reference, may be null.

Returns:

The formatted value.

formatWidget

private java.lang.String formatWidget(Widget<?> widget)

Formats the supplied reference into a string.

Parameters:

widget - A valid Widget reference.

Returns:

The formatted string.