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

Window used by the user to set up detailed output output options for dead trees. More...

Inheritance diagram for sortie.gui.DetailedOutputDeadTreeSetup:

Public Member Functions

 DetailedOutputDeadTreeSetup (JDialog oParent, DetailedOutput oOutput)
 Constructor.
 
void saveAll () throws ModelException
 Causes all possible tree data members to be saved for the run.
 
void actionPerformed (ActionEvent oEvent)
 Performs the actions of the window.
 

Private Member Functions

void collectTreeDataMembers (TreePopulation oPop) throws ModelException
 Collects together the tree data members that will be displayed.
 
void saveData () throws ModelException
 Saves the settings collected by this window to the OutputBehaviors object.
 
void loadSettings ()
 Loads the settings from output into this form's temp array for display.
 
void updateSaves ()
 Displays what's being saved in each save list based on what's in mp_oDetailedTreeSaveSettings.
 
void createGUI ()
 
JPanel createTreeTypePanel (int iType)
 Builds GUI.
 
void addButtonActionPerformed (int iType) throws ModelException
 Serves as the common function for adding settings entered when the user clicks an "Add" button.
 
void removeButtonActionPerformed (int iType)
 Serves as the common function for removing settings entered when the user clicks a "Remove" button.
 

Private Attributes

DetailedOutput m_oOutput
 For exchanging data with.
 
ArrayList< DetailedTreeSettingsmp_oDetailedTreeSaveSettings = new ArrayList<DetailedTreeSettings>(0)
 Temp collection of settings - vector of DetailedTreeSettings objects.
 
String m_sHelpID = "windows.detailed_output_tree_setup"
 The help ID for this window.
 
boolean[][] mp_bSeedlingDataMembersBySpecies
 For each seedling data member, whether it's used by a particular species.
 
boolean[][] mp_bSaplingDataMembersBySpecies
 For each sapling data member, whether it's used by a particular species.
 
boolean[][] mp_bAdultDataMembersBySpecies
 For each adult data member, whether it's used by a particular species.
 
boolean[][] mp_bSnagDataMembersBySpecies
 For each snag data member, whether it's used by a particular species.
 
boolean m_bIsSnagAware = false
 Whether or not this run is snag-aware and any snags should be saved.
 
JTextField m_jSeedlingTimestepsEdit = new JTextField()
 Edit box for entering how often to save.
 
JTextField m_jSaplingTimestepsEdit = new JTextField()
 Edit box for entering how often to save.
 
JTextField m_jAdultTimestepsEdit = new JTextField()
 Edit box for entering how often to save.
 
JTextField m_jSnagTimestepsEdit = new JTextField()
 Edit box for entering how often to save.
 
DefaultListModel< DataMemberm_jSeedlingDataMemberListModel
 List model for the seedling data member list.
 
DefaultListModel< DataMemberm_jSaplingDataMemberListModel = new DefaultListModel<DataMember>()
 List model for the sapling data member list.
 
DefaultListModel< DataMemberm_jAdultDataMemberListModel = new DefaultListModel<DataMember>()
 List model for the adult data member list.
 
DefaultListModel< DataMemberm_jSnagDataMemberListModel = new DefaultListModel<DataMember>()
 List model for the snag data member list.
 
DefaultListModel< String > m_jSpeciesListModel = new DefaultListModel<String>()
 List model for the species list.
 
DefaultListModel< String > m_jSeedlingSaveListModel = new DefaultListModel<String>()
 List model for the seedling saved data member list.
 
DefaultListModel< String > m_jSaplingSaveListModel = new DefaultListModel<String>()
 List model for the sapling saved data member list.
 
DefaultListModel< String > m_jAdultSaveListModel = new DefaultListModel<String>()
 List model for the adult saved data member list.
 
DefaultListModel< String > m_jSnagSaveListModel = new DefaultListModel<String>()
 List model for the snag saved data member list.
 
DefaultListModel< String > m_jDeadCodesListModel = new DefaultListModel<String>()
 List model for the dead reason codes list.
 
JList< DataMemberm_jSeedlingDataMemberList = new JList<DataMember>(m_jSeedlingDataMemberListModel)
 Seedling data member list.
 
JList< String > m_jSeedlingSpeciesList = new JList<String>(m_jSpeciesListModel)
 Seedling species list.
 
JList< String > m_jSeedlingSaveList = new JList<String>(m_jSeedlingSaveListModel)
 Seedling save list.
 
JList< String > m_jSaplingSpeciesList = new JList<String>(m_jSpeciesListModel)
 Sapling species list.
 
JList< String > m_jSaplingSaveList = new JList<String>(m_jSaplingSaveListModel)
 Sapling save list.
 
