edu.rice.cs.drjava.ui
Class RegionsTreePanel<R extends OrderedDocumentRegion>

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  edu.rice.cs.drjava.ui.TabbedPanel
                      edu.rice.cs.drjava.ui.RegionsTreePanel<R>

All Implemented Interfaces:

DropTargetListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

BookmarksPanel, BreakpointsPanel, FindResultsPanel

public abstract class RegionsTreePanel<R extends OrderedDocumentRegion>
extends TabbedPanel

Panel for displaying regions in a tree sorted by class name and line number. Only accessed from event thread. The volatile declarations are included because the event-thread-only invariant is not enforced. TODO: fix this.

Version:

$Id: RegionsTreePanel.java 5553 2012-05-01 17:28:45Z rcartwright $

See Also:

Serialized Form

Nested Class Summary

protected class	RegionsTreePanel.DefaultState Normal state, GUI changes not delayed.
protected static interface	RegionsTreePanel.IChangeState State pattern for improving performance during rapid updates.
protected class	RegionsTreePanel.RegionMouseAdapter Mouse adapter for the region tree.
(package private) class	RegionsTreePanel.RegionRenderer Adds config color support to DefaultTreeCellEditor.
protected class	RegionsTreePanel.RegionTree
protected static class	RegionsTreePanel.RegionTreeUserObj<R extends OrderedDocumentRegion> Class that is embedded in each leaf node.

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

protected JPanel	_buttonPanel
protected RegionsTreePanel.IChangeState	_changeState
protected HashMap<OpenDefinitionsDocument,DefaultMutableTreeNode>	_docToTreeNode A table mapping each document entered in this panel to its corresponding MutableTreeNode in _regTreeModel.
protected MainFrame	_frame
protected boolean	_hasNextPrevButtons
protected R	_lastSelectedRegion the region that was last selected (may be null).
protected JPanel	_leftPane
protected SingleDisplayModel	_model
protected JButton	_nextButton button to go to the next region (or null if _hasNextPrevButtons==false).
protected JButton	_prevButton button to go to the previous region (or null if _hasNextPrevButtons==false).
private RegionManager<R>	_regionManager
protected JPopupMenu	_regionPopupMenu
protected IdentityHashMap<R,DefaultMutableTreeNode>	_regionToTreeNode A table mapping each region entered in this panel to its corresponding MutableTreeNode in _regTreeModel.
private JTree	_regTree
private DefaultTreeModel	_regTreeModel
private DefaultMutableTreeNode	_rootNode
private String	_title
protected RegionsTreePanel.IChangeState	DEFAULT_STATE State pattern to improve performance when rapid changes are made.
protected DefaultTreeCellRenderer	dtcr

Fields inherited from class edu.rice.cs.drjava.ui.TabbedPanel

_closeButton, _closePanel, _displayed, _mainPanel, dropTarget

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

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

RegionsTreePanel(MainFrame frame, String title, RegionManager<R> regionManager)
Constructs a new panel to display regions in a tree.

RegionsTreePanel(MainFrame frame, String title, RegionManager<R> regionManager, boolean hasNextPrevButtons)
Constructs a new panel to display regions in a tree.

Method Summary

