byucc.jhdl.apps.Viewers.TreeBrowser
Class TreeBrowserPanel

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JScrollPane
                  extended bybyucc.jhdl.apps.Viewers.Event.JHDLWidgetScrollPane
                      extended bybyucc.jhdl.apps.Viewers.TreeBrowser.TreeBrowserPanel
All Implemented Interfaces:
javax.accessibility.Accessible, java.util.EventListener, java.awt.image.ImageObserver, JHDLMouseEventGenerator, JHDLWidgetEventListener, java.awt.MenuContainer, javax.swing.ScrollPaneConstants, java.io.Serializable

public class TreeBrowserPanel
extends JHDLWidgetScrollPane

Displays and allows for selection of components of a Cell. Any TreeBrowserActionListener can be registered with this panel to receive updates on when selections occur. Selections may be of any Cell or sub-Cell of the given root Cell; also, only one cell may be selected at a time. If the user clicks on the same cell multiple times in a row, the same cell remains selected, and the clicking event is dispatched to all listeners. Clicking can be a double clicking or a single clicking; both will also select the node.

Author:
??, aslade
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JScrollPane
javax.swing.JScrollPane.AccessibleJScrollPane, javax.swing.JScrollPane.ScrollBar
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 javax.swing.ImageIcon clIcon
          Image representing combinational logic
static java.awt.Font DEFAULT_FONT
          Sets the look of the font used for displaying cell names
static int DEFAULT_HEIGHT
          Default preferred height
static int DEFAULT_MINIMUM_HEIGHT
           
static int DEFAULT_MINIMUM_WIDTH
           
static int DEFAULT_WIDTH
          Default preferred width
 javax.swing.ImageIcon expIcon
          Image used to show that a Cell is expanded
 javax.swing.ImageIcon memIcon
          Image representing Memory cells
static int OFFSET
          TreeBrowserNode uses this value for the offset between images
 javax.swing.ImageIcon structIcon
          Image representing structural cells
 javax.swing.ImageIcon syncIcon
          Image representing synchronous cells
 javax.swing.ImageIcon tbIcon
          Image representing TestBenches
 javax.swing.ImageIcon unexpIcon
          Image used to show that a Cell is unexpanded
 
Fields inherited from class javax.swing.JScrollPane
columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport
 
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 javax.swing.ScrollPaneConstants
COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
TreeBrowserPanel(Cell rNode)
          Deprecated.  
TreeBrowserPanel(Cell rNode, JHDLHostWidgetInterface hwi)
          Constructs a new TreeBrowserPanel--New constructor, so that this panel can pass the JHDLHostWidgetInterface to its parent to get the call chain ready to be initialized.
 
Method Summary
 void addTreeBrowserActionListener(TreeBrowserActionListener listener)
          Deprecated.  
 Cell getSelectedCell()
           
 void JHDLWidgetEventPerformed(JHDLWidgetEvent we)
          Method called by {@link byucc.jhdl.apps.Viewers.Event.JHDLWidgetEventGenerator objects that this object is listening to.
 void loadClass(Cell rNode)
          Sets the given Cell as the root node of the tree to view
 void removeTreeBrowserActionListener(TreeBrowserActionListener listener)
          Deprecated.  
 void setInvisibleCellsVisible(boolean visible)
          Used to set invisible cells as displayed or not.
 boolean showInvisibleCells()
          Indicates whether invisible cells should be displayed or not.
 void updateAppUI()
           
 void updateUI()
           
 
Methods inherited from class byucc.jhdl.apps.Viewers.Event.JHDLWidgetScrollPane
addJHDLMouseEventListener, fireJHDLMouseEvent, fireJHDLMouseEvent, removeJHDLMouseEventListener, setupJHDLEvents
 
Methods inherited from class javax.swing.JScrollPane
createHorizontalScrollBar, createVerticalScrollBar, createViewport, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setViewportView, setWheelScrollingEnabled
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, 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

DEFAULT_FONT

public static final java.awt.Font DEFAULT_FONT
Sets the look of the font used for displaying cell names


DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT
Default preferred height

See Also:
Constant Field Values

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH
Default preferred width

See Also:
Constant Field Values

OFFSET

public static final int OFFSET
TreeBrowserNode uses this value for the offset between images

See Also:
Constant Field Values

DEFAULT_MINIMUM_WIDTH

public static final int DEFAULT_MINIMUM_WIDTH
See Also:
Constant Field Values

DEFAULT_MINIMUM_HEIGHT

public static final int DEFAULT_MINIMUM_HEIGHT
See Also:
Constant Field Values

tbIcon

public javax.swing.ImageIcon tbIcon
Image representing TestBenches


memIcon

public javax.swing.ImageIcon memIcon
Image representing Memory cells


syncIcon

public javax.swing.ImageIcon syncIcon
Image representing synchronous cells


clIcon

public javax.swing.ImageIcon clIcon
Image representing combinational logic


structIcon

public javax.swing.ImageIcon structIcon
Image representing structural cells


unexpIcon

public javax.swing.ImageIcon unexpIcon
Image used to show that a Cell is unexpanded


expIcon

public javax.swing.ImageIcon expIcon
Image used to show that a Cell is expanded

Constructor Detail

TreeBrowserPanel

public TreeBrowserPanel(Cell rNode,
                        JHDLHostWidgetInterface hwi)
Constructs a new TreeBrowserPanel--New constructor, so that this panel can pass the JHDLHostWidgetInterface to its parent to get the call chain ready to be initialized.

Parameters:
rNode - The cell that this Panel will be initialized from.
hwi - The JHDLHostWidgetInterface this panel will send to its parent.

TreeBrowserPanel

public TreeBrowserPanel(Cell rNode)
Deprecated.  

Method Detail

updateAppUI

public void updateAppUI()

getSelectedCell

public Cell getSelectedCell()
Returns:
the currently selected cell or null if no cell selected.

loadClass

public void loadClass(Cell rNode)
Sets the given Cell as the root node of the tree to view

Parameters:
rNode - the new root node of the tree

setInvisibleCellsVisible

public void setInvisibleCellsVisible(boolean visible)
Used to set invisible cells as displayed or not. Will also redraw the tree if needed

Parameters:
visible - if true, "invisible" cells will be displayed

showInvisibleCells

public boolean showInvisibleCells()
Indicates whether invisible cells should be displayed or not.

Returns:
true if invisible are meant to be shown

updateUI

public void updateUI()

JHDLWidgetEventPerformed

public void JHDLWidgetEventPerformed(JHDLWidgetEvent we)
Method called by {@link byucc.jhdl.apps.Viewers.Event.JHDLWidgetEventGenerator objects that this object is listening to. This method interprets the event and updates the display accordingly.

Parameters:
we - The passed in JHDLWidgetEvent object.

addTreeBrowserActionListener

public void addTreeBrowserActionListener(TreeBrowserActionListener listener)
Deprecated.  


removeTreeBrowserActionListener

public void removeTreeBrowserActionListener(TreeBrowserActionListener listener)
Deprecated.  



Copyright ? 2006 Brigham Young University, Configurable Computing Laboratory. All Rights Reserved.