JList< DataMemberm_jSaplingDataMemberList = new JList<DataMember>(m_jSaplingDataMemberListModel)
 Sapling data member list.
 
JList< String > m_jAdultSpeciesList = new JList<String>(m_jSpeciesListModel)
 Adult species list.
 
JList< String > m_jAdultSaveList = new JList<String>(m_jAdultSaveListModel)
 Adult save list.
 
JList< DataMemberm_jAdultDataMemberList = new JList<DataMember>(m_jAdultDataMemberListModel)
 Adult data member list.
 
JList< String > m_jSnagSpeciesList = new JList<String>(m_jSpeciesListModel)
 Snag species list.
 
JList< String > m_jSnagSaveList = new JList<String>(m_jSnagSaveListModel)
 Snag save list.
 
JList< DataMemberm_jSnagDataMemberList = new JList<DataMember>(m_jSnagDataMemberListModel)
 Snag data member list.
 
JList< String > m_jSeedlingDeadCodeList = new JList<String>(m_jDeadCodesListModel)
 Seedling dead code list.
 
JList< String > m_jSaplingDeadCodeList = new JList<String>(m_jDeadCodesListModel)
 Sapling dead code list.
 
JList< String > m_jAdultDeadCodeList = new JList<String>(m_jDeadCodesListModel)
 Adult dead code list.
 
JList< String > m_jSnagDeadCodeList = new JList<String>(m_jDeadCodesListModel)
 Snag dead code list.
 

Detailed Description

Window used by the user to set up detailed output output options for dead trees.

Copyright: Copyright (c) Charles D. Canham 2011

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.DetailedOutputDeadTreeSetup.DetailedOutputDeadTreeSetup ( JDialog  oParent,
DetailedOutput  oOutput 
)

Constructor.

Parameters
oParentParent window in which to display this dialog.
oOutputDetailedOutput object.

Member Function Documentation

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

Performs the actions of the window.

Parameters
oEventActionEvent object.
void sortie.gui.DetailedOutputDeadTreeSetup.addButtonActionPerformed ( int  iType) throws ModelException
private

Serves as the common function for adding settings entered when the user clicks an "Add" button.

Parameters
iTypeThe tree type (TreePopulation.SEEDLING, TreePopulation.SAPLING, TreePopulation.ADULT, or TreePopulation.SNAG) that is firing the button.
Exceptions
ModelExceptionif the run is not snag-aware but someone is trying to save snag settings.
void sortie.gui.DetailedOutputDeadTreeSetup.collectTreeDataMembers ( TreePopulation  oPop) throws ModelException
private

Collects together the tree data members that will be displayed.

Parameters
oPopTree population object.
Exceptions
ModelExceptionpassed through from called functions. Should never be thrown.
void sortie.gui.DetailedOutputDeadTreeSetup.createGUI ( )
private
JPanel sortie.gui.DetailedOutputDeadTreeSetup.createTreeTypePanel ( int  iType)
private

Builds GUI.

Exceptions
java.lang.Exceptionif there's a problem.
void sortie.gui.DetailedOutputDeadTreeSetup.loadSettings ( )
private

Loads the settings from output into this form's temp array for display.

void sortie.gui.DetailedOutputDeadTreeSetup.removeButtonActionPerformed ( int  iType)
private

Serves as the common function for removing settings entered when the user clicks a "Remove" button.

Parameters
iTypeThe tree type (TreePopulation.SEEDLING, TreePopulation.SAPLING, TreePopulation.ADULT, or TreePopulation.SNAG) that is firing the button.
void sortie.gui.DetailedOutputDeadTreeSetup.saveAll ( ) throws ModelException

Causes all possible tree data 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.DetailedOutputDeadTreeSetup.saveData ( ) throws ModelException
private

Saves the settings collected by this window to the OutputBehaviors object.

Exceptions
ModelExceptionpassed through from called methods.
void sortie.gui.DetailedOutputDeadTreeSetup.updateSaves ( )
private

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

Member Data Documentation

boolean sortie.gui.DetailedOutputDeadTreeSetup.m_bIsSnagAware = false
private

Whether or not this run is snag-aware and any snags should be saved.

JList<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jAdultDataMemberList = new JList<DataMember>(m_jAdultDataMemberListModel)
private

Adult data member list.

DefaultListModel<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jAdultDataMemberListModel = new DefaultListModel<DataMember>()
private

List model for the adult data member list.

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jAdultDeadCodeList = new JList<String>(m_jDeadCodesListModel)
private

Adult dead code list.

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jAdultSaveList = new JList<String>(m_jAdultSaveListModel)
private

Adult save list.

