hep.aida.ref.plotter

Class PlotterRegion

java.lang.Object

hep.aida.ref.plotter.PlotterRegion

All Implemented Interfaces:

IPlotterRegion, StyleListener

public class PlotterRegion
extends java.lang.Object
implements IPlotterRegion, StyleListener

Implementation of PlotterRegion

Field Summary

Fields

Modifier and Type	Field and Description
int	ADD
int	OVERLAY
int	REPLACE
int	STACK
static java.lang.String	USE_EXACT_STYLE

Constructor Summary

Constructors

Constructor and Description
PlotterRegion(IPlotter plotter)
PlotterRegion(javax.swing.JPanel panel, IPlotter plotter)

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.Object thing, IPlotterStyle style, int mode)
void	add(java.lang.Object thing, IPlotterStyle style, int mode, java.lang.Object data)
void	add(java.lang.Object thing, IPlotterStyle userStyle, int mode, java.lang.Object data, java.lang.String options)
void	add(java.lang.Object thing, IPlotterStyle style, int mode, java.lang.String options)
void	add(java.lang.Object thing, IPlotterStyle style, java.lang.String options)
void	addToRegion(java.lang.Object thing, IPlotterStyle styleObj, java.lang.String options)
IPlotterStyle	applyDefaultStyles(java.lang.Object data, IPlotterStyle style)
IPlotterStyle	applyDefaultStyles(java.lang.Object data, IPlotterStyle style, java.lang.String options)
void	applyStyle(IPlotterStyle style) Set the style of a region and apply it to scene objects.
void	applyStyle(jas.hist.JASHistData jasHistData, IPlotterStyle style)
void	applyStyleAfterShow(jas.hist.JASHistData jasHistData, IPlotterStyle style)
void	applyStyleBeforeAdding(IPlotterStyle style, jas.hist.DataSource ds)
java.lang.String[]	availableParameterOptions(java.lang.String str) Get available options for a parameter.
java.lang.String[]	availableParameters() Get avaliable parameters.
void	clear() Clear the list of things to plot in the region.
void	clearRegion()
java.lang.String[]	getAllDataNames()
jas.hist.JASHistData	getDataForName(java.lang.String name)
int	getMode(java.lang.String options)
jas.hist.JASHist	getPlot()
IPlotterStyle	getStyleForName(java.lang.String name)
IPlotterStyle	getStyleForNumber(int num)
void	handleLabels(IPlotterStyle style)
IInfo	info() Return an IInfo object describing the info area.
IPlotterLayout	layout() To customize axis position,etc...
java.lang.String	parameterValue(java.lang.String str) Get value of a parameter.
void	plot(IBaseHistogram iBaseHistogram) Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
void	plot(IBaseHistogram iBaseHistogram, IPlotterStyle style) Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
void	plot(IBaseHistogram iBaseHistogram, IPlotterStyle style, java.lang.String options) Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
void	plot(IBaseHistogram iBaseHistogram, java.lang.String options) Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
void	plot(IDataPointSet iDataPointSet) Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
void	plot(IDataPointSet iDataPointSet, IPlotterStyle style) Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
void	plot(IDataPointSet iDataPointSet, IPlotterStyle style, java.lang.String options) Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
void	plot(IDataPointSet iDataPointSet, java.lang.String options) Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
void	plot(IFunction iFunction) Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
void	plot(IFunction iFunction, IPlotterStyle style) Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
void	plot(IFunction iFunction, IPlotterStyle style, java.lang.String options) Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
void	plot(IFunction iFunction, java.lang.String options) Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
void	plot(IPlottable plottable) Send a generic plottable object to the plotting region.
void	plot(IPlottable plottable, IPlotterStyle style) Send a generic plottable object to the plotting region.
void	plot(IPlottable plottable, IPlotterStyle style, java.lang.String options) Send a generic plottable object to the plotting region.
void	plot(IPlottable plottable, java.lang.String options) Send a generic plottable object to the plotting region.
void	refresh() Refresh the plotter region graphic.
void	refreshStyles()
void	remove(IBaseHistogram iBaseHistogram) Remove a data analysis object in the list of things to plot in the region.
void	remove(IDataPointSet iDataPointSet) Remove a data analysis object in the list of things to plot in the region.
void	remove(IFunction iFunction) Remove a data analysis object in the list of things to plot in the region.
void	remove(IPlottable plottable) Generic entry point to remove some plotted scene part.
void	removeDataSourceFromRegion(jas.hist.DataSource ds)
void	removeObjectFromRegion(java.lang.Object thing)
void	setDefaultMode(java.lang.String value)
IPlotterStyle	setDefaultsFromData(java.lang.Object thing, IPlotterStyle style)
void	setInfo(IInfo info)
void	setLayout(IPlotterLayout iPlotterLayout) To customize axis position,etc...
void	setParameter(java.lang.String str) Set various plotting paramters for the region.
void	setParameter(java.lang.String str, java.lang.String str1) Set various plotting paramters for the region.
void	setPlot(jas.hist.JASHist plot)
void	setStyle(IPlotterStyle style) Set the style of a region.
void	setTitle(java.lang.String title) Set the title of a region.
void	setXLimits() Set limit of an axis representation the region area.
void	setXLimits(double min) Set limit of an axis representation the region area.
void	setXLimits(double min, double max) Set limit of an axis representation the region area.
void	setYLimits() Set limit of an axis representation the region area.
void	setYLimits(double min) Set limit of an axis representation the region area.
void	setYLimits(double min, double max) Set limit of an axis representation the region area.
void	setYLimits(java.lang.String axisString)
void	setYLimits(java.lang.String axisString, double min)
void	setYLimits(java.lang.String axisString, double min, double max)
void	setZLimits() Set limit of an axis representation the region area.
void	setZLimits(double min) Set limit of an axis representation the region area.
void	setZLimits(double min, double max) Set limit of an axis representation the region area.
IPlotterStyle	style() Get the style of the region.
void	styleChanged(BaseStyle style)
java.lang.String	title() Get the title of the region.
double	xLimitMax() Get the max limit of x.
double	xLimitMin() Get the min limit of x.
double	yLimitMax() Get the max limit of y.
double	yLimitMax(java.lang.String axisString)
double	yLimitMin() Get the min limit of y.
double	yLimitMin(java.lang.String axisString)
double	zLimitMax() Get the max limit of z.
double	zLimitMin() Get the min limit of z.

