Main application window. More...

Inheritance diagram for sortie.gui.MainWindow:

Classes
class	RunListener
	Runs the window's timer code while the C++ core is running.

Public Member Functions
	MainWindow ()
	Constructor. More...

void	sendMessage (ModelMessage oMsg)
	SendMessage accepts a message from the interface. More...

GUIManager	getDataManager ()
	Gets the GUI manager. More...

void	closeOneDataFile (String sFileName)
	Closes a single output file and manages the file list. More...

void	setModelState (int iState)
	Sets the current window state. More...

int	getModelState ()
	Gets the current window state. More...

void	actionPerformed (ActionEvent oEvent)
	Manages window events. More...

void	updateChartChoices ()
	Updates the chart choices in the data visualization panel according to the file which is selected in the file list. More...

void	windowActivated (WindowEvent e)
	Not implemented. More...

void	windowClosed (WindowEvent e)
	Not implemented. More...

void	windowClosing (WindowEvent e)
	Ensures the application closes when this window closes. More...

void	windowDeactivated (WindowEvent e)
	Not implemented. More...

void	windowDeiconified (WindowEvent e)
	Not implemented. More...

void	windowIconified (WindowEvent e)
	Not implemented. More...

void	windowOpened (WindowEvent e)
	Not implemented. More...

void	internalFrameClosed (InternalFrameEvent e)
	Handles the closing of chart windows. More...

void	internalFrameClosing (InternalFrameEvent e)

void	internalFrameDeactivated (InternalFrameEvent e)

void	internalFrameDeiconified (InternalFrameEvent e)

void	internalFrameIconified (InternalFrameEvent e)

void	internalFrameOpened (InternalFrameEvent e)

void	internalFrameActivated (InternalFrameEvent e)
	When a chart window is activated, this also brings its legend to the top. More...

Public Attributes
HelpBroker	m_oHelpBroker
	JavaHelp class for managing help displays. More...

Protected Member Functions
void	doFileCloseData ()
	Opens an output file. More...

void	doFileSave ()
	File \| Save Parameter File action performed. More...

void	doFileTextSave ()
	File \| Save Parameter File as text action performed. More...

void	setCursorToDefault ()
	Changes the cursor to the default. More...

Protected Attributes
JMenuItem	m_jMenuFileNew
	File - new menu item. More...

JMenuItem	m_jMenuFileBatchNew
	File - new batch file menu item. More...

JMenuItem	m_jMenuFileOpen
	File - open file menu item. More...

JMenuItem	m_jMenuFileSave
	File - file save menu item. More...

JMenuItem	m_jMenuTextFileSave
	File - text file save menu item. More...

JMenuItem	m_jMenuFileOpenData
	File - open output file menu item. More...

JMenuItem	m_jMenuFileCloseData
	File - close output file menu item. More...

JMenuItem	m_jMenuFileSetDir
	File - set working directory menu item. More...

JMenuItem	m_jMenuFileRecentFile1 = new JMenuItem("", KeyEvent.VK_1)
	File - recent file 1 menu item. More...

JMenuItem	m_jMenuFileRecentFile2 = new JMenuItem("", KeyEvent.VK_2)
	File - recent file 2 menu item. More...

JMenuItem	m_jMenuFileRecentFile3 = new JMenuItem("", KeyEvent.VK_3)
	File - recent file 3 menu item. More...

JMenuItem	m_jMenuFileRecentFile4 = new JMenuItem("", KeyEvent.VK_4)
	File - recent file 4 menu item. More...

JMenuItem	m_jMenuFileRecentOutputFile1 = new JMenuItem("", KeyEvent.VK_5)
	File - recent output file 1 menu item. More...

JMenuItem	m_jMenuFileRecentOutputFile2 = new JMenuItem("", KeyEvent.VK_6)
	File - recent output file 2 menu item. More...

JMenuItem	m_jMenuFileRecentOutputFile3 = new JMenuItem("", KeyEvent.VK_7)
	File - recent output file 3 menu item. More...

JMenuItem	m_jMenuFileRecentOutputFile4 = new JMenuItem("", KeyEvent.VK_8)
	File - recent output file 4 menu item. More...

JMenuItem	m_jMenuFileExit = new JMenuItem("Exit", KeyEvent.VK_X)
	File - exit menu item. More...

JMenu	m_jMenuEditTree = new JMenu("Tree Population")
	Edit - tree setup submenu. More...

JMenuItem	m_jMenuEditGrid
	Edit - grid setup menu item. More...

JMenuItem	m_jMenuEditFlow
	Edit - model flow menu item. More...

JMenuItem	m_jMenuEditParameters
	Edit - parameters menu item. More...

