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

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

Inheritance diagram for sortie.gui.harvepplant.HarvestDisplayWindow:
sortie.gui.harvepplant.DisplayWindowBase

Public Member Functions

 HarvestDisplayWindow (JFrame oOwner, DisturbanceBehaviors oDisturbanceBehaviors, PlantingBehaviors oPlantBehaviors) throws ModelException
 Constructor. More...
 
void actionPerformed (ActionEvent oEvent)
 Responds to window events. More...
 
- Public Member Functions inherited from sortie.gui.harvepplant.DisplayWindowBase
 DisplayWindowBase (JFrame oOwner, DisturbanceBehaviors oDisturbanceBehaviors, PlantingBehaviors oPlantBehaviors, String sWindowTitle, windowType iWinType) throws ModelException
 Constructor. More...
 
void actionPerformed (ActionEvent oEvent)
 Responds to window events. More...
 
TreePopulation getTreePopulation ()
 Gets access to the tree population for benefit of child windows. More...
 
HelpBroker getHelpBroker ()
 Gets access to the HelpBroker object for benefit of child windows. More...
 

Protected Member Functions

void makeGUI () throws ModelException
 Draws the window. More...
 
void displayNextHarvest () throws ModelException
 Displays the next harvest when the ">>" button is pressed. More...
 
void displayPreviousHarvest () throws ModelException
 Displays the next harvest when the previous button is pressed. More...
 
void deleteHarvest () throws ModelException
 Deletes the currently displayed harvest. More...
 
void displayHarvest (HarvestData oHarvest) throws ModelException
 Causes a harvest event to be displayed in the window. More...
 
void addFinishedData () throws ModelException
 Takes the final data and adds it back to the behavior groups. More...
 
- Protected Member Functions inherited from sortie.gui.harvepplant.DisplayWindowBase
void setUpCharting (windowType iWinType) throws ModelException
 Sets up the chart and displays any trees. More...
 
void replaceChart ()
 Replace the chart when it needs to be refreshed. More...
 
void makeTreeDatasetAndRenderer () throws ModelException
 Create the dataset and renderer for the trees. More...
 
void getPlotAndGridInfo (windowType iWinType) throws ModelException
 Gets information on the plot and the grids. More...
 
JPanel makeLegendPanel () throws ModelException
 Creates a legend panel. More...
 
JDialog sizeChildWindow (JDialog jChildWindow)
 Sizes a child window to fit within the bounds of this window. More...
 
void addFinishedData () throws ModelException
 Takes the final data and adds it back to the behavior groups. More...
 

Protected Attributes

JLabel m_jCutTypeLabel = new JLabel("N/A")
 Label that displays the cut type for the currently displayed harvest. More...
 
JLabel m_jTimestepLabel = new JLabel("N/A")
 Label that displays the timestep for the currently displayed harvest. More...
 
JLabel m_jCutAmountTypeLabel = new JLabel("N/A")
 Label that displays the cut amount type for the currently displayed harvest. More...
 
JLabel m_jCutOrderFlagLabel = new JLabel("N/A")
 Label that displays cut order flag for the currently displayed harvest. More...
 
JLabel m_jNumHarvestEvents = new JLabel("0")
 Label that displays number of harvest events currently defined. More...
 
JLabel m_jHarvestNumber = new JLabel("0")
 Label that displays the number of the current harvest event. More...
 
JLabel m_jCutRange1Min = new JLabel("0")
 Label that displays the cut range 1 minimum for the currently displayed harvest. More...
 
JLabel m_jCutRange2Min = new JLabel("0")
 Label that displays the cut range 2 minimum for the currently displayed harvest. More...
 
JLabel m_jCutRange3Min = new JLabel("0")
 Label that displays the cut range 3 minimum for the currently displayed harvest. More...
 
JLabel m_jCutRange4Min = new JLabel("0")
 Label that displays the cut range 4 minimum for the currently displayed harvest. More...
 
JLabel m_jCutRange1Max = new JLabel("0")
 Label that displays the cut range 1 maximum for the currently displayed harvest. More...
 
JLabel m_jCutRange2Max = new JLabel("0")
 Label that displays the cut range 2 maximum for the currently displayed harvest. More...
 
JLabel m_jCutRange3Max = new JLabel("0")
 Label that displays the cut range 3 maximum for the currently displayed harvest. More...
 
JLabel m_jCutRange4Max = new JLabel("0")
 Label that displays the cut range 4 maximum for the currently displayed harvest. More...
 
JLabel m_jCutRange1Amt = new JLabel("0")
 Label that displays the cut range 1 amount for the currently displayed harvest. More...
 
JLabel m_jCutRange2Amt = new JLabel("0")
 Label that displays the cut range 2 amount for the currently displayed harvest. More...
 