Methods inherited from class java.lang.Object

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

Field Detail

REPLACE

public final int REPLACE

See Also:

Constant Field Values

OVERLAY

public final int OVERLAY

See Also:

Constant Field Values

ADD

public final int ADD

See Also:

Constant Field Values

STACK

public final int STACK

See Also:

Constant Field Values

USE_EXACT_STYLE

public static final java.lang.String USE_EXACT_STYLE

See Also:

Constant Field Values

Constructor Detail

PlotterRegion

public PlotterRegion(javax.swing.JPanel panel,
                     IPlotter plotter)

PlotterRegion

public PlotterRegion(IPlotter plotter)

Method Detail

getStyleForNumber

public IPlotterStyle getStyleForNumber(int num)

getStyleForName

public IPlotterStyle getStyleForName(java.lang.String name)

getDataForName

public jas.hist.JASHistData getDataForName(java.lang.String name)

getAllDataNames

public java.lang.String[] getAllDataNames()

availableParameterOptions

public java.lang.String[] availableParameterOptions(java.lang.String str)

Description copied from interface: IPlotterRegion

Get available options for a parameter.

Specified by:

availableParameterOptions in interface IPlotterRegion

Parameters:

str - Name of the parameter.

Returns:

options

availableParameters

public java.lang.String[] availableParameters()

Description copied from interface: IPlotterRegion

Get avaliable parameters.

Specified by:

availableParameters in interface IPlotterRegion

Returns:

parameters

setParameter

public void setParameter(java.lang.String str)

Description copied from interface: IPlotterRegion

Set various plotting paramters for the region. Activate the graphic layer and update the screen window(s) if needed.

Specified by:

setParameter in interface IPlotterRegion

setParameter

public void setParameter(java.lang.String str,
                         java.lang.String str1)

Description copied from interface: IPlotterRegion