JMenuItem	m_jMenuEditOutput
	Edit - output options menu item. More...

JMenuItem	m_jMenuTreeSpecies
	Tree submenu item - edit species list. More...

JMenuItem	m_jMenuTreeSizeClasses
	Tree submenu item - edit initial density size classes. More...

JMenuItem	m_jMenuTreeTreeMaps
	Tree submenu item - manage tree maps. More...

JMenuItem	m_jMenuModelRun = new JMenuItem("Run", KeyEvent.VK_R)
	Model - Run menu item. More...

JMenuItem	m_jMenuModelRunBatch = new JMenuItem("Run Batch...")
	Model - Run batch menu item. More...

JMenuItem	m_jMenuModelPause = new JMenuItem("Pause", KeyEvent.VK_P)
	Model - Pause menu item. More...

JMenuItem	m_jMenuModelStop
	Model - Stop menu item. More...

JMenuItem	m_jMenuHelpContents
	Help - contents menu item. More...

JMenuItem	m_jMenuToolsRename
	Help - about menu item. More...

JMenuItem	m_jMenuToolsBatchOut
	Tools - batch detailed output data extraction. More...

GUIManager	m_oDataManager
	Manager controlling all functions related to creating and editing parameter files and running the model. More...

DataVisualizerManager	m_oDataVisualizerManager
	Manager controlling all functions related to output data visualization. More...

HelpSet	m_oHelpSet
	The HelpSet object for the help file - class is from JavaHelp. More...

SORTIEComboBox< String >	m_jFileChoicesComboBox = new SORTIEComboBox<String>()
	Holds the list of currently open output files. More...

SORTIEComboBox< ChartFrameInfo >	m_jWindowsComboBox = new SORTIEComboBox<ChartFrameInfo>()
	Holds the list of currently open display windows. More...

JTextField	m_jParameterFileField = new JTextField()
	Field in the status bar holding the parameter file. More...

JTextField	m_jModelStatusField = new JTextField()
	Field holding the model status. More...

JTextField	m_jMessagesField = new JTextField()
	Field holding model messages. More...

JButton	m_jModelRunButton
	Button for running model. More...

JButton	m_jModelStopButton
	Button for stopping model. More...

JButton	m_jModelPauseButton
	Button for pausing model. More...

JButton	m_jModelStepForwardButton
	Button for stepping model. More...

JButton	m_jModelLoadOutputButton
	Button for loading run's output. More...

Private Member Functions
void	loadHelp () throws ModelException
	Loads the SORTIE help file so that it can be opened from buttons and menu commands. More...

void	resizeGUI ()
	Causes the GUI to resize in a smart way. More...

void	createMenu ()
	Creates the menu bar. More...

JMenu	makeFileMenu ()

void	createGUI ()
	Component initialization and GUI construction. More...

void	bringChartToFront (ChartFrameInfo oInfo) throws ModelException

void	doFileExit ()
	File \| Exit action performed. More...

void	doFileNew ()
	File \| New Parameter File action performed. More...

void	doFileSetWorkingDirectory ()
	File \| Set Working Directory action performed. More...

void	doFileBatchNew ()
	File \| New Batch File action performed. More...

void	doToolsRename ()
	Tools \| Rename detailed output file action performed. More...

void	doToolsBatchOut ()
	Tools \| Batch extract detailed output file action performed. More...

void	doViewRunOutput () throws ModelException
	Responds to the click of the button for viewing the current run's output. More...

void	doFileOpenRecentFile (String sCommandString)
	File \| recent file action performed. More...

void	doFileOpen ()
	File \| Open Parameter File action performed. More...

void	openFile (String sFileName, String sTarName)
	Opens a parameter file. More...

void	doModelRunBatch ()
	Model \| Run Batch action performed. More...

void	doFileOpenData () throws ModelException
	Opens an output file. More...

void	doFileOpenRecentData (String sCommandString) throws ModelException
	Opens an output file. More...

void	doEditModelFlow ()
	Edit \| Edit model flow action performed. More...

void	doEditParameters ()
	Edit \| Run parameters data action performed. More...

void	doEditOutput ()
	Edit \| Edit output options action performed. More...

void	doModelPause (boolean bAlert) throws ModelException
	Model \| Pause action performed. More...

void	doModelStop () throws ModelException
	Model \| Stop Run action performed. More...

void	doModelRun (int iNumStepsToRun)
	Model \| Run action performed. More...

void	doEditTreeSpecies ()
	Displays the tree species editing window. More...

void	doEditTreeDensityClasses ()
	Displays the tree initial density classes window. More...

void	doEditTreeManageTreeMap () throws ModelException
	Displays the tree map management window. More...

