javawrapper::EpisodicEventsWindow Class Reference

Displays episodic events and allows for editing. More...

List of all members.

Public Member Functions

 EpisodicEventsWindow (JFrame oOwner, DisturbanceBehaviors oDisturbanceBehaviors, PlantingBehaviors oPlantBehaviors) throws ModelException
 Constructor.
void stateChanged (ChangeEvent e)
 Fired when the tabbed pane tab is changed.
void actionPerformed (ActionEvent oEvent)
 Responds to window events.
TreePopulation GetTreePopulation ()
 Gets access to the tree population for benefit of child windows.
javax.help.HelpBroker GetHelpBroker ()
 Gets access to the HelpBroker object for benefit of child windows.

Static Public Attributes

static final java.awt.Color HARVEST_COLOR
 Color for displaying harvests.
static final java.awt.Color PLANT_COLOR
 Color for displaying plantings.
static final java.awt.Color MORTALITY_EPISODE_COLOR
 Color for displaying mortality episode events.

Protected Member Functions

void SetUpChart ()
 Sets up the chart and displays any trees.
void MakeTreeDatasetAndRenderer ()
 Create the dataset and renderer for the trees.
void GetPlotAndGridInfo () throws ModelException
 Gets information on the plot and the grids.
void MakeGUI () throws ModelException
 Draws the window.
void DisplayNextHarvest () throws ModelException
 Displays the next harvest when the ">>" button is pressed.
void DisplayNextMortalityEpisode () throws ModelException
 Displays the next mortality episode when the next button is pressed.
void DisplayNextPlanting () throws ModelException
 Displays the next planting event when the ">>" button is pressed.
void DisplayPreviousHarvest () throws ModelException
 Displays the next harvest when the previous button is pressed.
void DisplayPreviousMortalityEpisode () throws ModelException
 Displays the previous mortality episode when the previous button is pressed.
void DisplayPreviousPlanting () throws ModelException
 Displays the next plant event when the previous button is pressed.
void DeleteHarvest () throws ModelException
 Deletes the currently displayed harvest.
void DeletePlanting () throws ModelException
 Deletes the currently displayed planting.
void DeleteMortalityEpisode () throws ModelException
 Deletes the currently displayed mortality episode.
void DisplayHarvest (HarvestData oHarvest) throws ModelException
 Causes a harvest event to be displayed in the window.
void DisplayMortalityEpisode (HarvestData oEpisode) throws ModelException
 Causes a mortality episode to be displayed in the window.
void DisplayPlanting (PlantingData oPlanting) throws ModelException
 Causes a planting event to be displayed in the window.
void AddFinishedData ()
 Takes the final data and adds it back to the behavior groups.

Protected Attributes

datavisualizer.XYZSeriesCollection m_oTreeDataset
 Dataset for displaying the trees along with episodic event data.
datavisualizer.XYTreeRenderer m_oTreeRenderer
 Renderer for displaying the trees along with episodic event data.
org.jfree.chart.plot.XYPlot m_oPlot
 Plot object for rendering events.
DisturbanceBehaviors m_oDisturbanceBehaviors
 Copy of the DisturbanceBehaviors object to exchange data with.
PlantingBehaviors m_oPlantBehaviors
 Copy of the PlantingBehaviors object to exchange data with.
float[] mp_fPlantInitialDiam10s
 Copy of the planting initial diameter at 10 cm values.
Vector mp_oHarvestData = new Vector(0)
 Copy of harvest data - copy this from m_oDisturbanceBehaviors, let the user make their updates, then copy this back to m_oDisturbanceBehaviors.
Vector mp_oMortEpisodeData = new Vector(0)
 Copy of mortality episode data - copy this from m_oDisturbanceBehaviors, let the user make their updates, then copy this back to m_oDisturbanceBehaviors.
Vector mp_oPlantingData = new Vector(0)
 Copy of planting data - copy this from m_oPlantBehaviors, let the user make their updates, then copy this back to m_oPlantBehaviors.
JTabbedPane m_jTabs = new JTabbedPane()
 For displaying harvest, episodic mortality, and planting events.
JLabel mp_jSpeciesPlantPercentages []
 Array of labels displaying species percentages for the current planting.
JLabel mp_jSpeciesPlantInitialDiam10 []
 Array of labels displaying the initial diam10 for each species for all plantings.
JLabel m_jCutTypeLabel = new JLabel("N/A")
 Label that displays the cut type for the currently displayed harvest.
JLabel m_jHarvestTimestepLabel = new JLabel("N/A")
 Label that displays the timestep for the currently displayed harvest.
JLabel m_jPlantTimestepLabel = new JLabel("N/A")
 Label that displays the timestep for the currently displayed planting.