Set various plotting paramters for the region. Activate the graphic layer and update the screen window(s) if needed.

Specified by:

setParameter in interface IPlotterRegion

parameterValue

public java.lang.String parameterValue(java.lang.String str)

Description copied from interface: IPlotterRegion

Get value of a parameter.

Specified by:

parameterValue in interface IPlotterRegion

Parameters:

str - Name of the parameter.

Returns:

the value.

styleChanged

public void styleChanged(BaseStyle style)

Specified by:

styleChanged in interface StyleListener

style

public IPlotterStyle style()

Description copied from interface: IPlotterRegion

Get the style of the region.

Specified by:

style in interface IPlotterRegion

setStyle

public void setStyle(IPlotterStyle style)

Description copied from interface: IPlotterRegion

Set the style of a region.

Specified by:

setStyle in interface IPlotterRegion

applyStyle

public void applyStyle(IPlotterStyle style)

Description copied from interface: IPlotterRegion

Set the style of a region and apply it to scene objects.

Specified by:

applyStyle in interface IPlotterRegion

setTitle

public void setTitle(java.lang.String title)

Description copied from interface: IPlotterRegion

Set the title of a region.

Specified by:

setTitle in interface IPlotterRegion

title

public java.lang.String title()

Description copied from interface: IPlotterRegion

Get the title of the region.

Specified by:

title in interface IPlotterRegion

setXLimits

public void setXLimits()
                throws java.lang.IllegalArgumentException

Description copied from interface: IPlotterRegion

Set limit of an axis representation the region area.

Specified by:

setXLimits in interface IPlotterRegion

Throws:

java.lang.IllegalArgumentException

setXLimits

public void setXLimits(double min)

Description copied from interface: IPlotterRegion

Set limit of an axis representation the region area.

Specified by:

setXLimits in interface IPlotterRegion

setXLimits

public void setXLimits(double min,
                       double max)
                throws java.lang.IllegalArgumentException

Description copied from interface: IPlotterRegion

Set limit of an axis representation the region area.

Specified by:

setXLimits in interface IPlotterRegion

Throws:

java.lang.IllegalArgumentException

setYLimits

public void setYLimits()
                throws java.lang.IllegalArgumentException

Description copied from interface: IPlotterRegion

Set limit of an axis representation the region area.

Specified by:

setYLimits in interface IPlotterRegion

Throws:

java.lang.IllegalArgumentException

setYLimits

public void setYLimits(double min)

Description copied from interface: IPlotterRegion

Set limit of an axis representation the region area.

Specified by:

setYLimits in interface IPlotterRegion

setYLimits

public void setYLimits(double min,
                       double max)
                throws java.lang.IllegalArgumentException

Description copied from interface: IPlotterRegion

Set limit of an axis representation the region area.

Specified by:

setYLimits in interface IPlotterRegion

Throws:

java.lang.IllegalArgumentException

setYLimits

public void setYLimits(java.lang.String axisString)

setYLimits

public void setYLimits(java.lang.String axisString,
                       double min)

setYLimits

public void setYLimits(java.lang.String axisString,
                       double min,
                       double max)
                throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

setZLimits

public void setZLimits()
                throws java.lang.IllegalArgumentException

Description copied from interface: IPlotterRegion

Set limit of an axis representation the region area.

Specified by:

setZLimits in interface IPlotterRegion

Throws:

java.lang.IllegalArgumentException

setZLimits

public void setZLimits(double min)

Description copied from interface: IPlotterRegion

Set limit of an axis representation the region area.

Specified by:

setZLimits in interface IPlotterRegion

setZLimits

public void setZLimits(double min,
                       double max)
                throws java.lang.IllegalArgumentException

Description copied from interface: IPlotterRegion

Set limit of an axis representation the region area.

Specified by:

setZLimits in interface IPlotterRegion

Throws:

java.lang.IllegalArgumentException

xLimitMin

public double xLimitMin()

Get the min limit of x.

Specified by:

xLimitMin in interface IPlotterRegion

xLimitMax

public double xLimitMax()

Get the max limit of x.

Specified by:

xLimitMax in interface IPlotterRegion

yLimitMin