void	doEditGrid ()
	Displays the Grid editing window. More...

Private Attributes
Interface	m_oInterface = null
	Object managing the interface between this application and the C++ model core. More...

Timer	m_oTimer
	Object that allows us to update the GUI while the core model is running. More...

JPopupMenu	m_jLineGraphChoices
	Menu with the line graph choices for the current output file. More...

JButton	m_jLineGraphMenuButton
	Button which opens the line graph choices menu. More...

JPopupMenu	m_jHistogramChoices
	Menu with the histogram choices for the current output file. More...

JButton	m_jHistogramMenuButton
	Button which opens the histogram choices menu. More...

JPopupMenu	m_jTableChoices
	Menu with the table choices for the current output file. More...

JButton	m_jTableMenuButton
	Button which opens the table choices menu. More...

JPopupMenu	m_jMapChoices
	Menu with the map choices for the current output file. More...

JButton	m_jMapMenuButton
	Button which opens the map choices menu. More...

JPopupMenu	m_jRecentChoices
	Menu with the recent chart choices. More...

JButton	m_jRecentMenuButton
	Button which opens the recent choices menu. More...

int	m_iState
	File loaded, no file loaded, running, etc. More...

JDesktopPane	m_oDesktop
	Desktop pane - allows the use of JInternalFrames. More...

JScrollPane	m_jScroller
	Scroll pane for the desktop. More...

boolean	m_bViewingRunOutput = false
	Flag for whether or not the user is doing real-time data visualization of the current run. More...

boolean	m_bKeepRunning = false
	Flag for whether, during real-time data visualization, a new run timestep should be triggered after data updates. More...

int	m_iPanelHeight = -1
	The height of the data visualizer panel when the window is constructed. More...

Detailed Description

Main application window.

The main application window has two main functions; creating and editing parameter files for running the model, and viewing the output generated. To run these functions, it has a separate manager object for each. The rest of the components in this window are for GUI display.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Cary Institute of Ecosystem Studies

Author: Lora E. Murphy

Version: 1.1

Todo:: Window icon

Edit history:
---------------—
December 8, 2011: Wiped the slate clean for version 7 (LEM)
November 19, 2012: Changed the window closing event method because the old method stopped working (LEM)

Constructor & Destructor Documentation

◆ MainWindow()

sortie.gui.MainWindow.MainWindow ( )

Constructor.

Draws the window.

Member Function Documentation

◆ actionPerformed()

void sortie.gui.MainWindow.actionPerformed ( ActionEvent oEvent )

Manages window events.

Parameters

oEvent Event triggered.

◆ bringChartToFront()

void sortie.gui.MainWindow.bringChartToFront ( ChartFrameInfo oInfo ) throws ModelException

private

◆ closeOneDataFile()

void sortie.gui.MainWindow.closeOneDataFile ( String sFileName )

Closes a single output file and manages the file list.

Parameters

sFileName String File to close.

◆ createGUI()

void sortie.gui.MainWindow.createGUI ( )

private

Component initialization and GUI construction.

◆ createMenu()

void sortie.gui.MainWindow.createMenu ( )

private

Creates the menu bar.

◆ doEditGrid()

void sortie.gui.MainWindow.doEditGrid ( )

private

Displays the Grid editing window.

◆ doEditModelFlow()

void sortie.gui.MainWindow.doEditModelFlow ( )

private

Edit | Edit model flow action performed.

◆ doEditOutput()

void sortie.gui.MainWindow.doEditOutput ( )

private

Edit | Edit output options action performed.

◆ doEditParameters()

void sortie.gui.MainWindow.doEditParameters ( )

private

Edit | Run parameters data action performed.

◆ doEditTreeDensityClasses()

void sortie.gui.MainWindow.doEditTreeDensityClasses ( )

private

Displays the tree initial density classes window.

◆ doEditTreeManageTreeMap()

void sortie.gui.MainWindow.doEditTreeManageTreeMap ( ) throws ModelException

private

Displays the tree map management window.

◆ doEditTreeSpecies()

void sortie.gui.MainWindow.doEditTreeSpecies ( )

private

Displays the tree species editing window.

◆ doFileBatchNew()

void sortie.gui.MainWindow.doFileBatchNew ( )

private

File | New Batch File action performed.

◆ doFileCloseData()

void sortie.gui.MainWindow.doFileCloseData ( )

protected

Opens an output file.

Any file that was chosen by the user gets passed to the Data Visualization Manager for processing.

Exceptions

ModelException if anything goes wrong with the data visualization. Closes an open output file. All open windows related to this file are closed as well.

◆ doFileExit()

