fr.cnes.genius.plots

Class GPlotPanel

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GPanel

fr.cnes.genius.plots.GPlotPanel

All Implemented Interfaces:

GDisplay, GListener, GReadWrite, MouseWheelListener, EventListener

public class GPlotPanel
extends GPanel
implements GListener, GReadWrite

Class to define a plot issued from an "column MADONA" formatted file.

Author:

goesterjf

Default Constraint(s):

Index	Class	Item	Constraint
0	GButton	searchButton	(null)
1	GLabel	fileLabel	(null)
2	GButton	addPlotPanelButton	(null)
3	GCheckBox	fnameInTitleCheckbox	(null)
4	GComboBoxWithLabel	xComboBox	4, 0, 0 => "newline , split 6" 4, 0, 1 => (null) 4, 1 => (null)
5	GComboBoxWithLabel	yComboBox	5, 0, 0 => (null) 5, 0, 1 => (null) 5, 1 => (null)
6	GCheckBoxWithIndicator	secondaryAxeCheckbox	6, 0, 0 => "split" 6, 0, 1 => (null) 6, 1 => "pushx , skip 1"
7	GColorChooser	colorButton	"growy , wmin 20"
8	GButton	addPlotButton	(null)
9	GButton	delPlotButton	(null)
10	GButton	clearPlotButton	(null)
11	GCheckBoxWithIndicator	showLeggendCheckbox	11, 0, 0 => "newline , pushy , split , aligny Bottom" 11, 0, 1 => (null) 11, 1 => "aligny Bottom"

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.genius.lowLevel.GPanel

GPanel.Panel, GPanel.ScrollBarVisibility

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

GComponent.CopyPasteOperation, GComponent.DisplayIndicatorStatus, GComponent.ItemType, GComponent.Operation

Field Summary

Fields inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GPlotPanel() Constructor by default
GPlotPanel(String prefix, String suffix, String description, int maxDetachedPlots, boolean searchButtonEnabled) Deprecated. This Constructor is no longer acceptable
GPlotPanel(String prefix, String suffix, String description, int maxDetachedPlots, boolean searchButtonEnabled, boolean searchButtonAdditionalEnabled) Deprecated. This Constructor is no longer acceptable
GPlotPanel(String prefix, String suffix, String description, int maxDetachedPlots, boolean searchButtonEnabled, GPlotDataReaderInterface dataReaderInterface) Constructor.
GPlotPanel(String prefix, String suffix, String description, int maxDetachedPlots, boolean searchButtonEnabled, GPlotDataReaderInterface dataReaderInterface, boolean searchButtonAdditionalEnabled) Constructor.
GPlotPanel(String widgetId, String prefix, String suffix, String description, int maxDetachedPlots, boolean searchButtonEnabled) Deprecated. This Constructor is no longer acceptable
GPlotPanel(String widgetId, String prefix, String suffix, String description, int maxDetachedPlots, boolean searchButtonEnabled, GPlotDataReaderInterface dataReaderInterface) Constructor.
GPlotPanel(String widgetId, String prefix, String suffix, String description, int maxDetachedPlots, boolean searchButtonEnabled, GPlotDataReaderInterface dataReaderInterface, boolean searchButtonAdditionalEnabled) Constructor.

Method Summary

