javawrapper::DetailedOutputTreeSetup Class Reference

Window used by the user to set up detailed output tree output options. More...

List of all members.

Public Member Functions

 DetailedOutputTreeSetup (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.

Package Attributes

JTabbedPane m_jTabbedPanel = new JTabbedPane()
JPanel m_jSeedlingPanel = new JPanel()
JPanel m_jSaplingPanel = new JPanel()
JPanel m_jAdultPanel = new JPanel()
JPanel m_jSnagPanel = new JPanel()
JLabel m_jSeedlingSelectLabel = new JLabel()
JScrollPane m_jSeedlingSpeciesScrollPane = new JScrollPane()
JLabel m_jSeedlingSaveEveryLabel = new JLabel()
JTextField m_jSeedlingTimestepsEdit = new JTextField()
JLabel m_jSeedlingTreeSaveLabel = new JLabel()
JButton m_jSeedlingAddButton = new JButton()
JLabel m_jSeedlingWhatSavedLabel = new JLabel()
JScrollPane m_jSeedlingSaveScrollPane = new JScrollPane()
JButton m_jSeedlingRemoveButton = new JButton()
JScrollPane m_jSeedlingDataMemberScrollPane = new JScrollPane()
JButton m_jSaplingAddButton = new JButton()
JLabel m_jSaplingSelectLabel = new JLabel()
JScrollPane m_jSaplingSpeciesScrollPane = new JScrollPane()
JScrollPane m_jSaplingSaveScrollPane = new JScrollPane()
JButton m_jSaplingRemoveButton = new JButton()
JLabel m_jSaplingWhatSavedLabel = new JLabel()
JLabel m_jSaplingTreeSaveLabel = new JLabel()
JLabel m_jSaplingSaveEveryLabel = new JLabel()
JScrollPane m_jSaplingDataMemberScrollPane = new JScrollPane()
JTextField m_jSaplingTimestepsEdit = new JTextField()
JScrollPane m_jAdultSpeciesScrollPane = new JScrollPane()
JLabel m_jAdultSelectLabel = new JLabel()
JButton m_jAdultRemoveButton = new JButton()
JScrollPane m_jAdultSaveScrollPane = new JScrollPane()
JLabel m_jAdultWhatSavedLabel = new JLabel()
JLabel m_jAdultTreeSaveLabel = new JLabel()
JButton m_jAdultAddButton = new JButton()
JLabel m_jAdultSaveEveryLabel = new JLabel()
JScrollPane m_jAdultDataMemberScrollPane = new JScrollPane()
JTextField m_jAdultTimestepsEdit = new JTextField()
JScrollPane m_jSnagSpeciesScrollPane = new JScrollPane()
JLabel m_jSnagSelectLabel = new JLabel()
JButton m_jSnagRemoveButton = new JButton()
JScrollPane m_jSnagSaveScrollPane = new JScrollPane()
JLabel m_jSnagWhatSavedLabel = new JLabel()
JLabel m_jSnagTreeSaveLabel = new JLabel()
JButton m_jSnagAddButton = new JButton()
JLabel m_jSnagSaveEveryLabel = new JLabel()
JScrollPane m_jSnagDataMemberScrollPane = new JScrollPane()
JTextField m_jSnagTimestepsEdit = new JTextField()
JList m_jSeedlingDataMemberList = new JList(m_jSeedlingDataMemberListModel)
JList m_jSeedlingSpeciesList = new JList(m_jSpeciesListModel)
JList m_jSeedlingSaveList = new JList(m_jSeedlingSaveListModel)
JList m_jSaplingSpeciesList = new JList(m_jSpeciesListModel)
JList m_jSaplingSaveList = new JList(m_jSaplingSaveListModel)
JList m_jSaplingDataMemberList = new JList(m_jSaplingDataMemberListModel)
JList m_jAdultSpeciesList = new JList(m_jSpeciesListModel)
JList m_jAdultSaveList = new JList(m_jAdultSaveListModel)
JList m_jAdultDataMemberList = new JList(m_jAdultDataMemberListModel)
JList m_jSnagSpeciesList = new JList(m_jSpeciesListModel)
JList m_jSnagSaveList = new JList(m_jSnagSaveListModel)
JList m_jSnagDataMemberList = new JList(m_jSnagDataMemberListModel)
GridBagLayout m_jGridBagLayout3 = new GridBagLayout()
GridBagLayout m_jGridBagLayout1 = new GridBagLayout()
GridBagLayout m_jGridBagLayout2 = new GridBagLayout()
GridBagLayout m_jGridBagLayout4 = new GridBagLayout()
GridBagLayout m_jGridBagLayout5 = new GridBagLayout()
JPanel m_jComponentPanel = new JPanel()
JPanel m_jButtonPanel = new JPanel()

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 jbInit () throws Exception
 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 mp_oDetailedTreeSaveSettings
 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.
DefaultListModel m_jSeedlingDataMemberListModel
DefaultListModel m_jSaplingDataMemberListModel = new DefaultListModel()
DefaultListModel m_jAdultDataMemberListModel = new DefaultListModel()
DefaultListModel m_jSnagDataMemberListModel = new DefaultListModel()
DefaultListModel m_jSpeciesListModel = new DefaultListModel()
DefaultListModel m_jSeedlingSaveListModel = new DefaultListModel()
DefaultListModel m_jSaplingSaveListModel = new DefaultListModel()
DefaultListModel m_jAdultSaveListModel = new DefaultListModel()
DefaultListModel m_jSnagSaveListModel = new DefaultListModel()


Detailed Description

Window used by the user to set up detailed output tree output options.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
June 28, 2004: Added support for snags (LEM)
July 20, 2004: Added all other tree data members (LEM)


Constructor & Destructor Documentation

javawrapper::DetailedOutputTreeSetup::DetailedOutputTreeSetup JDialog  oParent,
OutputBehaviors  oOutputBehaviors
[inline]
 

Constructor.

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

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


Member Function Documentation

void javawrapper::DetailedOutputTreeSetup::actionPerformed ActionEvent  oEvent  )  [inline]
 

