javawrapper.DetailedOutputTreeSetup Class Reference

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

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

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()
 Panel showing the different tree types.
JPanel m_jSeedlingPanel = new JPanel()
 Panel for seedlings.
JPanel m_jSaplingPanel = new JPanel()
 Panel for saplings.
JPanel m_jAdultPanel = new JPanel()
 Panel for adults.
JPanel m_jSnagPanel = new JPanel()
 Panel for snags.
JLabel m_jSeedlingSelectLabel = new JLabel()
 Label for selection.
JScrollPane m_jSeedlingSpeciesScrollPane = new JScrollPane()
 Scroll pane for displaying species.
JLabel m_jSeedlingSaveEveryLabel = new JLabel()
 Label for how often to save data members.
JTextField m_jSeedlingTimestepsEdit = new JTextField()
 Edit box for entering how often to save.
JLabel m_jSeedlingTreeSaveLabel = new JLabel()
 Label for save.
JButton m_jSeedlingAddButton = new JButton()
 Button for adding data members.
JLabel m_jSeedlingWhatSavedLabel = new JLabel()
 Label displaying what's saved.
JScrollPane m_jSeedlingSaveScrollPane = new JScrollPane()
 Scroll pane with what's been saved.
JButton m_jSeedlingRemoveButton = new JButton()
 Button for removing data members.
JScrollPane m_jSeedlingDataMemberScrollPane = new JScrollPane()
 Scroll pane for displaying data members.
JButton m_jSaplingAddButton = new JButton()
 Button for adding data members.
JLabel m_jSaplingSelectLabel = new JLabel()
 Label for selection.
JScrollPane m_jSaplingSpeciesScrollPane = new JScrollPane()
 Scroll pane for displaying species.
JScrollPane m_jSaplingSaveScrollPane = new JScrollPane()
 Scroll pane with what's been saved.
JButton m_jSaplingRemoveButton = new JButton()
 Button for removing data members.
JLabel m_jSaplingWhatSavedLabel = new JLabel()
 Label displaying what's saved.
JLabel m_jSaplingTreeSaveLabel = new JLabel()
 Label for save.
JLabel m_jSaplingSaveEveryLabel = new JLabel()
 Label for how often to save data members.
JScrollPane m_jSaplingDataMemberScrollPane = new JScrollPane()
 Scroll pane for displaying data members.
JTextField m_jSaplingTimestepsEdit = new JTextField()
 Edit box for entering how often to save.
JScrollPane m_jAdultSpeciesScrollPane = new JScrollPane()
 Scroll pane for displaying species.
JLabel m_jAdultSelectLabel = new JLabel()
 Label for selection.
JButton m_jAdultRemoveButton = new JButton()
 Button for removing data members.
JScrollPane m_jAdultSaveScrollPane = new JScrollPane()
 Scroll pane with what's been saved.
JLabel m_jAdultWhatSavedLabel = new JLabel()
 Label displaying what's saved.
JLabel m_jAdultTreeSaveLabel = new JLabel()
 Label for save.
JButton m_jAdultAddButton = new JButton()
 Button for adding data members.
JLabel m_jAdultSaveEveryLabel = new JLabel()
 Label for how often to save data members.
JScrollPane m_jAdultDataMemberScrollPane = new JScrollPane()
 Scroll pane for displaying data members.
JTextField m_jAdultTimestepsEdit = new JTextField()
 Edit box for entering how often to save.
JScrollPane m_jSnagSpeciesScrollPane = new JScrollPane()
 Scroll pane for displaying species.
JLabel m_jSnagSelectLabel = new JLabel()
 Label for selection.
JButton m_jSnagRemoveButton = new JButton()
 Button for removing data members.
JScrollPane m_jSnagSaveScrollPane = new JScrollPane()
 Scroll pane with what's been saved.
JLabel m_jSnagWhatSavedLabel = new JLabel()
 Label displaying what's saved.
JLabel m_jSnagTreeSaveLabel = new JLabel()
 Label for save.
JButton m_jSnagAddButton = new JButton()
 Button for adding data members.
JLabel m_jSnagSaveEveryLabel = new JLabel()
 Label for how often to save data members.
JScrollPane m_jSnagDataMemberScrollPane = new JScrollPane()
 Scroll pane for displaying data members.
JTextField m_jSnagTimestepsEdit = new JTextField()
 Edit box for entering how often to save.
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.
GridBagLayout m_jGridBagLayout3 = new GridBagLayout()
 Layout.
GridBagLayout m_jGridBagLayout1 = new GridBagLayout()
 Layout.
GridBagLayout m_jGridBagLayout2 = new GridBagLayout()
 Layout.
GridBagLayout m_jGridBagLayout4 = new GridBagLayout()
 Layout.
GridBagLayout m_jGridBagLayout5 = new GridBagLayout()
 Layout.
JPanel m_jComponentPanel = new JPanel()
 Component panel.
JPanel m_jButtonPanel = new JPanel()
 Button panel.

Static Package Attributes

static final long serialVersionUID = 1

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


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)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)

Constructor & Destructor Documentation

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

Constructor.

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


Member Function Documentation

void javawrapper.DetailedOutputTreeSetup.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.DetailedOutputTreeSetup.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.DetailedOutputTreeSetup.SaveData (  )  throws ModelException [private]

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

Exceptions:
ModelException passed through from called methods.

void javawrapper.DetailedOutputTreeSetup.actionPerformed ( ActionEvent  oEvent  ) 

Performs the actions of the window.

Parameters:
oEvent ActionEvent object.

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