Modifier and Type	Method and Description
void	after(GEvent e) Called after the event is processed.
void	after2(GEvent e) Deported for some checkstyle reason.
void	afterAdditionalElements(GEvent e) Called after the event is processed for GUI elements conected to additional files
void	before(GEvent e) Called before the event is processed.
void	clearSelectedDispFiles() Clear dispersed file list
void	display() Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.
void	generic() Abstract generic function that need to be implemented by the descendants.
List<GDetachedPlotPanel>	getDetachedPlotList() Get the detached plot list
GFreeChartXY	getGFreeChartXY() getter to retrieve GFreeChartXY
GFreeChartXY	getGFreeChartXYRel() getter to retrieve relative GFreeChartXY
GFreeChartXY.GFreeChartXYItem	getItemCoordinates() Method to get the coordinates of a drawn point.
GFreeChartXY.GFreeChartXYItem	getPlaneCoordinates(boolean isSecondaryAxis) Method to get the coordinates of the click regardless where the click is.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
boolean	isDisplayingSerie() checks the existence of a displaying chart
boolean	isInteractive() Method to know if the interactive mode is activated
void	read() Implementaion of the routines that allow the component to be loaded from a configuration file.
void	setCalculatorMode(boolean flag) Set the enable status of the Calculator mode.
void	setDatasetPlotProperties(String datasetId, Shape shape, String tooltipColumnName) Set the plot properties for a certain dataset.
protected void	setDefaultConstraints() set the defaults constraints
void	setSelectedDispFiles(File[] selectedFilesTab) Set the selected dispersed files.
void	setSelectedFile(File selectedFile) Set the selected file.
protected void	setSelectedFileAnnex(File selectedFile) Method called detached plot panel is called.
protected void	updateButtons() Update the status of the buttons.
void	updateWithNewVar(List<ColumnInfo> info, List<Double[]> newData) Private method to update data thanks to a new variable.
void	write() Implementaion of the routines that allow the component to be saved to a configuration file.

Methods inherited from class fr.cnes.genius.lowLevel.GPanel

clearConstraint, getClassConstraint, getComponent, getHorizontalScroll, getInnerDescendantClassConstraint, getJPanel, getJScrollPane, getLayoutConstraints, getStringClassConstraint, getVerticalScroll, mainClear, mainDisplay, processMouseWheelEvent, put, setClassConstraint, setColumnConstraints, setConstraint, setHorizontalScroll, setInnerDescendantClassConstraint, setLayoutConstraints, setMargins, setPanelConstraints, setPreferredSize, setRowConstraints, setUnitIncrement, setVerticalScroll, unput

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, setBusyCursor, setCommentInConfigFile, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setEnabled, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidgetId, setWidth, setWindowBusyCursor, updateIsModifiedIndicator, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GPlotPanel

public GPlotPanel()

Constructor by default

GPlotPanel

@Deprecated
public GPlotPanel(String prefix,
                              String suffix,
                              String description,
                              int maxDetachedPlots,
                              boolean searchButtonEnabled)

Deprecated. This Constructor is no longer acceptable

Constructor. The widget identifier will be assigned automatically.

Parameters:

prefix - file name prefix (could be "" or even null)

suffix - file name suffix (could be "" or even null)

description - description of this kind of files.

maxDetachedPlots - maximum number of detached plot windows. If greater than 0 a "+" button is displayed in order to allow to display other plots in detached panels.

searchButtonEnabled - true if the file search/open button is enabled, false otherwise.

GPlotPanel

@Deprecated
public GPlotPanel(String widgetId,
                              String prefix,
                              String suffix,
                              String description,
                              int maxDetachedPlots,
                              boolean searchButtonEnabled)

Deprecated. This Constructor is no longer acceptable

Constructor.

Parameters:

widgetId - widget identifier.

prefix - file name prefix (could be "" or even null)

suffix - file name suffix (could be "" or even null)

description - description of this kind of files.

maxDetachedPlots - maximum number of detached plot windows. If greater than 0 a "+" button is displayed in order to allow to display other plots in detached panels.

searchButtonEnabled - true if the file search/open button is enabled, false otherwise.

GPlotPanel

public GPlotPanel(String prefix,
                  String suffix,
                  String description,
                  int maxDetachedPlots,
                  boolean searchButtonEnabled,
                  GPlotDataReaderInterface dataReaderInterface,
                  boolean searchButtonAdditionalEnabled)

Constructor. The widget identifier will be assigned automatically.

Parameters:

prefix - file name prefix (could be "" or even null)

suffix - file name suffix (could be "" or even null)

description - description of this kind of files.

maxDetachedPlots - maximum number of detached plot windows. If greater than 0 a "+" button is displayed in order to allow to display other plots in detached panels.

dataReaderInterface - interface object that shall be used to read the plot data from the file.