DefaultListModel<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jAdultSaveListModel = new DefaultListModel<String>()
private

List model for the adult saved data member list.

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jAdultSpeciesList = new JList<String>(m_jSpeciesListModel)
private

Adult species list.

JTextField sortie.gui.DetailedOutputDeadTreeSetup.m_jAdultTimestepsEdit = new JTextField()
private

Edit box for entering how often to save.

DefaultListModel<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jDeadCodesListModel = new DefaultListModel<String>()
private

List model for the dead reason codes list.

JList<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jSaplingDataMemberList = new JList<DataMember>(m_jSaplingDataMemberListModel)
private

Sapling data member list.

DefaultListModel<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jSaplingDataMemberListModel = new DefaultListModel<DataMember>()
private

List model for the sapling data member list.

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSaplingDeadCodeList = new JList<String>(m_jDeadCodesListModel)
private

Sapling dead code list.

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSaplingSaveList = new JList<String>(m_jSaplingSaveListModel)
private

Sapling save list.

DefaultListModel<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSaplingSaveListModel = new DefaultListModel<String>()
private

List model for the sapling saved data member list.

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSaplingSpeciesList = new JList<String>(m_jSpeciesListModel)
private

Sapling species list.

JTextField sortie.gui.DetailedOutputDeadTreeSetup.m_jSaplingTimestepsEdit = new JTextField()
private

Edit box for entering how often to save.

JList<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jSeedlingDataMemberList = new JList<DataMember>(m_jSeedlingDataMemberListModel)
private

Seedling data member list.

DefaultListModel<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jSeedlingDataMemberListModel
private
Initial value:
= new
DefaultListModel<DataMember>()

List model for the seedling data member list.

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSeedlingDeadCodeList = new JList<String>(m_jDeadCodesListModel)
private

Seedling dead code list.

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSeedlingSaveList = new JList<String>(m_jSeedlingSaveListModel)
private

Seedling save list.

DefaultListModel<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSeedlingSaveListModel = new DefaultListModel<String>()
private

List model for the seedling saved data member list.

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSeedlingSpeciesList = new JList<String>(m_jSpeciesListModel)
private

Seedling species list.

JTextField sortie.gui.DetailedOutputDeadTreeSetup.m_jSeedlingTimestepsEdit = new JTextField()
private

Edit box for entering how often to save.

JList<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jSnagDataMemberList = new JList<DataMember>(m_jSnagDataMemberListModel)
private

Snag data member list.

DefaultListModel<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jSnagDataMemberListModel = new DefaultListModel<DataMember>()
private

List model for the snag data member list.

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSnagDeadCodeList = new JList<String>(m_jDeadCodesListModel)
private

Snag dead code list.

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSnagSaveList = new JList<String>(m_jSnagSaveListModel)
private

Snag save list.

DefaultListModel<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSnagSaveListModel = new DefaultListModel<String>()
private

List model for the snag saved data member list.

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSnagSpeciesList = new JList<String>(m_jSpeciesListModel)
private

Snag species list.

JTextField sortie.gui.DetailedOutputDeadTreeSetup.m_jSnagTimestepsEdit = new JTextField()
private

Edit box for entering how often to save.

DefaultListModel<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSpeciesListModel = new DefaultListModel<String>()
private

List model for the species list.

DetailedOutput sortie.gui.DetailedOutputDeadTreeSetup.m_oOutput
private

For exchanging data with.

String sortie.gui.DetailedOutputDeadTreeSetup.m_sHelpID = "windows.detailed_output_tree_setup"
private

The help ID for this window.

boolean [][] sortie.gui.DetailedOutputDeadTreeSetup.mp_bAdultDataMembersBySpecies
private

For each adult data member, whether it's used by a particular species.

Array is sized number of adult data members by number of species.

boolean [][] sortie.gui.DetailedOutputDeadTreeSetup.mp_bSaplingDataMembersBySpecies
private

For each sapling data member, whether it's used by a particular species.

Array is sized number of sapling data members by number of species.

boolean [][] sortie.gui.DetailedOutputDeadTreeSetup.mp_bSeedlingDataMembersBySpecies
private

For each seedling data member, whether it's used by a particular species.

Array is sized number of seedling data members by number of species.

boolean [][] sortie.gui.DetailedOutputDeadTreeSetup.mp_bSnagDataMembersBySpecies
private

For each snag data member, whether it's used by a particular species.

Array is sized number of snag data members by number of species.

ArrayList<DetailedTreeSettings> sortie.gui.DetailedOutputDeadTreeSetup.mp_oDetailedTreeSaveSettings = new ArrayList<DetailedTreeSettings>(0)
private

Temp collection of settings - vector of DetailedTreeSettings objects.


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