SORTIE Java Interface  1
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
sortie.gui.DetailedOutputGridSetup Class Reference

Window the user uses to set up detailed output options for grids. More...

Inheritance diagram for sortie.gui.DetailedOutputGridSetup:

Public Member Functions

 DetailedOutputGridSetup (JDialog oParent, DetailedOutput oOutput) throws ModelException
 Constructor.
 
void saveAll ()
 Causes all possible grids and grid members to be saved for the run.
 
void actionPerformed (ActionEvent oEvent)
 Responds to button clicks.
 

Public Attributes

SORTIEComboBox< String > m_jGridListCombo = new SORTIEComboBox<String>()
 Combo box for displaying grid list.
 
JButton m_jAddButton = new JButton()
 Add button.
 
DefaultListModel< String > m_jDataMemberListModel = new DefaultListModel<String>()
 List for data members.
 
JList< String > m_jDataMemberList = new JList<String>(m_jDataMemberListModel)
 List for data members.
 
JTextField m_jTimestepsEdit = new JTextField()
 For getting the timestep saving interval.
 

Protected Member Functions

void doRemove ()
 Removes the data members for a grid from the list of settings.
 
void doAdd ()
 Adds the data members for a grid to the list of settings.
 
void loadSettings ()
 Creates the window.
 
void updateSaves ()
 Displays what's being saved in each save list based on what's in mp_oDetailedTreeSaveSettings.
 

Protected Attributes

DetailedOutput m_oOutput
 OutputBehaviors object to exchange data with.
 
Vector< DetailedGridSettingsmp_oDetailedGridSaveSettings = new Vector<DetailedGridSettings>(0)
 For detailed output - collection of DetailedGridSettings objects representing the temp settings that changes will be made to.
 
Grid[] mp_oGridList
 List of grids to display.
 

Private Member Functions

void createGUI ()
 Creates the window.
 

Private Attributes

JList< String > m_jSaveList = new JList<String>(m_jSaveListModel)
 List for saving changes.
 
String m_sHelpID = "windows.detailed_output_grid_setup"
 Help ID string.
 

Detailed Description

Window the user uses to set up detailed output options for grids.

A combo box displays a list of all grids set up by BehaviorTypeBase-descended objects. When the user chooses one of these grids, a list of all its data members and package data members appears so the user can choose what to save.

We have to have a way to tell the regular data members from the package data members. They are all displayed together, not in separate boxes; so we append a "(p)" flag to the beginning of package data member display names. A custom renderer splits it back off for display so the user doesn't see it; and it will also be split off before notifying the DetailedGridSettings object that it's been picked.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Cary Institute of Ecosystem Studies

Author
Lora E. Murphy
Version
1.0


Edit history:
---------------—
December 8, 2011: Wiped the slate clean for version 7 (LEM)

Constructor & Destructor Documentation

sortie.gui.DetailedOutputGridSetup.DetailedOutputGridSetup ( JDialog  oParent,
DetailedOutput  oOutput 
) throws ModelException

Constructor.

Builds the GUI.

Parameters
oParentParent dialog in which to display this dialog.
oOutputOutputBehaviors object, to draw data from to display and to send changes to
Exceptions
ModelExceptionpassed through from underlying methods

Member Function Documentation

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

Responds to button clicks.

Parameters
oEventThe event telling us what button was clicked.
void sortie.gui.DetailedOutputGridSetup.createGUI ( )
private

Creates the window.

void sortie.gui.DetailedOutputGridSetup.doAdd ( )
protected

Adds the data members for a grid to the list of settings.

void sortie.gui.DetailedOutputGridSetup.doRemove ( )
protected

Removes the data members for a grid from the list of settings.

void sortie.gui.DetailedOutputGridSetup.loadSettings ( )
protected

Creates the window.

Auto-generated except for tweaks by me.

Exceptions
java.lang.Exceptionif something goes wrong with the window building. Loads the settings from output into this form's temp array for display.
void sortie.gui.DetailedOutputGridSetup.saveAll ( )

Causes all possible grids and grid members to be saved for the run.

This can be called without the window's being visible. Its results are immediately applied to the output behavior - so this is not subject to a Cancel button.

Exceptions
ModelExceptionpassed through from called methods.
void sortie.gui.DetailedOutputGridSetup.updateSaves ( )
protected

Displays what's being saved in each save list based on what's in mp_oDetailedTreeSaveSettings.

Member Data Documentation

JButton sortie.gui.DetailedOutputGridSetup.m_jAddButton = new JButton()

Add button.

JList<String> sortie.gui.DetailedOutputGridSetup.m_jDataMemberList = new JList<String>(m_jDataMemberListModel)

List for data members.

DefaultListModel<String> sortie.gui.DetailedOutputGridSetup.m_jDataMemberListModel = new DefaultListModel<String>()

List for data members.

SORTIEComboBox<String> sortie.gui.DetailedOutputGridSetup.m_jGridListCombo = new SORTIEComboBox<String>()

Combo box for displaying grid list.

JList<String> sortie.gui.DetailedOutputGridSetup.m_jSaveList = new JList<String>(m_jSaveListModel)
private

List for saving changes.

JTextField sortie.gui.DetailedOutputGridSetup.m_jTimestepsEdit = new JTextField()

For getting the timestep saving interval.

DetailedOutput sortie.gui.DetailedOutputGridSetup.m_oOutput
protected

OutputBehaviors object to exchange data with.

String sortie.gui.DetailedOutputGridSetup.m_sHelpID = "windows.detailed_output_grid_setup"
private

Help ID string.

Vector<DetailedGridSettings> sortie.gui.DetailedOutputGridSetup.mp_oDetailedGridSaveSettings = new Vector<DetailedGridSettings>(0)
protected

For detailed output - collection of DetailedGridSettings objects representing the temp settings that changes will be made to.

Grid [] sortie.gui.DetailedOutputGridSetup.mp_oGridList
protected

List of grids to display.


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