void javawrapper.DetailedOutputTreeSetup.LoadSettings (  )  [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.UpdateSaves (  )  [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)

void javawrapper.DetailedOutputTreeSetup.jbInit (  )  throws Exception [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.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.

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

void javawrapper.DetailedOutputTreeSetup.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

final long javawrapper.DetailedOutputTreeSetup.serialVersionUID = 1 [static, package]

For exchanging data with.

Temp collection of settings - vector of DetailedTreeSettings objects.

String javawrapper.DetailedOutputTreeSetup.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.

JTabbedPane javawrapper.DetailedOutputTreeSetup.m_jTabbedPanel = new JTabbedPane() [package]

Panel showing the different tree types.

Panel for seedlings.

JPanel javawrapper.DetailedOutputTreeSetup.m_jSaplingPanel = new JPanel() [package]

Panel for saplings.

JPanel javawrapper.DetailedOutputTreeSetup.m_jAdultPanel = new JPanel() [package]

Panel for adults.

JPanel javawrapper.DetailedOutputTreeSetup.m_jSnagPanel = new JPanel() [package]

Panel for snags.

Label for selection.

JScrollPane javawrapper.DetailedOutputTreeSetup.m_jSeedlingSpeciesScrollPane = new JScrollPane() [package]

Scroll pane for displaying species.

Label for how often to save data members.

JTextField javawrapper.DetailedOutputTreeSetup.m_jSeedlingTimestepsEdit = new JTextField() [package]

Edit box for entering how often to save.

Label for save.

Button for adding data members.

Label displaying what's saved.

JScrollPane javawrapper.DetailedOutputTreeSetup.m_jSeedlingSaveScrollPane = new JScrollPane() [package]

Scroll pane with what's been saved.

Button for removing data members.

Scroll pane for displaying data members.

Button for adding data members.

Label for selection.

JScrollPane javawrapper.DetailedOutputTreeSetup.m_jSaplingSpeciesScrollPane = new JScrollPane() [package]

Scroll pane for displaying species.

JScrollPane javawrapper.DetailedOutputTreeSetup.m_jSaplingSaveScrollPane = new JScrollPane() [package]

Scroll pane with what's been saved.

Button for removing data members.

Label displaying what's saved.

Label for save.

Label for how often to save data members.

JScrollPane javawrapper.DetailedOutputTreeSetup.m_jSaplingDataMemberScrollPane = new JScrollPane() [package]

Scroll pane for displaying data members.

JTextField javawrapper.DetailedOutputTreeSetup.m_jSaplingTimestepsEdit = new JTextField() [package]

Edit box for entering how often to save.

JScrollPane javawrapper.DetailedOutputTreeSetup.m_jAdultSpeciesScrollPane = new JScrollPane() [package]

Scroll pane for displaying species.

Label for selection.

Button for removing data members.

JScrollPane javawrapper.DetailedOutputTreeSetup.m_jAdultSaveScrollPane = new JScrollPane() [package]

Scroll pane with what's been saved.

Label displaying what's saved.

Label for save.

JButton javawrapper.DetailedOutputTreeSetup.m_jAdultAddButton = new JButton() [package]

Button for adding data members.

Label for how often to save data members.

JScrollPane javawrapper.DetailedOutputTreeSetup.m_jAdultDataMemberScrollPane = new JScrollPane() [package]

Scroll pane for displaying data members.

JTextField javawrapper.DetailedOutputTreeSetup.m_jAdultTimestepsEdit = new JTextField() [package]

Edit box for entering how often to save.

JScrollPane javawrapper.DetailedOutputTreeSetup.m_jSnagSpeciesScrollPane = new JScrollPane() [package]

Scroll pane for displaying species.

Label for selection.

Button for removing data members.

JScrollPane javawrapper.DetailedOutputTreeSetup.m_jSnagSaveScrollPane = new JScrollPane() [package]

Scroll pane with what's been saved.

Label displaying what's saved.

Label for save.

JButton javawrapper.DetailedOutputTreeSetup.m_jSnagAddButton = new JButton() [package]

Button for adding data members.

Label for how often to save data members.

JScrollPane javawrapper.DetailedOutputTreeSetup.m_jSnagDataMemberScrollPane = new JScrollPane() [package]

Scroll pane for displaying data members.

JTextField javawrapper.DetailedOutputTreeSetup.m_jSnagTimestepsEdit = new JTextField() [package]

Edit box for entering how often to save.

Initial value:

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

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

List model for the sapling data member list.

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

List model for the adult data member list.

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

List model for the snag data member list.

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

List model for the species list.

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

List model for the seedling saved data member list.

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

List model for the sapling saved data member list.

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

List model for the adult saved data member list.

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

List model for the snag saved data member 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.

GridBagLayout javawrapper.DetailedOutputTreeSetup.m_jGridBagLayout3 = new GridBagLayout() [package]

Layout.

GridBagLayout javawrapper.DetailedOutputTreeSetup.m_jGridBagLayout1 = new GridBagLayout() [package]

Layout.

GridBagLayout javawrapper.DetailedOutputTreeSetup.m_jGridBagLayout2 = new GridBagLayout() [package]

Layout.

GridBagLayout javawrapper.DetailedOutputTreeSetup.m_jGridBagLayout4 = new GridBagLayout() [package]

Layout.

GridBagLayout javawrapper.DetailedOutputTreeSetup.m_jGridBagLayout5 = new GridBagLayout() [package]

Layout.

Component panel.

JPanel javawrapper.DetailedOutputTreeSetup.m_jButtonPanel = new JPanel() [package]

Button panel.


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

Generated on Wed Oct 28 14:01:19 2009 for SORTIE Java Interface by  doxygen 1.5.6