org.jlab.coda.eventViewer

Class EventTreePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.jlab.coda.eventViewer.EventTreePanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.TreeSelectionListener

public class EventTreePanel
extends javax.swing.JPanel
implements javax.swing.event.TreeSelectionListener

This is a simple GUI that displays an evio event in a tree. It allows the user to open event files and dictionaries, and go event-by-event showing the event in a JTree.

The text in a tree associated with a particular evio structure is determined by evio's BaseStructure.toString() method. So if you want to change it you must modify this evio code. Note it is the BaseStructure.getDescription() method that returns the dictionary contents for that structure.

Author:

Heddle, Timmer

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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
(package private) int	horizontalDividerPosition Initial width of tree widget when split goes from top to bottom (HORIZONTAL_SPLIT)
(package private) java.util.LinkedList<org.jlab.coda.eventViewer.EventTreePanel.SelectionInfo>	structureSelection Info about the currently selected evio structure being viewed.
(package private) int	verticalDividerPosition Initial height of tree widget when split goes from left to right (VERTICAL_SPLIT)
(package private) boolean	viewData View data or view dictionary?
(package private) boolean	viewText Are we currently viewing numerical data or Composite data in XML (text) ?

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
EventTreePanel() Constructor for a simple tree viewer for evio files.

Method Summary

Modifier and Type	Method and Description
protected void	addComponents() Add the components to this panel.
void	expandAll() Expand all nodes.
org.jlab.coda.jevio.EvioEvent	getEvent() Get the currently displayed event.
HeaderPanel	getHeaderPanel() Get the panel displaying header information.
(package private) javax.swing.tree.TreePath	getNewSelectionPath() Get the current TreePath, if any, that will duplicate the previous selection.
(package private) int	getOrientation() Get the orientation of the separating barrier between tree and data widgets.
java.util.LinkedList<org.jlab.coda.eventViewer.EventTreePanel.SelectionInfo>	getStructureSelection() Get the selection path information list.
void	refreshDescription() Refresh description (dictionary) display.
void	refreshDisplay() Refresh textArea display.
(package private) void	repaintTreeAfterNewDictionary() This method repaints the tree after a new dictionary is loaded.
void	setDataCompressionType(org.jlab.coda.hipo.CompressionType type) Set the compression type of data being viewed.
(package private) void	setDictionaryText(java.lang.String xml) Set the display to the dictionary currently in use.
void	setEvent(org.jlab.coda.jevio.EvioEvent event) Set the currently displayed event.
void	setEvioVersion(int version) Set the evio version of data being viewed.
void	setIntsInHex(boolean intsInHex) Set wether integer data is displayed in hexidecimal or decimal.
(package private) void	setOrientation(int orient) Set the orientation of the separating barrier between tree and data widgets.
(package private) void	setTableData(java.lang.String[] data) Set table's data.
(package private) void	setTextData(java.lang.String[] data) Set table's data.
(package private) void	switchDataAndDictionary() Switch the gui's view between data and any dictionary currently in use.
(package private) void	switchDataAndText(boolean toText) Switch the gui's data view between numerical data and text data.
void	valueChanged(javax.swing.event.TreeSelectionEvent treeSelectionEvent) Selection event on our tree.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, 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

verticalDividerPosition

int verticalDividerPosition

Initial height of tree widget when split goes from left to right (VERTICAL_SPLIT)

horizontalDividerPosition

int horizontalDividerPosition

Initial width of tree widget when split goes from top to bottom (HORIZONTAL_SPLIT)

viewData

boolean viewData

View data or view dictionary?

viewText

boolean viewText

Are we currently viewing numerical data or Composite data in XML (text) ?

structureSelection

java.util.LinkedList<org.jlab.coda.eventViewer.EventTreePanel.SelectionInfo> structureSelection

Info about the currently selected evio structure being viewed. Empty if none or if selection contains evio structures and not actual data. It's a linked list since structure is part of hierarchy.

Constructor Detail

EventTreePanel

public EventTreePanel()

Constructor for a simple tree viewer for evio files.

Method Detail

setEvioVersion

public void setEvioVersion(int version)

Set the evio version of data being viewed.

Parameters:

version - evio version of data being viewed.

setDataCompressionType

public void setDataCompressionType(org.jlab.coda.hipo.CompressionType type)

Set the compression type of data being viewed.

Parameters:

type - compression type of data being viewed.

getStructureSelection

public java.util.LinkedList<org.jlab.coda.eventViewer.EventTreePanel.SelectionInfo> getStructureSelection()

Get the selection path information list.

Returns:

the selection path information list.

setIntsInHex

public void setIntsInHex(boolean intsInHex)

Set wether integer data is displayed in hexidecimal or decimal.

Parameters:

intsInHex - if true then display as hex, else deciaml

getHeaderPanel

public HeaderPanel getHeaderPanel()

Get the panel displaying header information.

Returns:

JPanel with evio header information.

refreshDisplay

public void refreshDisplay()

Refresh textArea display.

refreshDescription

public void refreshDescription()

Refresh description (dictionary) display.

setOrientation

void setOrientation(int orient)

Set the orientation of the separating barrier between tree and data widgets.

Parameters:

orient - orientation to set the barrier to

getOrientation

int getOrientation()

Get the orientation of the separating barrier between tree and data widgets.

Returns:

orientation of the separating barrier between tree and data widgets.

switchDataAndDictionary

void switchDataAndDictionary()

Switch the gui's view between data and any dictionary currently in use.

switchDataAndText

void switchDataAndText(boolean toText)

Switch the gui's data view between numerical data and text data.

Parameters:

toText - switch to viewing Composite data text

setDictionaryText

void setDictionaryText(java.lang.String xml)

Set the display to the dictionary currently in use.

Parameters:

xml - string of xml representing the dictionary to be displayed

setTableData

void setTableData(java.lang.String[] data)

Set table's data.

Parameters:

data - data to place in table.

setTextData

void setTextData(java.lang.String[] data)

Set table's data.

Parameters:

data - data to place in table.

addComponents

protected void addComponents()

Add the components to this panel.

valueChanged

public void valueChanged(javax.swing.event.TreeSelectionEvent treeSelectionEvent)

Selection event on our tree.

Specified by:

valueChanged in interface javax.swing.event.TreeSelectionListener

Parameters:

treeSelectionEvent - the causal event.

repaintTreeAfterNewDictionary

void repaintTreeAfterNewDictionary()

This method repaints the tree after a new dictionary is loaded.

getNewSelectionPath

javax.swing.tree.TreePath getNewSelectionPath()

Get the current TreePath, if any, that will duplicate the previous selection.

Returns:

current TreePath, if any, that will duplicate the previous selection.

getEvent

public org.jlab.coda.jevio.EvioEvent getEvent()

Get the currently displayed event.

Returns:

the currently displayed event.

setEvent

public void setEvent(org.jlab.coda.jevio.EvioEvent event)

Set the currently displayed event.

Parameters:

event - the currently displayed event.

expandAll

public void expandAll()

Expand all nodes.