JLabel m_jMortEpTimestepLabel = new JLabel("N/A")
 Label that displays the timestep for the currently displayed episodic mortality event.
JLabel m_jHarvestCutAmountTypeLabel
 Label that displays the cut amount type for the currently displayed harvest.
JLabel m_jMortEpCutAmountTypeLabel = new JLabel("N/A")
 Label that displays the cut amount type for the currently displayed mortality episode event.
JLabel m_jPlantSpacingLabel = new JLabel("N/A")
 Label that displays the plant spacing for the currently displayed planting.
JLabel m_jPlantAmountLabel = new JLabel("Density (#/ha):")
 Label that displays the plant amount label for the currently displayed planting.
JLabel m_jPlantAmountValueLabel = new JLabel("N/A")
 Label that displays the plant amount value for the currently displayed planting.
JLabel m_jNumHarvestEvents = new JLabel("0")
 Label that displays number of harvest events currently defined.
JLabel m_jNumMortEpEvents = new JLabel("0")
 Label that displays number of mortality episodes currently defined.
JLabel m_jNumPlantingEvents = new JLabel("0")
 Label that displays number of planting events currently defined.
JLabel m_jHarvestNumber = new JLabel("0")
 Label that displays the number of the current harvest event.
JLabel m_jMortEpNumber = new JLabel("0")
 Label that displays the number of the current mortality episode event.
JLabel m_jPlantNumber = new JLabel("0")
 Label that displays the number of the current planting event.
JLabel m_jHarvestCutRange1Min = new JLabel("0")
 Label that displays the cut range 1 minimum for the currently displayed harvest.
JLabel m_jHarvestCutRange2Min = new JLabel("0")
 Label that displays the cut range 2 minimum for the currently displayed harvest.
JLabel m_jHarvestCutRange3Min = new JLabel("0")
 Label that displays the cut range 3 minimum for the currently displayed harvest.
JLabel m_jHarvestCutRange4Min = new JLabel("0")
 Label that displays the cut range 4 minimum for the currently displayed harvest.
JLabel m_jHarvestCutRange1Max = new JLabel("0")
 Label that displays the cut range 1 maximum for the currently displayed harvest.
JLabel m_jHarvestCutRange2Max = new JLabel("0")
 Label that displays the cut range 2 maximum for the currently displayed harvest.
JLabel m_jHarvestCutRange3Max = new JLabel("0")
 Label that displays the cut range 3 maximum for the currently displayed harvest.
JLabel m_jHarvestCutRange4Max = new JLabel("0")
 Label that displays the cut range 4 maximum for the currently displayed harvest.
JLabel m_jHarvestCutRange1Amt = new JLabel("0")
 Label that displays the cut range 1 amount for the currently displayed harvest.
JLabel m_jHarvestCutRange2Amt = new JLabel("0")
 Label that displays the cut range 2 amount for the currently displayed harvest.
JLabel m_jHarvestCutRange3Amt = new JLabel("0")
 Label that displays the cut range 3 amount for the currently displayed harvest.
JLabel m_jHarvestCutRange4Amt = new JLabel("0")
 Label that displays the cut range 4 amount for the currently displayed harvest.
JLabel m_jMortEpCutRange1Min = new JLabel("0")
 Label that displays the cut range 1 minimum for the currently displayed mortality episode.
JLabel m_jMortEpCutRange2Min = new JLabel("0")
 Label that displays the cut range 2 minimum for the currently displayed mortality episode.
JLabel m_jMortEpCutRange3Min = new JLabel("0")
 Label that displays the cut range 3 minimum for the currently displayed mortality episode.
JLabel m_jMortEpCutRange4Min = new JLabel("0")
 Label that displays the cut range 4 minimum for the currently displayed mortality episode.
JLabel m_jMortEpCutRange1Max = new JLabel("0")
 Label that displays the cut range 1 maximum for the currently displayed mortality episode.
JLabel m_jMortEpCutRange2Max = new JLabel("0")
 Label that displays the cut range 2 maximum for the currently displayed mortality episode.
JLabel m_jMortEpCutRange3Max = new JLabel("0")
 Label that displays the cut range 3 maximum for the currently displayed mortality episode.
JLabel m_jMortEpCutRange4Max = new JLabel("0")
 Label that displays the cut range 4 maximum for the currently displayed mortality episode.
JLabel m_jMortEpCutRange1Amt = new JLabel("0")
 Label that displays the cut range 1 amount for the currently displayed mortality episode.
JLabel m_jMortEpCutRange2Amt = new JLabel("0")
 Label that displays the cut range 2 amount for the currently displayed mortality episode.
JLabel m_jMortEpCutRange3Amt = new JLabel("0")
 Label that displays the cut range 3 amount for the currently displayed mortality episode.