void sortie.gui.MainWindow.doFileExit ( )

private

File | Exit action performed.

This prompts a save if the user has changed the parameter file, and causes the data visualizer manager to perform cleanup operations.

◆ doFileNew()

void sortie.gui.MainWindow.doFileNew ( )

private

File | New Parameter File action performed.

◆ doFileOpen()

void sortie.gui.MainWindow.doFileOpen ( )

private

File | Open Parameter File action performed.

Allows the user to input a parameter file of either the old or new type. Any selected file is passed to the GUI manager for processing. File | Open Parameter File action performed. Allows the user to input a parameter file of either the old or new type. Any selected file is passed to the GUI manager for processing.

◆ doFileOpenData()

void sortie.gui.MainWindow.doFileOpenData ( ) throws ModelException

private

Opens an output file.

Any file that was chosen by the user gets passed to the Data Visualization Manager for processing.

Exceptions

ModelException if anything goes wrong with the data visualization.

◆ doFileOpenRecentData()

void sortie.gui.MainWindow.doFileOpenRecentData ( String sCommandString ) throws ModelException

private

Opens an output file.

Any file that was chosen by the user gets passed to the Data Visualization Manager for processing.

Exceptions

ModelException if anything goes wrong with the data visualization.

◆ doFileOpenRecentFile()

void sortie.gui.MainWindow.doFileOpenRecentFile ( String sCommandString )

private

File | recent file action performed.

Parameters

sCommandString Command string from action performed. This will let us know which file was chosen.

◆ doFileSave()

void sortie.gui.MainWindow.doFileSave ( )

protected

File | Save Parameter File action performed.

This is a request to save a parameter file. The request is passed to the GUI manager for processing.

◆ doFileSetWorkingDirectory()

void sortie.gui.MainWindow.doFileSetWorkingDirectory ( )

private

File | Set Working Directory action performed.

◆ doFileTextSave()

void sortie.gui.MainWindow.doFileTextSave ( )

protected

File | Save Parameter File as text action performed.

This is a request to save a parameter file. The request is passed to the GUI manager for processing.

◆ doModelPause()

void sortie.gui.MainWindow.doModelPause ( boolean bAlert ) throws ModelException

private

Model | Pause action performed.

Pauses the model.

Exceptions

ModelException passing through from called methods.

Parameters

bAlert Whether or not to alert the user to the pause.

◆ doModelRun()

void sortie.gui.MainWindow.doModelRun ( int iNumStepsToRun )

private

Model | Run action performed.

This runs the model. The request is passed off to the Interface, which handles the communications with the C++ core.

If there is an existing Interface object whose run has been paused, then this will pass it the run command and let it continue. If the model is already running, this does nothing.

Parameters

iNumStepsToRun Number of timesteps to run the model. Set to 0 if the model should run without interruption.

◆ doModelRunBatch()

void sortie.gui.MainWindow.doModelRunBatch ( )

private

Model | Run Batch action performed.

Allows the user to input a batch file and run it.

◆ doModelStop()

void sortie.gui.MainWindow.doModelStop ( ) throws ModelException

private

Model | Stop Run action performed.

Stops the currently executing run.

Exceptions

ModelException passed through from called functions.

◆ doToolsBatchOut()

void sortie.gui.MainWindow.doToolsBatchOut ( )

private

Tools | Batch extract detailed output file action performed.

◆ doToolsRename()

void sortie.gui.MainWindow.doToolsRename ( )

private

Tools | Rename detailed output file action performed.

◆ doViewRunOutput()

void sortie.gui.MainWindow.doViewRunOutput ( ) throws ModelException

private

Responds to the click of the button for viewing the current run's output.

If there is no parameter file loaded, this tells the user that it can't do the requested operation. If there's no output to load, this tells the user that. Otherwise, this will load all currently created output files for the current run.

Exceptions

ModelException if there is a problem opening the output.

◆ getDataManager()

GUIManager sortie.gui.MainWindow.getDataManager ( )

Gets the GUI manager.

Returns: The GUI manager.

◆ getModelState()

int sortie.gui.MainWindow.getModelState ( )

Gets the current window state.

Returns: int Current state. This matches one of the choices in MainWindowStateSetter.

◆ internalFrameActivated()

void sortie.gui.MainWindow.internalFrameActivated ( InternalFrameEvent e )

When a chart window is activated, this also brings its legend to the top.

Parameters

e	InternalFrameEvent

◆ internalFrameClosed()

void sortie.gui.MainWindow.internalFrameClosed ( InternalFrameEvent e )

Handles the closing of chart windows.

When a chart window is closed, this removes it from the list of open windows.

Parameters