JLabel m_jCutRange3Amt = new JLabel("0")
 Label that displays the cut range 3 amount for the currently displayed harvest. More...
 
JLabel m_jCutRange4Amt = new JLabel("0")
 Label that displays the cut range 4 amount for the currently displayed harvest. More...
 
DefaultListModel< String > m_jSeedlingMortRate = new DefaultListModel<String>()
 For displaying harvest seed mortality rates. More...
 
JLabel m_jHarvestPriorities = new JLabel("")
 Label that displays the priorities. More...
 
DefaultListModel< String > m_jSpeciesList = new DefaultListModel<String>()
 List of species for the currently displayed harvest. More...
 
- Protected Attributes inherited from sortie.gui.harvepplant.DisplayWindowBase
DefaultXYZDataset m_oTreeDataset = new DefaultXYZDataset()
 A dataset for trees, one series for each species. More...
 
XYTreeRenderer m_oTreeRenderer
 Renderer for displaying the trees along with episodic event data. More...
 
XYPlot m_oPlot = new XYPlot()
 Plot object for rendering events. More...
 
XYZSimpleDataset m_oDataset
 Dataset for displaying harvest events - controls which cells show up which color. More...
 
XYSimpleCellRenderer m_oRenderer = new XYSimpleCellRenderer()
 Renderer for displaying harvest events. More...
 
DisturbanceBehaviors m_oDisturbanceBehaviors
 DisturbanceBehaviors object to exchange data with. More...
 
PlantingBehaviors m_oPlantBehaviors
 PlantingBehaviors object to exchange data with. More...
 
ArrayList< HarvestDatamp_oHarvestData = new ArrayList<HarvestData>(0)
 Copy of harvest data to display. More...
 
ArrayList< HarvestDatamp_oMortEpisodeData = new ArrayList<HarvestData>(0)
 Copy of mortality episode data to display. More...
 
ArrayList< PlantingDatamp_oPlantingData = new ArrayList<PlantingData>(0)
 Copy of planting data to display. More...
 
JPanel m_jChartPanel = new JPanel()
 Panel displaying the chart. More...
 
Dimension m_jParentSize
 Size of the parent calling window - so we can make sure children fit within this. More...
 
float m_fLengthXCells
 Length of grid cells in the X direction. More...
 
float m_fLengthYCells
 Length of grid cells in the Y direction. More...
 
int m_iNumXCells
 Number of X cells in the grid. More...
 
int m_iNumYCells
 Number of Y cells in the grid. More...
 
int m_iPlotLengthX
 Length of the plot in the X direction, in meters. More...
 
int m_iPlotLengthY
 Length of the plot in the Y direction, in meters. More...
 
int m_iNumSpecies
 Number of species. More...
 

Private Attributes

String m_sHelpID = "windows.edit_harvest_window"
 Help ID string. More...
 

Additional Inherited Members

- Static Public Attributes inherited from sortie.gui.harvepplant.DisplayWindowBase
static final Color HARVEST_COLOR = new Color(255, 100, 255)
 Color for displaying harvests. More...
 
static final Color PLANT_COLOR = new Color(255, 255, 100)
 Color for displaying plantings. More...
 
static final Color MORTALITY_EPISODE_COLOR = new Color(150, 225, 225)
 Color for displaying mortality episode events. More...
 

Detailed Description

Displays harvest events and allows for editing.

Copyright: Copyright (c) Charles D. Canham 2013

Company: Cary Institute of Ecosystem Studies

Author
Lora E. Murphy
Version
1.0
Edit history:
---------------—
May 23, 2013: Created (LEM)

Constructor & Destructor Documentation

◆ HarvestDisplayWindow()

sortie.gui.harvepplant.HarvestDisplayWindow.HarvestDisplayWindow ( JFrame  oOwner,
DisturbanceBehaviors  oDisturbanceBehaviors,
PlantingBehaviors  oPlantBehaviors 
) throws ModelException

Constructor.

Builds the window.

Parameters
oOwnerOwner window for this dialog.
oDisturbanceBehaviorsDisturbanceBehaviors object to exchange data with.
oPlantBehaviorsPlantingBehaviors object to exchange data with.
Exceptions
ModelExceptionpassing through from called methods.

Member Function Documentation

◆ actionPerformed()

void sortie.gui.harvepplant.HarvestDisplayWindow.actionPerformed ( ActionEvent  oEvent)

Responds to window events.

Parameters
oEventEvent triggering this call.

◆ addFinishedData()

void sortie.gui.harvepplant.HarvestDisplayWindow.addFinishedData ( ) throws ModelException
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.

◆ deleteHarvest()

void sortie.gui.harvepplant.HarvestDisplayWindow.deleteHarvest ( ) throws ModelException
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
ModelExceptionpassed through from called methods.

