javawrapper.DetailedOutputDeadTreeSetup Class Reference

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

Inherits javax::swing::JDialog, and java::awt::event::ActionListener.

List of all members.

Public Member Functions

 DetailedOutputDeadTreeSetup (JDialog oParent, OutputBehaviors oOutputBehaviors)
 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

OutputBehaviors m_oOutputBehaviors
 For exchanging data with.
Vector< DetailedTreeSettingsmp_oDetailedTreeSaveSettings = new Vector<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 m_jSeedlingDataMemberListModel
 List model for the seedling data member list.
DefaultListModel m_jSaplingDataMemberListModel = new DefaultListModel()
 List model for the sapling data member list.
DefaultListModel m_jAdultDataMemberListModel = new DefaultListModel()
 List model for the adult data member list.
DefaultListModel m_jSnagDataMemberListModel = new DefaultListModel()
 List model for the snag data member list.
DefaultListModel m_jSpeciesListModel = new DefaultListModel()
 List model for the species list.
DefaultListModel m_jSeedlingSaveListModel = new DefaultListModel()
 List model for the seedling saved data member list.
DefaultListModel m_jSaplingSaveListModel = new DefaultListModel()
 List model for the sapling saved data member list.
DefaultListModel m_jAdultSaveListModel = new DefaultListModel()
 List model for the adult saved data member list.
DefaultListModel m_jSnagSaveListModel = new DefaultListModel()
 List model for the snag saved data member list.
DefaultListModel m_jDeadCodesListModel = new DefaultListModel()
 List model for the dead reason codes list.
JList m_jSeedlingDataMemberList = new JList(m_jSeedlingDataMemberListModel)
 Seedling data member list.
JList m_jSeedlingSpeciesList = new JList(m_jSpeciesListModel)
 Seedling species list.
JList m_jSeedlingSaveList = new JList(m_jSeedlingSaveListModel)
 Seedling save list.
JList m_jSaplingSpeciesList = new JList(m_jSpeciesListModel)
 Sapling species list.
JList m_jSaplingSaveList = new JList(m_jSaplingSaveListModel)
 Sapling save list.
JList m_jSaplingDataMemberList = new JList(m_jSaplingDataMemberListModel)
 Sapling data member list.
JList m_jAdultSpeciesList = new JList(m_jSpeciesListModel)
 Adult species list.
JList m_jAdultSaveList = new JList(m_jAdultSaveListModel)
 Adult save list.
JList m_jAdultDataMemberList = new JList(m_jAdultDataMemberListModel)
 Adult data member list.
JList m_jSnagSpeciesList = new JList(m_jSpeciesListModel)
 Snag species list.
JList m_jSnagSaveList = new JList(m_jSnagSaveListModel)
 Snag save list.
JList m_jSnagDataMemberList = new JList(m_jSnagDataMemberListModel)
 Snag data member list.
JList m_jSeedlingDeadCodeList = new JList(m_jDeadCodesListModel)
 Seedling dead code list.
JList m_jSaplingDeadCodeList = new JList(m_jDeadCodesListModel)
 Sapling dead code list.
JList m_jAdultDeadCodeList = new JList(m_jDeadCodesListModel)
 Adult dead code list.
