hep.aida

Interface IBaseStyle

All Known Subinterfaces:

IAxisStyle, IBorderStyle, IBoxStyle, IBrushStyle, IDataStyle, IFillStyle, IGridStyle, IInfoStyle, ILegendBoxStyle, ILineStyle, IMarkerStyle, IPlotterStyle, IRotatableBoxStyle, IStatisticsBoxStyle, ITextStyle, ITickStyle, ITitleStyle

All Known Implementing Classes:

AxisStyle, BaseStyle, BorderStyle, BoxStyle, DataPointSetPlotterStyle, DataStyle, FillStyle, GridStyle, InfoStyle, LegendBoxStyle, LineStyle, MarkerStyle, PlotterStyle, StatisticsBoxStyle, TextStyle, TitleStyle

public interface IBaseStyle

Superclass for all styles in AIDA Plotting package. All styles can be reset to their original values at construction time. In the case of styles which 'contain' other styles (like IStyle or IAxisStyle), reset() calls reset() on the aggregated styles too. All styles are hierarchical, so the plotter's current style is overridden by the region's current style, which is overridden by any 'associated' style which is overwritten by any style passed in explicitly at plotting time. Parameters and options which have been explicitly set to non-default (or default!) values are 'sticky'. For example, if a style has the default 'red' and this has been set explicitly to 'blue' at the Plotter level, then it will override the default 'red' at the Region level. IF the user explicitly sets the region to 'green' (or 'red'!) then it will not be overridden by the 'parent' style.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	availableParameterOptions(java.lang.String paramName) Get list of the available options for a given parameter (implementation-dependent).
java.lang.String[]	availableParameters() Get list of the available parameters (implementation-dependent)
IBaseStyle	child(java.lang.String name)
IBaseStyle[]	children()
boolean	isVisible() Get visibility of the data.
java.lang.String	name()
java.lang.String	parameterValue(java.lang.String parameter) Get value of a parameter.
void	reset() Return to original (construction time) state.
boolean	setParameter(java.lang.String paramName) Set a parameter.
boolean	setParameter(java.lang.String paramName, java.lang.String options) Set a parameter.
boolean	setVisible(boolean visible) Set visibility of the data.
java.lang.Class	type()

Method Detail

reset

void reset()

Return to original (construction time) state. Explicitly set parameters will be set to defaults and may be overridden

setParameter

boolean setParameter(java.lang.String paramName)

Set a parameter.

Parameters:

paramName - Name of the parameter.

Returns:

false if parameter (or its options) unknown or invalid.

setParameter

boolean setParameter(java.lang.String paramName,
                     java.lang.String options)

Set a parameter.

Parameters:

paramName - Name of the parameter.

options - string of options.

Returns:

false if parameter (or its options) unknown or invalid.

parameterValue

java.lang.String parameterValue(java.lang.String parameter)

Get value of a parameter.

Parameters:

paramName - Name of the parameter.

Returns:

the value.

availableParameters

java.lang.String[] availableParameters()

Get list of the available parameters (implementation-dependent)

availableParameterOptions

java.lang.String[] availableParameterOptions(java.lang.String paramName)

Get list of the available options for a given parameter (implementation-dependent).

name

java.lang.String name()

Returns:

The name of the style.

type

java.lang.Class type()

Returns:

The type of the style.

child

IBaseStyle child(java.lang.String name)

Returns:

A sub style, knowing its name.

children

IBaseStyle[] children()

Returns:

The array of sub styles.

setVisible

boolean setVisible(boolean visible)

Set visibility of the data.

isVisible

boolean isVisible()

Get visibility of the data. return The visibility of the data.