protected void	_close() Close the panel and update buttons.
private void	_initPopup() Initializes the pop-up menu.
protected void	_remove() Remove the selected regions.
protected boolean	_requestFocusInWindow() Forces the panel to be updated and requests focus in this panel.
private static void	_setColors(Component c) Quick helper for setting up color listeners.
private void	_setupButtonPanel() Creates the buttons for controlling the regions.
private void	_setupRegionTree() Creates the region tree.
protected void	_updateButtons()
void	addRegion(R r) Add a region to the tree.
protected void	closeIfEmpty() Close the panel if the tree becomes empty.
void	collapseAll() Collapse all tree nodes.
void	expandAll() Expand all tree nodes.
private void	expandRecursive(JTree tree, TreePath parent, boolean expand)
void	expandTree() Expands all nodes in a two-level tree.
SingleDisplayModel	getGlobalModel()
protected R	getNextRegionInTree(R r) Return the region following r in the tree, or null if there isn't one.
(package private) DefaultMutableTreeNode	getNode(OpenDefinitionsDocument doc) Gets the tree node for the given document.
(package private) DefaultMutableTreeNode	getNode(R region) Gets the tree node for the given region.
protected R	getPrevRegionInTree(R r) Return the region preceding r in the tree, or null if there isn't one.
RegionManager<R>	getRegionManager()
JTree	getRegTree()
DefaultTreeModel	getRegTreeModel()
DefaultMutableTreeNode	getRootNode()
protected ArrayList<R>	getSelectedRegions() Gets the currently selected regions in the region tree, or an empty array if no regions are selected.
String	getTitle()
void	goToNextRegion() Go to next region.
void	goToPreviousRegion() Go to previous region.
protected void	goToRegion() Go to region.
private void	insertNewRegionNode(R r, DefaultMutableTreeNode docNode, int pos)
protected JComponent[]	makeButtons() Creates the buttons for controlling the regions.
protected AbstractAction[]	makePopupMenuActions() Makes the popup menu actions.
protected RegionsTreePanel.RegionTreeUserObj<R>	makeRegionTreeUserObj(R r) Factory method to create user objects put in the tree.
protected void	performDefaultAction() Action performed when the Enter key is pressed.
void	reload(R startRegion, R endRegion)
void	removeRegion(R r) Remove a region from this panel.
boolean	requestFocusInWindow() Update the JTree.
protected void	selectRegion(R r) Select a region in this panel.
protected void	updateButtons() Update button state and text.
protected void	updateNextPreviousRegionButtons() Update the enabled/disabled state of the next/previous region buttons.
protected void	updateNextPreviousRegionButtons(R lastSelectedRegion) Update the enabled/disabled state of the next/previous region buttons.
protected void	updatePanel() Forces this panel to be completely updated.

Methods inherited from class edu.rice.cs.drjava.ui.TabbedPanel

addCloseListener, dragEnter, dragExit, dragOver, drop, dropActionChanged, getMainPanel, getName, isDisplayed, setDisplayed, setVisible

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, 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, transferFocusBackward, 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, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_leftPane

protected volatile JPanel _leftPane

_rootNode

private volatile DefaultMutableTreeNode _rootNode

_regTreeModel

private volatile DefaultTreeModel _regTreeModel

_regTree

private volatile JTree _regTree

_title

private volatile String _title

_regionManager

private volatile RegionManager<R extends OrderedDocumentRegion> _regionManager

_regionPopupMenu

protected volatile JPopupMenu _regionPopupMenu

_model

protected final SingleDisplayModel _model

_frame

protected final MainFrame _frame

_buttonPanel

protected volatile JPanel _buttonPanel

dtcr

protected volatile DefaultTreeCellRenderer dtcr

_hasNextPrevButtons

protected volatile boolean _hasNextPrevButtons

_prevButton

protected volatile JButton _prevButton

button to go to the previous region (or null if _hasNextPrevButtons==false).

_nextButton

protected volatile JButton _nextButton

button to go to the next region (or null if _hasNextPrevButtons==false).

_lastSelectedRegion

protected volatile R extends OrderedDocumentRegion _lastSelectedRegion

the region that was last selected (may be null).

DEFAULT_STATE

protected final RegionsTreePanel.IChangeState DEFAULT_STATE

State pattern to improve performance when rapid changes are made.

_changeState

protected volatile RegionsTreePanel.IChangeState _changeState

_docToTreeNode

protected volatile HashMap<OpenDefinitionsDocument,DefaultMutableTreeNode> _docToTreeNode

A table mapping each document entered in this panel to its corresponding MutableTreeNode in _regTreeModel.

_regionToTreeNode

protected volatile IdentityHashMap<R extends OrderedDocumentRegion,DefaultMutableTreeNode> _regionToTreeNode

A table mapping each region entered in this panel to its corresponding MutableTreeNode in _regTreeModel.

Constructor Detail

RegionsTreePanel

public RegionsTreePanel(MainFrame frame,
                        String title,
                        RegionManager<R> regionManager)

Constructs a new panel to display regions in a tree. This is swing view class and hence should only be accessed from the event thread.

Parameters:

frame - the MainFrame

title - title of the pane

regionManager - the region manager associated with this panel

RegionsTreePanel

public RegionsTreePanel(MainFrame frame,
                        String title,
                        RegionManager<R> regionManager,
                        boolean hasNextPrevButtons)

Constructs a new panel to display regions in a tree. This is swing view class and hence should only be accessed from the event thread.

Parameters:

frame - the MainFrame

title - title of the pane

regionManager - the region manager associated with this panel

hasNextPrevButtons - whether this panel should have next/previous buttons