◆ displayHarvest()

void sortie.gui.harvepplant.HarvestDisplayWindow.displayHarvest ( HarvestData  oHarvest) throws ModelException
protected

Causes a harvest event to be displayed in the window.

Parameters
oHarvestHarvest to display, or NULL if no harvest is to be displayed.
Exceptions
ModelExceptionpassing through from called methods.

◆ displayNextHarvest()

void sortie.gui.harvepplant.HarvestDisplayWindow.displayNextHarvest ( ) throws ModelException
protected

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

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

Exceptions
ModelExceptionPassing through from called methods.

◆ displayPreviousHarvest()

void sortie.gui.harvepplant.HarvestDisplayWindow.displayPreviousHarvest ( ) throws ModelException
protected

Displays the next harvest when the previous button is pressed.

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

Exceptions
ModelExceptionPassing through from called methods.

◆ makeGUI()

void sortie.gui.harvepplant.HarvestDisplayWindow.makeGUI ( ) throws ModelException
protected

Draws the window.

Exceptions
ModelExceptionpassing through from called methods.

Member Data Documentation

◆ m_jCutAmountTypeLabel

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutAmountTypeLabel = new JLabel("N/A")
protected

Label that displays the cut amount type for the currently displayed harvest.

◆ m_jCutOrderFlagLabel

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutOrderFlagLabel = new JLabel("N/A")
protected

Label that displays cut order flag for the currently displayed harvest.

◆ m_jCutRange1Amt

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutRange1Amt = new JLabel("0")
protected

Label that displays the cut range 1 amount for the currently displayed harvest.

◆ m_jCutRange1Max

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutRange1Max = new JLabel("0")
protected

Label that displays the cut range 1 maximum for the currently displayed harvest.

◆ m_jCutRange1Min

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutRange1Min = new JLabel("0")
protected

Label that displays the cut range 1 minimum for the currently displayed harvest.

◆ m_jCutRange2Amt

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutRange2Amt = new JLabel("0")
protected

Label that displays the cut range 2 amount for the currently displayed harvest.

◆ m_jCutRange2Max

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutRange2Max = new JLabel("0")
protected

Label that displays the cut range 2 maximum for the currently displayed harvest.

◆ m_jCutRange2Min

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutRange2Min = new JLabel("0")
protected

Label that displays the cut range 2 minimum for the currently displayed harvest.

◆ m_jCutRange3Amt

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutRange3Amt = new JLabel("0")
protected

Label that displays the cut range 3 amount for the currently displayed harvest.

◆ m_jCutRange3Max

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutRange3Max = new JLabel("0")
protected

Label that displays the cut range 3 maximum for the currently displayed harvest.

◆ m_jCutRange3Min

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutRange3Min = new JLabel("0")
protected

Label that displays the cut range 3 minimum for the currently displayed harvest.

◆ m_jCutRange4Amt

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutRange4Amt = new JLabel("0")
protected

Label that displays the cut range 4 amount for the currently displayed harvest.

◆ m_jCutRange4Max

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutRange4Max = new JLabel("0")
protected

Label that displays the cut range 4 maximum for the currently displayed harvest.

◆ m_jCutRange4Min

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutRange4Min = new JLabel("0")
protected

Label that displays the cut range 4 minimum for the currently displayed harvest.

◆ m_jCutTypeLabel

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jCutTypeLabel = new JLabel("N/A")
protected

Label that displays the cut type for the currently displayed harvest.

◆ m_jHarvestNumber

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jHarvestNumber = new JLabel("0")
protected

Label that displays the number of the current harvest event.

◆ m_jHarvestPriorities

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jHarvestPriorities = new JLabel("")
protected

Label that displays the priorities.

◆ m_jNumHarvestEvents

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jNumHarvestEvents = new JLabel("0")
protected

Label that displays number of harvest events currently defined.

◆ m_jSeedlingMortRate

DefaultListModel<String> sortie.gui.harvepplant.HarvestDisplayWindow.m_jSeedlingMortRate = new DefaultListModel<String>()
protected

For displaying harvest seed mortality rates.

◆ m_jSpeciesList

DefaultListModel<String> sortie.gui.harvepplant.HarvestDisplayWindow.m_jSpeciesList = new DefaultListModel<String>()
protected

List of species for the currently displayed harvest.

◆ m_jTimestepLabel

JLabel sortie.gui.harvepplant.HarvestDisplayWindow.m_jTimestepLabel = new JLabel("N/A")
protected

Label that displays the timestep for the currently displayed harvest.

◆ m_sHelpID

String sortie.gui.harvepplant.HarvestDisplayWindow.m_sHelpID = "windows.edit_harvest_window"
private

Help ID string.


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