JList m_jSnagDeadCodeList = new JList(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:
------------------
February 1, 2011: Created (LEM)

Constructor & Destructor Documentation

javawrapper.DetailedOutputDeadTreeSetup.DetailedOutputDeadTreeSetup ( JDialog  oParent,
OutputBehaviors  oOutputBehaviors 
)

Constructor.

Parameters:
oParent Parent window in which to display this dialog.
oOutputBehaviors OutputBehaviors object.


Member Function Documentation

void javawrapper.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:
ModelException passed through from called methods.

void javawrapper.DetailedOutputDeadTreeSetup.CollectTreeDataMembers ( TreePopulation  oPop  )  throws ModelException [private]

Collects together the tree data members that will be displayed.

Parameters:
oPop Tree population object.
Exceptions:
ModelException passed through from called functions. Should never be thrown.

void javawrapper.DetailedOutputDeadTreeSetup.SaveData (  )  throws ModelException [private]

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

Exceptions:
ModelException passed through from called methods.

void javawrapper.DetailedOutputDeadTreeSetup.actionPerformed ( ActionEvent  oEvent  ) 

Performs the actions of the window.

Parameters:
oEvent ActionEvent object.

void javawrapper.DetailedOutputDeadTreeSetup.LoadSettings (  )  [private]

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

void javawrapper.DetailedOutputDeadTreeSetup.UpdateSaves (  )  [private]

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

void javawrapper.DetailedOutputDeadTreeSetup.CreateGUI (  )  [private]

JPanel javawrapper.DetailedOutputDeadTreeSetup.CreateTreeTypePanel ( int  iType  )  [private]

Builds GUI.

Exceptions:
java.lang.Exception if there's a problem.

void javawrapper.DetailedOutputDeadTreeSetup.AddButtonActionPerformed ( int  iType  )  throws ModelException [private]

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

Parameters:
iType The tree type (TreePopulation.SEEDLING, TreePopulation.SAPLING, TreePopulation.ADULT, or TreePopulation.SNAG) that is firing the button.
Exceptions:
ModelException if the run is not snag-aware but someone is trying to save snag settings.

void javawrapper.DetailedOutputDeadTreeSetup.RemoveButtonActionPerformed ( int  iType  )  [private]

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

Parameters:
iType The tree type (TreePopulation.SEEDLING, TreePopulation.SAPLING, TreePopulation.ADULT, or TreePopulation.SNAG) that is firing the button.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)


Member Data Documentation

For exchanging data with.

Temp collection of settings - vector of DetailedTreeSettings objects.

String javawrapper.DetailedOutputDeadTreeSetup.m_sHelpID = "windows.detailed_output_tree_setup" [private]

The help ID for this window.

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.

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.

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.

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.

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

Edit box for entering how often to save.

JTextField javawrapper.DetailedOutputDeadTreeSetup.m_jSaplingTimestepsEdit = new JTextField() [private]

Edit box for entering how often to save.

JTextField javawrapper.DetailedOutputDeadTreeSetup.m_jAdultTimestepsEdit = new JTextField() [private]

Edit box for entering how often to save.

JTextField javawrapper.DetailedOutputDeadTreeSetup.m_jSnagTimestepsEdit = new JTextField() [private]

Edit box for entering how often to save.

Initial value:

 new
      DefaultListModel()
List model for the seedling data member list.

DefaultListModel javawrapper.DetailedOutputDeadTreeSetup.m_jSaplingDataMemberListModel = new DefaultListModel() [private]

List model for the sapling data member list.

DefaultListModel javawrapper.DetailedOutputDeadTreeSetup.m_jAdultDataMemberListModel = new DefaultListModel() [private]

List model for the adult data member list.

DefaultListModel javawrapper.DetailedOutputDeadTreeSetup.m_jSnagDataMemberListModel = new DefaultListModel() [private]

List model for the snag data member list.

DefaultListModel javawrapper.DetailedOutputDeadTreeSetup.m_jSpeciesListModel = new DefaultListModel() [private]

List model for the species list.

DefaultListModel javawrapper.DetailedOutputDeadTreeSetup.m_jSeedlingSaveListModel = new DefaultListModel() [private]

List model for the seedling saved data member list.

DefaultListModel javawrapper.DetailedOutputDeadTreeSetup.m_jSaplingSaveListModel = new DefaultListModel() [private]

List model for the sapling saved data member list.

DefaultListModel javawrapper.DetailedOutputDeadTreeSetup.m_jAdultSaveListModel = new DefaultListModel() [private]

List model for the adult saved data member list.

DefaultListModel javawrapper.DetailedOutputDeadTreeSetup.m_jSnagSaveListModel = new DefaultListModel() [private]

List model for the snag saved data member list.

DefaultListModel javawrapper.DetailedOutputDeadTreeSetup.m_jDeadCodesListModel = new DefaultListModel() [private]

List model for the dead reason codes list.

Seedling data member list.

Seedling species list.

Seedling save list.

Sapling species list.

Sapling save list.

Sapling data member list.

Adult species list.

Adult save list.

Adult data member list.

Snag species list.

Snag save list.

Snag data member list.

Seedling dead code list.

Sapling dead code list.

Adult dead code list.

Snag dead code list.


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

Generated on Tue Apr 19 13:59:37 2011 for SORTIE Java Interface by  doxygen 1.5.6