public double yLimitMin()

Get the min limit of y.

Specified by:

yLimitMin in interface IPlotterRegion

yLimitMin

public double yLimitMin(java.lang.String axisString)

yLimitMax

public double yLimitMax()

Get the max limit of y.

Specified by:

yLimitMax in interface IPlotterRegion

yLimitMax

public double yLimitMax(java.lang.String axisString)

zLimitMin

public double zLimitMin()

Get the min limit of z.

Specified by:

zLimitMin in interface IPlotterRegion

zLimitMax

public double zLimitMax()

Get the max limit of z.

Specified by:

zLimitMax in interface IPlotterRegion

info

public IInfo info()

Description copied from interface: IPlotterRegion

Return an IInfo object describing the info area.

Specified by:

info in interface IPlotterRegion

setInfo

public void setInfo(IInfo info)

clear

public void clear()

Description copied from interface: IPlotterRegion

Clear the list of things to plot in the region. Clear the corresponding area on screen window(s).

Specified by:

clear in interface IPlotterRegion

plot

public void plot(IPlottable plottable)
          throws java.lang.IllegalArgumentException

Description copied from interface: IPlotterRegion

Send a generic plottable object to the plotting region. See IPlottable for more.

Specified by:

plot in interface IPlotterRegion

Throws:

java.lang.IllegalArgumentException

plot

public void plot(IPlottable plottable,
                 java.lang.String options)
          throws java.lang.IllegalArgumentException

Description copied from interface: IPlotterRegion

Send a generic plottable object to the plotting region. See IPlottable for more.

Specified by:

plot in interface IPlotterRegion

Throws:

java.lang.IllegalArgumentException

plot

public void plot(IPlottable plottable,
                 IPlotterStyle style)
          throws java.lang.IllegalArgumentException

Description copied from interface: IPlotterRegion

Send a generic plottable object to the plotting region. See IPlottable for more.

Specified by:

plot in interface IPlotterRegion

Throws:

java.lang.IllegalArgumentException

plot

public void plot(IPlottable plottable,
                 IPlotterStyle style,
                 java.lang.String options)
          throws java.lang.IllegalArgumentException

Description copied from interface: IPlotterRegion

Send a generic plottable object to the plotting region. See IPlottable for more.

Specified by:

plot in interface IPlotterRegion

Throws:

java.lang.IllegalArgumentException

plot

public void plot(IBaseHistogram iBaseHistogram)

Description copied from interface: IPlotterRegion

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Specified by:

plot in interface IPlotterRegion

plot

public void plot(IBaseHistogram iBaseHistogram,
                 IPlotterStyle style)

Description copied from interface: IPlotterRegion

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Specified by:

plot in interface IPlotterRegion

plot

public void plot(IBaseHistogram iBaseHistogram,
                 java.lang.String options)

Description copied from interface: IPlotterRegion

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Specified by:

plot in interface IPlotterRegion

plot

public void plot(IBaseHistogram iBaseHistogram,
                 IPlotterStyle style,
                 java.lang.String options)

Description copied from interface: IPlotterRegion

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Specified by:

plot in interface IPlotterRegion

plot

public void plot(IDataPointSet iDataPointSet)

Description copied from interface: IPlotterRegion

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Specified by:

plot in interface IPlotterRegion

plot

public void plot(IDataPointSet iDataPointSet,
                 IPlotterStyle style)

Description copied from interface: IPlotterRegion

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Specified by:

plot in interface IPlotterRegion

plot

public void plot(IDataPointSet iDataPointSet,
                 java.lang.String options)

Description copied from interface: IPlotterRegion

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Specified by:

plot in interface IPlotterRegion

plot

public void plot(IDataPointSet iDataPointSet,
                 IPlotterStyle style,
                 java.lang.String options)

Description copied from interface: IPlotterRegion

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Specified by:

plot in interface IPlotterRegion

plot

public void plot(IFunction iFunction)

Description copied from interface: IPlotterRegion

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Specified by:

plot in interface IPlotterRegion

plot

public void plot(IFunction iFunction,
                 IPlotterStyle style)

Description copied from interface: IPlotterRegion

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Specified by:

plot in interface IPlotterRegion

plot

public void plot(IFunction iFunction,
                 java.lang.String options)

Description copied from interface: IPlotterRegion

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Specified by:

plot in interface IPlotterRegion

plot

public void plot(IFunction iFunction,
                 IPlotterStyle style,
                 java.lang.String options)

Description copied from interface: IPlotterRegion

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Specified by:

plot in interface IPlotterRegion

remove

public void remove(IDataPointSet iDataPointSet)

Description copied from interface: IPlotterRegion

Remove a data analysis object in the list of things to plot in the region. Activate the graphic layer to update the screen window.

Specified by:

remove in interface IPlotterRegion

remove

public void remove(IFunction iFunction)

Description copied from interface: IPlotterRegion

Remove a data analysis object in the list of things to plot in the region. Activate the graphic layer to update the screen window.

Specified by:

remove in interface IPlotterRegion

remove

public void remove(IBaseHistogram iBaseHistogram)

Description copied from interface: IPlotterRegion

Remove a data analysis object in the list of things to plot in the region. Activate the graphic layer to update the screen window.

Specified by:

remove in interface IPlotterRegion

remove

public void remove(IPlottable plottable)
            throws java.lang.IllegalArgumentException

Description copied from interface: IPlotterRegion

Generic entry point to remove some plotted scene part.

Specified by:

remove in interface IPlotterRegion

Throws:

java.lang.IllegalArgumentException

setPlot

public void setPlot(jas.hist.JASHist plot)

getPlot

public jas.hist.JASHist getPlot()

setLayout

public void setLayout(IPlotterLayout iPlotterLayout)

Description copied from interface: IPlotterRegion

To customize axis position,etc... Change object position in the scence.

Specified by:

setLayout in interface IPlotterRegion

layout

public IPlotterLayout layout()

Description copied from interface: IPlotterRegion

To customize axis position,etc... Change object position in the scence.

Specified by:

layout in interface IPlotterRegion

add

public void add(java.lang.Object thing,
                IPlotterStyle style,
                int mode)

add

public void add(java.lang.Object thing,
                IPlotterStyle style,
                java.lang.String options)

add

public void add(java.lang.Object thing,
                IPlotterStyle style,
                int mode,
                java.lang.String options)

add

public void add(java.lang.Object thing,
                IPlotterStyle style,
                int mode,
                java.lang.Object data)

add

public void add(java.lang.Object thing,
                IPlotterStyle userStyle,
                int mode,
                java.lang.Object data,
                java.lang.String options)

setDefaultsFromData

public IPlotterStyle setDefaultsFromData(java.lang.Object thing,
                                         IPlotterStyle style)

handleLabels

public void handleLabels(IPlotterStyle style)

applyDefaultStyles

public IPlotterStyle applyDefaultStyles(java.lang.Object data,
                                        IPlotterStyle style)

applyDefaultStyles

public IPlotterStyle applyDefaultStyles(java.lang.Object data,
                                        IPlotterStyle style,
                                        java.lang.String options)

applyStyleBeforeAdding

public void applyStyleBeforeAdding(IPlotterStyle style,
                                   jas.hist.DataSource ds)

applyStyleAfterShow

public void applyStyleAfterShow(jas.hist.JASHistData jasHistData,
                                IPlotterStyle style)

applyStyle

public void applyStyle(jas.hist.JASHistData jasHistData,
                       IPlotterStyle style)

removeObjectFromRegion

public void removeObjectFromRegion(java.lang.Object thing)

removeDataSourceFromRegion

public void removeDataSourceFromRegion(jas.hist.DataSource ds)

refresh

public void refresh()

Description copied from interface: IPlotterRegion

Refresh the plotter region graphic. Can be used when a plotted data analysis object received new data.

Specified by:

refresh in interface IPlotterRegion

refreshStyles

public void refreshStyles()

clearRegion

public void clearRegion()

addToRegion

public void addToRegion(java.lang.Object thing,
                        IPlotterStyle styleObj,
                        java.lang.String options)

getMode

public int getMode(java.lang.String options)

setDefaultMode

public void setDefaultMode(java.lang.String value)