searchButtonEnabled - true if the file search/open button is enabled, false otherwise.

searchButtonAdditionalEnabled - true if the search/open additional files button is enabled, false otherwise.

GPlotPanel

public GPlotPanel(String prefix,
                  String suffix,
                  String description,
                  int maxDetachedPlots,
                  boolean searchButtonEnabled,
                  GPlotDataReaderInterface dataReaderInterface)

Constructor. The widget identifier will be assigned automatically.

Parameters:

prefix - file name prefix (could be "" or even null)

suffix - file name suffix (could be "" or even null)

description - description of this kind of files.

maxDetachedPlots - maximum number of detached plot windows. If greater than 0 a "+" button is displayed in order to allow to display other plots in detached panels.

dataReaderInterface - interface object that shall be used to read the plot data from the file.

searchButtonEnabled - true if the file search/open button is enabled, false otherwise.

GPlotPanel

public GPlotPanel(String widgetId,
                  String prefix,
                  String suffix,
                  String description,
                  int maxDetachedPlots,
                  boolean searchButtonEnabled,
                  GPlotDataReaderInterface dataReaderInterface)

Constructor.

Parameters:

widgetId - widget identifier.

prefix - file name prefix (could be "" or even null)

suffix - file name suffix (could be "" or even null)

description - description of this kind of files.

maxDetachedPlots - maximum number of detached plot windows. If greater than 0 a "+" button is displayed in order to allow to display other plots in detached panels.

dataReaderInterface - interface object that shall be used to read the plot data from the file.

searchButtonEnabled - true if the file search/open button is enabled, false otherwise.

GPlotPanel

@Deprecated
public GPlotPanel(String prefix,
                              String suffix,
                              String description,
                              int maxDetachedPlots,
                              boolean searchButtonEnabled,
                              boolean searchButtonAdditionalEnabled)

Deprecated. This Constructor is no longer acceptable

Constructor.

Parameters:

prefix - file name prefix (could be "" or even null)

suffix - file name suffix (could be "" or even null)

description - description of this kind of files.

maxDetachedPlots - maximum number of detached plot windows. If greater than 0 a "+" button is displayed in order to allow to display other plots in detached panels.

searchButtonEnabled - true if the file search/open button is enabled, false otherwise.

searchButtonAdditionalEnabled - true if the search/open additional files button is enabled, false otherwise.

GPlotPanel

public GPlotPanel(String widgetId,
                  String prefix,
                  String suffix,
                  String description,
                  int maxDetachedPlots,
                  boolean searchButtonEnabled,
                  GPlotDataReaderInterface dataReaderInterface,
                  boolean searchButtonAdditionalEnabled)

Constructor.

Parameters:

widgetId - widget identifier.

prefix - file name prefix (could be "" or even null)

suffix - file name suffix (could be "" or even null)

description - description of this kind of files.

maxDetachedPlots - maximum number of detached plot windows. If greater than 0 a "+" button is displayed in order to allow to display other plots in detached panels.

dataReaderInterface - interface object that shall be used to read the plot data from the file.

searchButtonEnabled - true if the file search/open button is enabled, false otherwise.

searchButtonAdditionalEnabled - true if the search/open additional files button is enabled, false otherwise.

Method Detail

setDefaultConstraints

protected void setDefaultConstraints()

Description copied from class: GPanel

set the defaults constraints

Overrides:

setDefaultConstraints in class GPanel

getDetachedPlotList

public List<GDetachedPlotPanel> getDetachedPlotList()

Get the detached plot list

Returns:

the detached plot list

after

public void after(GEvent e)
           throws GException

Called after the event is processed.

Specified by:

after in interface GListener

Parameters:

e - processed event.

Throws:

GException - in case there is a problem managing the event.

after2

public void after2(GEvent e)
            throws GException

Deported for some checkstyle reason.

Parameters:

e - event

Throws:

GException - exception

afterAdditionalElements

public void afterAdditionalElements(GEvent e)
                             throws GException

Called after the event is processed for GUI elements conected to additional files

Parameters:

e - processed event

