org.jlab.coda.eventViewer

Class EventTreeMenu

java.lang.Object

org.jlab.coda.eventViewer.EventTreeMenu

public class EventTreeMenu
extends java.lang.Object

This class creates the menus used in the GUI.

Author:

Heddle, Timmer

Field Summary

Fields

Modifier and Type	Field and Description
(package private) EventInfoPanel	eventInfoPanel
(package private) javax.swing.JButton	nextButton A button for selecting "next" event.
(package private) javax.swing.JButton	prevButton A button for selecting "previous" event.
(package private) boolean	useEvioFileFilter Remember if evio file extension filter was used last time.

Constructor Summary

Constructors

Constructor and Description
EventTreeMenu(EventTreePanel eventTreePanel, EventInfoPanel eventInfoPanel) Constructor.

Method Summary

Modifier and Type	Method and Description
(package private) javax.swing.JPanel	addEventControlPanel() Create a panel to change events in viewer.
void	addEventFileExtension(java.lang.String extension) Add a file extension for viewing evio format files in file chooser.
void	addEvioListener(org.jlab.coda.jevio.IEvioListener listener) Add an Evio listener.
javax.swing.JMenu	createDictionaryMenu() Create the view menu.
javax.swing.JMenu	createEventMenu() Create the event menu.
javax.swing.JMenu	createFileMenu() Create the file menu.
javax.swing.JMenu	createFilterMenu() Create the filter menu.
javax.swing.JMenu	createViewMenu() Create the view menu.
void	exportToXML() Select a file and then write into it the current event file in xml format.
cMsgHandler	getCmsgHandler()
javax.swing.JMenu	getEventSourceConfig()
EventTreePanel	getEventTreePanel() Get the main event display panel.
org.jlab.coda.jevio.EvioReader	getEvioFileReader() Get the EvioReader object so the file/buffer can be read.
void	manualOpenEventFile(java.io.File file) Convenience method to open a file programmatically.
boolean	openDictionary() Select and open a dictionary.
void	openDictionaryFile(java.io.File file) Select and open a dictionary.
org.jlab.coda.jevio.EvioReader	openEventFile() Select and open an event file.
org.jlab.coda.jevio.EvioReader	openEventFile(java.io.File file) Open an event file using a given file.
void	setCmsgHandler(cMsgHandler cmsgHandler)
void	setDefaultDataDir(java.lang.String defaultDataDir) Set the default directory in which to look for event files.
void	setEventFileExtensions(java.lang.String[] extensions) Set all file extensions for viewing evio format files in file chooser.
java.io.File	viewFileBytes() Select a file in order to view its bytes.

Methods inherited from class java.lang.Object

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

Field Detail

nextButton

javax.swing.JButton nextButton

A button for selecting "next" event.

prevButton

javax.swing.JButton prevButton

A button for selecting "previous" event.

useEvioFileFilter

boolean useEvioFileFilter

Remember if evio file extension filter was used last time.

eventInfoPanel

EventInfoPanel eventInfoPanel

Constructor Detail

EventTreeMenu

public EventTreeMenu(EventTreePanel eventTreePanel,
                     EventInfoPanel eventInfoPanel)

Constructor. Holds the menus for a frame or internal frame that wants to manage a tree panel.

Parameters:

eventTreePanel - panel that holds the tree and all associated the widgets.

eventInfoPanel - panel that displays evio event info - event source, dictionary source.

Method Detail

getEventTreePanel

public EventTreePanel getEventTreePanel()

Get the main event display panel.

Returns:

main event display panel.

getEventSourceConfig

public javax.swing.JMenu getEventSourceConfig()

getCmsgHandler

public cMsgHandler getCmsgHandler()

setCmsgHandler

public void setCmsgHandler(cMsgHandler cmsgHandler)

addEventControlPanel

javax.swing.JPanel addEventControlPanel()

Create a panel to change events in viewer.

Returns:

panel created.

createEventMenu

public javax.swing.JMenu createEventMenu()

Create the event menu.

Returns:

the event menu.

createViewMenu

public javax.swing.JMenu createViewMenu()

Create the view menu.

Returns:

the view menu.

createDictionaryMenu

public javax.swing.JMenu createDictionaryMenu()

Create the view menu.

Returns:

the view menu.

createFilterMenu

public javax.swing.JMenu createFilterMenu()

Create the filter menu.

Returns:

the filter menu.

createFileMenu

public javax.swing.JMenu createFileMenu()

Create the file menu.

Returns:

the file menu.

manualOpenEventFile

public void manualOpenEventFile(java.io.File file)

Convenience method to open a file programmatically.

Parameters:

file - the file to open

exportToXML

public void exportToXML()

Select a file and then write into it the current event file in xml format.

addEventFileExtension

public void addEventFileExtension(java.lang.String extension)

Add a file extension for viewing evio format files in file chooser.

Parameters:

extension - file extension to add

setEventFileExtensions

public void setEventFileExtensions(java.lang.String[] extensions)

Set all file extensions for viewing evio format files in file chooser.

Parameters:

extensions - all file extensions

openEventFile

public org.jlab.coda.jevio.EvioReader openEventFile()

Select and open an event file.

Returns:

the opened file reader, or null

viewFileBytes

public java.io.File viewFileBytes()

Select a file in order to view its bytes.

Returns:

File object of opened file.

openEventFile

public org.jlab.coda.jevio.EvioReader openEventFile(java.io.File file)

Open an event file using a given file.

Parameters:

file - the file to use, i.e., an event file

Returns:

the opened file reader, or null

getEvioFileReader

public org.jlab.coda.jevio.EvioReader getEvioFileReader()

Get the EvioReader object so the file/buffer can be read.

Returns:

EvioReader object

setDefaultDataDir

public void setDefaultDataDir(java.lang.String defaultDataDir)

Set the default directory in which to look for event files.

Parameters:

defaultDataDir - default directory in which to look for event files

openDictionary

public boolean openDictionary()

Select and open a dictionary.

Returns:

true if file was opened and dictionary loaded.

openDictionaryFile

public void openDictionaryFile(java.io.File file)

Select and open a dictionary.

Parameters:

file - file to open

addEvioListener

public void addEvioListener(org.jlab.coda.jevio.IEvioListener listener)

Add an Evio listener. Evio listeners listen for structures encountered when an event is being parsed. The listeners are passed to the EventParser once a file is opened.

Parameters:

listener - The Evio listener to add.