e	InternalFrameEvent

◆ internalFrameClosing()

void sortie.gui.MainWindow.internalFrameClosing ( InternalFrameEvent e )

◆ internalFrameDeactivated()

void sortie.gui.MainWindow.internalFrameDeactivated ( InternalFrameEvent e )

◆ internalFrameDeiconified()

void sortie.gui.MainWindow.internalFrameDeiconified ( InternalFrameEvent e )

◆ internalFrameIconified()

void sortie.gui.MainWindow.internalFrameIconified ( InternalFrameEvent e )

◆ internalFrameOpened()

void sortie.gui.MainWindow.internalFrameOpened ( InternalFrameEvent e )

◆ loadHelp()

void sortie.gui.MainWindow.loadHelp ( ) throws ModelException

private

Loads the SORTIE help file so that it can be opened from buttons and menu commands.

Exceptions

ModelException if the help is not found.

◆ makeFileMenu()

JMenu sortie.gui.MainWindow.makeFileMenu ( )

private

◆ openFile()

void sortie.gui.MainWindow.openFile	(	String	sFileName,
		String	sTarName
	)

private

Opens a parameter file.

This makes sure state setting, recent files, etc. are updated.

◆ resizeGUI()

void sortie.gui.MainWindow.resizeGUI ( )

private

Causes the GUI to resize in a smart way.

◆ sendMessage()

void sortie.gui.MainWindow.sendMessage ( ModelMessage oMsg )

SendMessage accepts a message from the interface.

Parameters

oMsg	Message to accept.

◆ setCursorToDefault()

void sortie.gui.MainWindow.setCursorToDefault ( )

protected

Changes the cursor to the default.

This is a separate function so it can be called from the private inner class created in doModelRun().

◆ setModelState()

void sortie.gui.MainWindow.setModelState ( int iState )

Sets the current window state.

Parameters

iState State to set to. Should be one of the choices in MainWindowStateSetter.

◆ updateChartChoices()

void sortie.gui.MainWindow.updateChartChoices ( )

Updates the chart choices in the data visualization panel according to the file which is selected in the file list.

◆ windowActivated()

void sortie.gui.MainWindow.windowActivated ( WindowEvent e )

Not implemented.

◆ windowClosed()

void sortie.gui.MainWindow.windowClosed ( WindowEvent e )

Not implemented.

◆ windowClosing()

void sortie.gui.MainWindow.windowClosing ( WindowEvent e )

Ensures the application closes when this window closes.

◆ windowDeactivated()

void sortie.gui.MainWindow.windowDeactivated ( WindowEvent e )

Not implemented.

◆ windowDeiconified()

void sortie.gui.MainWindow.windowDeiconified ( WindowEvent e )

Not implemented.

◆ windowIconified()

void sortie.gui.MainWindow.windowIconified ( WindowEvent e )

Not implemented.

◆ windowOpened()

void sortie.gui.MainWindow.windowOpened ( WindowEvent e )

Not implemented.

Member Data Documentation

◆ m_bKeepRunning

boolean sortie.gui.MainWindow.m_bKeepRunning = false

private

Flag for whether, during real-time data visualization, a new run timestep should be triggered after data updates.

If the user has run the model instead of pausing it or stepping forward one timestep, this is set to true. Otherwise, it is false and no new timestep will be triggered after the charts have been refreshed.

◆ m_bViewingRunOutput

boolean sortie.gui.MainWindow.m_bViewingRunOutput = false

private

Flag for whether or not the user is doing real-time data visualization of the current run.

◆ m_iPanelHeight

int sortie.gui.MainWindow.m_iPanelHeight = -1

private

The height of the data visualizer panel when the window is constructed.

This will allow us to resize it if the user changes the size of the window. This is to avoid losing items off the screen.

◆ m_iState

int sortie.gui.MainWindow.m_iState

private

File loaded, no file loaded, running, etc.

◆ m_jFileChoicesComboBox

SORTIEComboBox<String> sortie.gui.MainWindow.m_jFileChoicesComboBox = new SORTIEComboBox<String>()

protected

Holds the list of currently open output files.

◆ m_jHistogramChoices

JPopupMenu sortie.gui.MainWindow.m_jHistogramChoices

private

Menu with the histogram choices for the current output file.

◆ m_jHistogramMenuButton

JButton sortie.gui.MainWindow.m_jHistogramMenuButton

private

Button which opens the histogram choices menu.

◆ m_jLineGraphChoices

JPopupMenu sortie.gui.MainWindow.m_jLineGraphChoices

private

Menu with the line graph choices for the current output file.

◆ m_jLineGraphMenuButton