JLabel m_jMortEpCutRange4Amt = new JLabel("0")
 Label that displays the cut range 4 amount for the currently displayed mortality episode.
DefaultListModel m_jHarvestSpeciesList = new DefaultListModel()
 List of species for the currently displayed harvest.
DefaultListModel m_jMortEpSpeciesList = new DefaultListModel()
 List of species for the currently displayed mortality episode.
JPanel m_jChartPanel = new JPanel()
 Panel displaying the chart.
Dimension m_jParentSize
 Size of the parent calling window - so we can make sure children fit within this.
int m_iNumHarvestXCells
 Number of X cells in the Harvest grid.
int m_iNumHarvestYCells
 Number of Y cells in the Harvest grid.
int m_iNumMortEpisodeXCells
 Number of X cells in the Mortality Episode grid.
int m_iNumMortEpisodeYCells
 Number of Y cells in the Mortality Episode grid.
int m_iNumPlantXCells
 Number of X cells in the Planting grid.
int m_iNumPlantYCells
 Number of Y cells in the Planting grid.
int m_iPlotLengthX
 Length of the plot in the X direction, in meters.
int m_iPlotLengthY
 Length of the plot in the Y direction, in meters.
int m_iNumSpecies
 Number of species.

Private Member Functions

JDialog SizeChildWindow (JDialog jChildWindow)
 Sizes a child window to fit within the bounds of this window.

Private Attributes

String m_sHelpID = "windows.episodic_events_window"
 Help ID string.


Detailed Description

Displays episodic events and allows for editing.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0


Constructor & Destructor Documentation

javawrapper::EpisodicEventsWindow::EpisodicEventsWindow ( JFrame  oOwner,
DisturbanceBehaviors  oDisturbanceBehaviors,
PlantingBehaviors  oPlantBehaviors 
) throws ModelException [inline]

Constructor.

Builds the window.

Parameters:
oOwner Owner window for this dialog.
oDisturbanceBehaviors DisturbanceBehaviors object to exchange data with.
oPlantBehaviors PlantingBehaviors object to exchange data with.
Exceptions:
ModelException passing through from called methods.


Member Function Documentation

void javawrapper::EpisodicEventsWindow::actionPerformed ( ActionEvent  oEvent  )  [inline]

Responds to window events.

Parameters:
oEvent Event triggering this call.

void javawrapper::EpisodicEventsWindow::AddFinishedData (  )  [inline, protected]

Takes the final data and adds it back to the behavior groups.

This takes the contents of mp_oHarvestData, mp_oMortEpisodeData, and mp_oPlantingData, and puts them back into the parent behavior groups. Then, if there is a set of data for any of the behaviors, it makes sure that they are enabled.

void javawrapper::EpisodicEventsWindow::DeleteHarvest (  )  throws ModelException [inline, protected]

Deletes the currently displayed harvest.

If no harvest is displayed (the display number is set to 0), nothing happens. If a harvest is deleted, the next harvest is displayed, or the previous one if it is the last.

Exceptions:
ModelException passed through from called methods.

void javawrapper::EpisodicEventsWindow::DeleteMortalityEpisode (  )  throws ModelException [inline, protected]

Deletes the currently displayed mortality episode.

If no episode is displayed (the display number is set to 0), nothing happens. If an episode is deleted, the next episode is displayed, or the previous one if it is the last.

Exceptions:
ModelException passed through from called methods.

void javawrapper::EpisodicEventsWindow::DeletePlanting (  )  throws ModelException [inline, protected]

Deletes the currently displayed planting.

If no planting is displayed (the display number is set to 0), nothing happens. If a planting is deleted, the next planting is displayed, or the previous one if it is the last.

Exceptions:
ModelException passed through from called methods.

void javawrapper::EpisodicEventsWindow::DisplayHarvest ( HarvestData  oHarvest  )  throws ModelException [inline, protected]

Causes a harvest event to be displayed in the window.

Parameters:
oHarvest Harvest to display, or NULL if no harvest is to be displayed.
Exceptions:
ModelException passing through from called methods.

void javawrapper::EpisodicEventsWindow::DisplayMortalityEpisode ( HarvestData  oEpisode  )  throws ModelException [inline, protected]

Causes a mortality episode to be displayed in the window.

Parameters:
oEpisode Mortality episode to display, or NULL if no episode is to be displayed.
Exceptions:
ModelException passing through from called methods.

void javawrapper::EpisodicEventsWindow::DisplayNextHarvest (  )  throws ModelException [inline, protected]

Displays the next harvest when the ">>" button is pressed.

If the last harvest is being displayed, then nothing changes.

Exceptions:
ModelException Passing through from called methods.

void javawrapper::EpisodicEventsWindow::DisplayNextMortalityEpisode (  )  throws ModelException [inline, protected]