Method Detail

_setColors

private static void _setColors(Component c)

Quick helper for setting up color listeners.

_close

protected void _close()

Close the panel and update buttons.

Overrides:

_close in class TabbedPanel

requestFocusInWindow

public boolean requestFocusInWindow()

Update the JTree.

Overrides:

requestFocusInWindow in class TabbedPanel

updatePanel

protected void updatePanel()

Forces this panel to be completely updated.

_requestFocusInWindow

protected boolean _requestFocusInWindow()

Forces the panel to be updated and requests focus in this panel.

_setupRegionTree

private void _setupRegionTree()

Creates the region tree.

getRootNode

public DefaultMutableTreeNode getRootNode()

getRegTree

public JTree getRegTree()

getRegTreeModel

public DefaultTreeModel getRegTreeModel()

getTitle

public String getTitle()

getRegionManager

public RegionManager<R> getRegionManager()

getGlobalModel

public SingleDisplayModel getGlobalModel()

updateButtons

protected void updateButtons()

Update button state and text. _updateButtons should be overridden if additional buttons are added besides "Go To", "Remove" and "Remove All".

_updateButtons

protected void _updateButtons()

expandAll

public void expandAll()

Expand all tree nodes.

collapseAll

public void collapseAll()

Collapse all tree nodes.

_remove

protected void _remove()

Remove the selected regions.

expandRecursive

private void expandRecursive(JTree tree,
                             TreePath parent,
                             boolean expand)

performDefaultAction

protected void performDefaultAction()

Action performed when the Enter key is pressed. Should be overridden.

makeButtons

protected JComponent[] makeButtons()

Creates the buttons for controlling the regions. Should be overridden.

_setupButtonPanel

private void _setupButtonPanel()

Creates the buttons for controlling the regions.

makePopupMenuActions

protected AbstractAction[] makePopupMenuActions()

Makes the popup menu actions. Should be overridden.

_initPopup

private void _initPopup()

Initializes the pop-up menu.

getNode

DefaultMutableTreeNode getNode(OpenDefinitionsDocument doc)

Gets the tree node for the given document.

getNode

DefaultMutableTreeNode getNode(R region)

Gets the tree node for the given region.

getSelectedRegions

protected ArrayList<R> getSelectedRegions()

Gets the currently selected regions in the region tree, or an empty array if no regions are selected.

Returns:

list of selected regions in the tree TODO: change this code to use getMinSelectionRow and getMaxSelectionRow

goToRegion

protected void goToRegion()

Go to region.

updateNextPreviousRegionButtons

protected void updateNextPreviousRegionButtons()

Update the enabled/disabled state of the next/previous region buttons. Doesn't change _lastSelectedRegion. Safe to call even if _hasNextPrevButtons==false.

updateNextPreviousRegionButtons

protected void updateNextPreviousRegionButtons(R lastSelectedRegion)

Update the enabled/disabled state of the next/previous region buttons. Safe to call even if _hasNextPrevButtons==false.

Parameters:

lastSelectedRegion - new region selected

goToPreviousRegion

public void goToPreviousRegion()

Go to previous region. Must be run in event thread.

getPrevRegionInTree

protected R getPrevRegionInTree(R r)

Return the region preceding r in the tree, or null if there isn't one.

goToNextRegion

public void goToNextRegion()

Go to next region.

getNextRegionInTree

protected R getNextRegionInTree(R r)

Return the region following r in the tree, or null if there isn't one.

addRegion

public void addRegion(R r)

Add a region to the tree. Must be executed in event thread.

Parameters:

r - the region

insertNewRegionNode

private void insertNewRegionNode(R r,
                                 DefaultMutableTreeNode docNode,
                                 int pos)

expandTree

public void expandTree()

Expands all nodes in a two-level tree.

removeRegion

public void removeRegion(R r)

Remove a region from this panel. Must be executed in event thread.

Parameters:

r - the region

selectRegion

protected void selectRegion(R r)

Select a region in this panel. Must be executed in event thread.

Parameters:

r - the region

closeIfEmpty

protected void closeIfEmpty()

Close the panel if the tree becomes empty.

reload

public void reload(R startRegion,
                   R endRegion)

makeRegionTreeUserObj

protected RegionsTreePanel.RegionTreeUserObj<R> makeRegionTreeUserObj(R r)

Factory method to create user objects put in the tree. If subclasses extend RegionTreeUserObj, they need to override this method.