JButton sortie.gui.MainWindow.m_jLineGraphMenuButton

private

Button which opens the line graph choices menu.

◆ m_jMapChoices

JPopupMenu sortie.gui.MainWindow.m_jMapChoices

private

Menu with the map choices for the current output file.

◆ m_jMapMenuButton

JButton sortie.gui.MainWindow.m_jMapMenuButton

private

Button which opens the map choices menu.

◆ m_jMenuEditFlow

JMenuItem sortie.gui.MainWindow.m_jMenuEditFlow

protected

Initial value:

= new JMenuItem("Model flow",

KeyEvent.VK_M)

Edit - model flow menu item.

◆ m_jMenuEditGrid

JMenuItem sortie.gui.MainWindow.m_jMenuEditGrid

protected

Initial value:

= new JMenuItem("Grid layer setup",

KeyEvent.VK_G)

Edit - grid setup menu item.

◆ m_jMenuEditOutput

JMenuItem sortie.gui.MainWindow.m_jMenuEditOutput

protected

Initial value:

= new JMenuItem("Output options",

KeyEvent.VK_O)

Edit - output options menu item.

◆ m_jMenuEditParameters

JMenuItem sortie.gui.MainWindow.m_jMenuEditParameters

protected

Initial value:

= new JMenuItem("Model Settings",

KeyEvent.VK_B)

Edit - parameters menu item.

◆ m_jMenuEditTree

JMenu sortie.gui.MainWindow.m_jMenuEditTree = new JMenu("Tree Population")

protected

Edit - tree setup submenu.

◆ m_jMenuFileBatchNew

JMenuItem sortie.gui.MainWindow.m_jMenuFileBatchNew

protected

Initial value:

= new JMenuItem("New batch file",

KeyEvent.VK_B)

File - new batch file menu item.

◆ m_jMenuFileCloseData

JMenuItem sortie.gui.MainWindow.m_jMenuFileCloseData

protected

Initial value:

= new JMenuItem(

"Close output file", KeyEvent.VK_C)

File - close output file menu item.

◆ m_jMenuFileExit

JMenuItem sortie.gui.MainWindow.m_jMenuFileExit = new JMenuItem("Exit", KeyEvent.VK_X)

protected

File - exit menu item.

◆ m_jMenuFileNew

JMenuItem sortie.gui.MainWindow.m_jMenuFileNew

protected

Initial value:

= new JMenuItem("New parameter file",

KeyEvent.VK_N)

File - new menu item.

◆ m_jMenuFileOpen

JMenuItem sortie.gui.MainWindow.m_jMenuFileOpen

protected

Initial value:

= new JMenuItem("Open file",

KeyEvent.VK_O)

File - open file menu item.

◆ m_jMenuFileOpenData

JMenuItem sortie.gui.MainWindow.m_jMenuFileOpenData

protected

Initial value:

= new JMenuItem("Open output file",

KeyEvent.VK_R)

File - open output file menu item.

◆ m_jMenuFileRecentFile1

JMenuItem sortie.gui.MainWindow.m_jMenuFileRecentFile1 = new JMenuItem("", KeyEvent.VK_1)

protected

File - recent file 1 menu item.

◆ m_jMenuFileRecentFile2

JMenuItem sortie.gui.MainWindow.m_jMenuFileRecentFile2 = new JMenuItem("", KeyEvent.VK_2)

protected

File - recent file 2 menu item.

◆ m_jMenuFileRecentFile3

JMenuItem sortie.gui.MainWindow.m_jMenuFileRecentFile3 = new JMenuItem("", KeyEvent.VK_3)

protected

File - recent file 3 menu item.

◆ m_jMenuFileRecentFile4

JMenuItem sortie.gui.MainWindow.m_jMenuFileRecentFile4 = new JMenuItem("", KeyEvent.VK_4)

protected

File - recent file 4 menu item.

◆ m_jMenuFileRecentOutputFile1

JMenuItem sortie.gui.MainWindow.m_jMenuFileRecentOutputFile1 = new JMenuItem("", KeyEvent.VK_5)

protected

File - recent output file 1 menu item.

◆ m_jMenuFileRecentOutputFile2

JMenuItem sortie.gui.MainWindow.m_jMenuFileRecentOutputFile2 = new JMenuItem("", KeyEvent.VK_6)

protected

File - recent output file 2 menu item.

◆ m_jMenuFileRecentOutputFile3

JMenuItem sortie.gui.MainWindow.m_jMenuFileRecentOutputFile3 = new JMenuItem("", KeyEvent.VK_7)

protected

File - recent output file 3 menu item.

◆ m_jMenuFileRecentOutputFile4