Performs the actions of the window.

Parameters:
oEvent ActionEvent object.

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

void javawrapper::DetailedOutputTreeSetup::AddButtonActionPerformed int  iType  )  throws ModelException [inline, 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.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
July 21, 2004: Added flag to check for snag awareness (LEM)

void javawrapper::DetailedOutputTreeSetup::CollectTreeDataMembers TreePopulation  oPop  )  throws ModelException [inline, 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::DetailedOutputTreeSetup::jbInit  )  throws Exception [inline, private]
 

Builds GUI.

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

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

void javawrapper::DetailedOutputTreeSetup::LoadSettings  )  [inline, private]
 

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


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

void javawrapper::DetailedOutputTreeSetup::RemoveButtonActionPerformed int  iType  )  [inline, 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)

void javawrapper::DetailedOutputTreeSetup::SaveAll  )  throws ModelException [inline]
 

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::DetailedOutputTreeSetup::SaveData  )  throws ModelException [inline, private]
 

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

Exceptions:
ModelException passed through from called methods.

void javawrapper::DetailedOutputTreeSetup::UpdateSaves  )  [inline, private]
 

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


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


Member Data Documentation

DefaultListModel javawrapper::DetailedOutputTreeSetup::m_jSeedlingDataMemberListModel [private]
 

Initial value:

 new
      DefaultListModel()

boolean [][] javawrapper::DetailedOutputTreeSetup::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 [][] javawrapper::DetailedOutputTreeSetup::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 [][] javawrapper::DetailedOutputTreeSetup::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 [][] javawrapper::DetailedOutputTreeSetup::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.


The documentation for this class was generated from the following file:
Generated on Mon Mar 27 15:15:35 2006 for SORTIE Java Interface by  doxygen 1.4.6-NO