Throws:

GException - in case there is a problem managing the event

before

public void before(GEvent e)
            throws GException

Called before the event is processed.

Specified by:

before in interface GListener

Parameters:

e - event to processed.

Throws:

GException - in case there is a problem managing the event.

display

public void display()
             throws GException

Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.

Specified by:

display in interface GDisplay

Throws:

GException - in case of problem while reading the value from file.

generic

public void generic()
             throws GException

Abstract generic function that need to be implemented by the descendants.

Specified by:

generic in class GPanel

Throws:

GException - in case of problem.

setSelectedFileAnnex

protected void setSelectedFileAnnex(File selectedFile)
                             throws GPlotDataReaderException

Method called detached plot panel is called. Selects a file and gets all of its data at the same time

Parameters:

selectedFile - the selected file

Throws:

GPlotDataReaderException - thrown if failed

updateButtons

protected void updateButtons()

Update the status of the buttons.

setSelectedFile

public void setSelectedFile(File selectedFile)
                     throws GPlotDataReaderException

Set the selected file.

Parameters:

selectedFile - the selected file.

Throws:

GPlotDataReaderException - in case of problem loading the selected file.

setCalculatorMode

public void setCalculatorMode(boolean flag)

Set the enable status of the Calculator mode.

Parameters:

flag - new enable status.

setSelectedDispFiles

public void setSelectedDispFiles(File[] selectedFilesTab)
                          throws GPlotDataReaderException

Set the selected dispersed files.

Parameters:

selectedFilesTab - the selected files array.

Throws:

GPlotDataReaderException - in case of problem loading the selected file.

clearSelectedDispFiles

public void clearSelectedDispFiles()

Clear dispersed file list

getSubComponent

public GComponent getSubComponent(int position)
                           throws GComponentException

Gets the subcomponent occupying the position defined by position.

Overrides:

getSubComponent in class GComponent

Parameters:

position - position of the requested component.

Returns:

the subcomponent occupying the position defined by position.

Throws:

GComponentException - in case the position argument is invalid.

getPlaneCoordinates

public GFreeChartXY.GFreeChartXYItem getPlaneCoordinates(boolean isSecondaryAxis)

Method to get the coordinates of the click regardless where the click is.

Parameters:

isSecondaryAxis - We consider secondary axis units

Returns:

coordinates of the point

isDisplayingSerie

public boolean isDisplayingSerie()

checks the existence of a displaying chart

Returns:

true if a serie exists

getGFreeChartXYRel

public GFreeChartXY getGFreeChartXYRel()

getter to retrieve relative GFreeChartXY

Returns:

true if a serie exists

getGFreeChartXY

public GFreeChartXY getGFreeChartXY()

getter to retrieve GFreeChartXY

Returns:

true if a serie exists

getItemCoordinates

public GFreeChartXY.GFreeChartXYItem getItemCoordinates()

Method to get the coordinates of a drawn point.

Returns:

coordinates of the point

isInteractive

public boolean isInteractive()

Method to know if the interactive mode is activated

Returns:

true if the mode is activated

setDatasetPlotProperties

public void setDatasetPlotProperties(String datasetId,
                                     Shape shape,
                                     String tooltipColumnName)

Set the plot properties for a certain dataset.

Parameters:

datasetId - dataset identifier.

shape - the shape for the symbol.

tooltipColumnName - name of the column containing the tooltips.

read

public void read()
          throws GException

Description copied from interface: GReadWrite

Implementaion of the routines that allow the component to be loaded from a configuration file.

Specified by:

read in interface GReadWrite

Throws:

GException - in case of problem while reading the value from file.

write

public void write()
           throws GException

Description copied from interface: GReadWrite

Implementaion of the routines that allow the component to be saved to a configuration file.

Specified by:

write in interface GReadWrite

Throws:

GException - in case of problem while writing the value to file.

updateWithNewVar

public void updateWithNewVar(List<ColumnInfo> info,
                             List<Double[]> newData)

Private method to update data thanks to a new variable.

Parameters:

info - new variable information

newData - new variable data