JMenuItem sortie.gui.MainWindow.m_jMenuFileRecentOutputFile4 = new JMenuItem("", KeyEvent.VK_8)

protected

File - recent output file 4 menu item.

◆ m_jMenuFileSave

JMenuItem sortie.gui.MainWindow.m_jMenuFileSave

protected

Initial value:

= new JMenuItem("Save parameter file",

KeyEvent.VK_S)

File - file save menu item.

◆ m_jMenuFileSetDir

JMenuItem sortie.gui.MainWindow.m_jMenuFileSetDir

protected

Initial value:

= new JMenuItem(

"Set working directory", KeyEvent.VK_D)

File - set working directory menu item.

◆ m_jMenuHelpContents

JMenuItem sortie.gui.MainWindow.m_jMenuHelpContents

protected

Initial value:

= new JMenuItem("Contents",

KeyEvent.VK_C)

Help - contents menu item.

◆ m_jMenuModelPause

JMenuItem sortie.gui.MainWindow.m_jMenuModelPause = new JMenuItem("Pause", KeyEvent.VK_P)

protected

Model - Pause menu item.

◆ m_jMenuModelRun

JMenuItem sortie.gui.MainWindow.m_jMenuModelRun = new JMenuItem("Run", KeyEvent.VK_R)

protected

Model - Run menu item.

◆ m_jMenuModelRunBatch

JMenuItem sortie.gui.MainWindow.m_jMenuModelRunBatch = new JMenuItem("Run Batch...")

protected

Model - Run batch menu item.

◆ m_jMenuModelStop

JMenuItem sortie.gui.MainWindow.m_jMenuModelStop

protected

Initial value:

= new JMenuItem("Stop run",

KeyEvent.VK_S)

Model - Stop menu item.

◆ m_jMenuTextFileSave

JMenuItem sortie.gui.MainWindow.m_jMenuTextFileSave

protected

Initial value:

= new JMenuItem("Save parameter file as text",

KeyEvent.VK_T)

File - text file save menu item.

◆ m_jMenuToolsBatchOut

JMenuItem sortie.gui.MainWindow.m_jMenuToolsBatchOut

protected

Initial value:

= new JMenuItem(

"Batch Extract Detailed Output Files", KeyEvent.VK_B)

Tools - batch detailed output data extraction.

◆ m_jMenuToolsRename

JMenuItem sortie.gui.MainWindow.m_jMenuToolsRename

protected

Initial value:

= new JMenuItem(

"Copy Detailed Output File", KeyEvent.VK_C)

Help - about menu item.

Tools - rename detailed output file menu item

◆ m_jMenuTreeSizeClasses

JMenuItem sortie.gui.MainWindow.m_jMenuTreeSizeClasses

protected

Initial value:

=

new JMenuItem("Edit initial density size classes", KeyEvent.VK_I)

Tree submenu item - edit initial density size classes.

◆ m_jMenuTreeSpecies

JMenuItem sortie.gui.MainWindow.m_jMenuTreeSpecies

protected

Initial value:

=

new JMenuItem("Edit species list", KeyEvent.VK_S)

Tree submenu item - edit species list.

◆ m_jMenuTreeTreeMaps

JMenuItem sortie.gui.MainWindow.m_jMenuTreeTreeMaps

protected

Initial value:

= new JMenuItem("Manage tree maps",

KeyEvent.VK_M)

Tree submenu item - manage tree maps.

◆ m_jMessagesField

JTextField sortie.gui.MainWindow.m_jMessagesField = new JTextField()

protected

Field holding model messages.

◆ m_jModelLoadOutputButton

JButton sortie.gui.MainWindow.m_jModelLoadOutputButton

protected

Initial value:

= new JButton(

"View this run's output")

Button for loading run's output.

◆ m_jModelPauseButton

JButton sortie.gui.MainWindow.m_jModelPauseButton

protected

Initial value:

= new JButton(new ModelIcon(15, 15,

ModelIcon.PAUSE))

Button for pausing model.

◆ m_jModelRunButton

JButton sortie.gui.MainWindow.m_jModelRunButton

protected

Initial value:

= new JButton(new ModelIcon(15, 15,

ModelIcon.RIGHT_TRIANGLE))

Button for running model.

◆ m_jModelStatusField

JTextField sortie.gui.MainWindow.m_jModelStatusField = new JTextField()

protected

Field holding the model status.

◆ m_jModelStepForwardButton

JButton sortie.gui.MainWindow.m_jModelStepForwardButton

protected

Initial value:

= new JButton(new ModelIcon(15,
      15,
      ModelIcon.STEP_FORWARD))

Button for stepping model.

◆ m_jModelStopButton