Displays the next mortality episode when the next button is pressed.

If the last episode is being displayed, then nothing changes.

Exceptions:
ModelException Passing through from called methods.

void javawrapper::EpisodicEventsWindow::DisplayNextPlanting (  )  throws ModelException [inline, protected]

Displays the next planting event when the ">>" button is pressed.

If the last planting is being displayed, then nothing changes.

Exceptions:
ModelException Passing through from called methods.

void javawrapper::EpisodicEventsWindow::DisplayPlanting ( PlantingData  oPlanting  )  throws ModelException [inline, protected]

Causes a planting event to be displayed in the window.

Planting events are displayed as a transparent texture - this allows harvests to display underneath.

Parameters:
oPlanting Planting to display, or NULL if no planting is to be displayed.
Exceptions:
ModelException passing through from called methods.

void javawrapper::EpisodicEventsWindow::DisplayPreviousHarvest (  )  throws ModelException [inline, protected]

Displays the next harvest when the previous button is pressed.

If the first harvest is being displayed, then nothing changes.

Exceptions:
ModelException Passing through from called methods.

void javawrapper::EpisodicEventsWindow::DisplayPreviousMortalityEpisode (  )  throws ModelException [inline, protected]

Displays the previous mortality episode when the previous button is pressed.

If the first episode is being displayed, then nothing changes.

Exceptions:
ModelException Passing through from called methods.

void javawrapper::EpisodicEventsWindow::DisplayPreviousPlanting (  )  throws ModelException [inline, protected]

Displays the next plant event when the previous button is pressed.

If the first planting is being displayed, then nothing changes.

Exceptions:
ModelException Passing through from called methods.

javax.help.HelpBroker javawrapper::EpisodicEventsWindow::GetHelpBroker (  )  [inline]

Gets access to the HelpBroker object for benefit of child windows.

Returns:
HelpBroker object.

void javawrapper::EpisodicEventsWindow::GetPlotAndGridInfo (  )  throws ModelException [inline, protected]

Gets information on the plot and the grids.

Exceptions:
ModelException passing through from called methods.

TreePopulation javawrapper::EpisodicEventsWindow::GetTreePopulation (  )  [inline]

Gets access to the tree population for benefit of child windows.

Returns:
TreePopulation object.

void javawrapper::EpisodicEventsWindow::MakeGUI (  )  throws ModelException [inline, protected]

Draws the window.

Exceptions:
ModelException passing through from called methods.

JDialog javawrapper::EpisodicEventsWindow::SizeChildWindow ( JDialog  jChildWindow  )  [inline, private]

Sizes a child window to fit within the bounds of this window.

Parameters:
jChildWindow JDialog The window to size.
Returns:
JDialog The sized window.

void javawrapper::EpisodicEventsWindow::stateChanged ( ChangeEvent  e  )  [inline]

Fired when the tabbed pane tab is changed.

This will determine which tab is selected and make sure that the current event on that tab is displayed on the chart.

Parameters:
e ChangeEvent object.


Member Data Documentation

final java.awt.Color javawrapper::EpisodicEventsWindow::HARVEST_COLOR [static]

Initial value:

 new java.awt.Color(255,
      100, 255)
Color for displaying harvests.

JLabel javawrapper::EpisodicEventsWindow::m_jHarvestCutAmountTypeLabel [protected]

Initial value:

 new JLabel(
      "N/A")
Label that displays the cut amount type for the currently displayed harvest.

org.jfree.chart.plot.XYPlot javawrapper::EpisodicEventsWindow::m_oPlot [protected]

Initial value:

 new org.jfree.chart.plot.
      XYPlot()
Plot object for rendering events.

datavisualizer.XYZSeriesCollection javawrapper::EpisodicEventsWindow::m_oTreeDataset [protected]

Initial value:

 new
      datavisualizer.XYZSeriesCollection()
Dataset for displaying the trees along with episodic event data.

datavisualizer.XYTreeRenderer javawrapper::EpisodicEventsWindow::m_oTreeRenderer [protected]

Initial value:

 new datavisualizer.
      XYTreeRenderer()
Renderer for displaying the trees along with episodic event data.

final java.awt.Color javawrapper::EpisodicEventsWindow::MORTALITY_EPISODE_COLOR [static]

Initial value:

 new java.awt.
      Color(150, 225,
            225)
Color for displaying mortality episode events.

final java.awt.Color javawrapper::EpisodicEventsWindow::PLANT_COLOR [static]

Initial value:

 new java.awt.Color(255, 255,
      100)
Color for displaying plantings.


The documentation for this class was generated from the following file:
Generated on Wed Nov 29 08:45:03 2006 for SORTIE Java Interface by  doxygen 1.4.7