JButton sortie.gui.MainWindow.m_jModelStopButton

protected

Initial value:

= new JButton(new ModelIcon(15, 15,

ModelIcon.RECTANGLE))

Button for stopping model.

◆ m_jParameterFileField

JTextField sortie.gui.MainWindow.m_jParameterFileField = new JTextField()

protected

Field in the status bar holding the parameter file.

◆ m_jRecentChoices

JPopupMenu sortie.gui.MainWindow.m_jRecentChoices

private

Menu with the recent chart choices.

◆ m_jRecentMenuButton

JButton sortie.gui.MainWindow.m_jRecentMenuButton

private

Button which opens the recent choices menu.

◆ m_jScroller

JScrollPane sortie.gui.MainWindow.m_jScroller

private

Scroll pane for the desktop.

◆ m_jTableChoices

JPopupMenu sortie.gui.MainWindow.m_jTableChoices

private

Menu with the table choices for the current output file.

◆ m_jTableMenuButton

JButton sortie.gui.MainWindow.m_jTableMenuButton

private

Button which opens the table choices menu.

◆ m_jWindowsComboBox

SORTIEComboBox<ChartFrameInfo> sortie.gui.MainWindow.m_jWindowsComboBox = new SORTIEComboBox<ChartFrameInfo>()

protected

Holds the list of currently open display windows.

◆ m_oDataManager

GUIManager sortie.gui.MainWindow.m_oDataManager

protected

Manager controlling all functions related to creating and editing parameter files and running the model.

◆ m_oDataVisualizerManager

DataVisualizerManager sortie.gui.MainWindow.m_oDataVisualizerManager

protected

Manager controlling all functions related to output data visualization.

◆ m_oDesktop

JDesktopPane sortie.gui.MainWindow.m_oDesktop

private

Desktop pane - allows the use of JInternalFrames.

◆ m_oHelpBroker

HelpBroker sortie.gui.MainWindow.m_oHelpBroker

JavaHelp class for managing help displays.

◆ m_oHelpSet

HelpSet sortie.gui.MainWindow.m_oHelpSet

protected

The HelpSet object for the help file - class is from JavaHelp.

◆ m_oInterface

Interface sortie.gui.MainWindow.m_oInterface = null

private

Object managing the interface between this application and the C++ model core.

◆ m_oTimer

Timer sortie.gui.MainWindow.m_oTimer

private

Object that allows us to update the GUI while the core model is running.

The documentation for this class was generated from the following file:

MainWindow.java

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MainWindow()

Member Function Documentation

◆ actionPerformed()

◆ bringChartToFront()

◆ closeOneDataFile()

◆ createGUI()

◆ createMenu()

◆ doEditGrid()

◆ doEditModelFlow()

◆ doEditOutput()

◆ doEditParameters()

◆ doEditTreeDensityClasses()

◆ doEditTreeManageTreeMap()

◆ doEditTreeSpecies()

◆ doFileBatchNew()

◆ doFileCloseData()

◆ doFileExit()

◆ doFileNew()

◆ doFileOpen()

◆ doFileOpenData()

◆ doFileOpenRecentData()

◆ doFileOpenRecentFile()

◆ doFileSave()

◆ doFileSetWorkingDirectory()

◆ doFileTextSave()

◆ doModelPause()

◆ doModelRun()

◆ doModelRunBatch()

◆ doModelStop()

◆ doToolsBatchOut()

◆ doToolsRename()

◆ doViewRunOutput()

◆ getDataManager()

◆ getModelState()

◆ internalFrameActivated()

◆ internalFrameClosed()

◆ internalFrameClosing()

◆ internalFrameDeactivated()

◆ internalFrameDeiconified()

◆ internalFrameIconified()

◆ internalFrameOpened()

◆ loadHelp()

◆ makeFileMenu()

◆ openFile()

◆ resizeGUI()

◆ sendMessage()

◆ setCursorToDefault()

◆ setModelState()

◆ updateChartChoices()

◆ windowActivated()

◆ windowClosed()

◆ windowClosing()

◆ windowDeactivated()

◆ windowDeiconified()

◆ windowIconified()

◆ windowOpened()

Member Data Documentation

◆ m_bKeepRunning

◆ m_bViewingRunOutput

◆ m_iPanelHeight

◆ m_iState

◆ m_jFileChoicesComboBox

◆ m_jHistogramChoices

◆ m_jHistogramMenuButton

◆ m_jLineGraphChoices

◆ m_jLineGraphMenuButton

◆ m_jMapChoices

◆ m_jMapMenuButton

◆ m_jMenuEditFlow

◆ m_jMenuEditGrid

◆ m_jMenuEditOutput