hep.aida.ref.plotter
Class BoxStyle

java.lang.Object
  hep.aida.ref.plotter.BaseStyle
      hep.aida.ref.plotter.BoxStyle

All Implemented Interfaces:

hep.aida.IBaseStyle, hep.aida.IBoxStyle, StyleListener

public class BoxStyle

extends BaseStyle

implements hep.aida.IBoxStyle

Author:

The FreeHEP team @ SLAC

Source Code:

BoxStyle.java

Field Summary

Fields inherited from interface hep.aida.IBoxStyle

BOTTOM_CENTER, BOTTOM_LEFT, BOTTOM_RIGHT, CENTER, MIDDLE_LEFT, MIDDLE_RIGHT, TOP_CENTER, TOP_LEFT, TOP_RIGHT

Constructor Summary

BoxStyle()

Method Summary

hep.aida.IFillStyle	backgroundStyle() Get the IFillStyle that controls the background of the scene part.
hep.aida.IBorderStyle	borderStyle() Get the border style of the scene part.
hep.aida.IFillStyle	foregroundStyle() Get the IFillStyle that controls the foreground of the scene part.
double	height()
protected void	initializeBaseStyle() Initialize the BaseStyle.
int	placement()
boolean	setBackgroundStyle(hep.aida.IFillStyle fillStyle)
boolean	setBorderStyle(hep.aida.IBorderStyle borderStyle)
boolean	setForegroundStyle(hep.aida.IFillStyle fillStyle)
boolean	setHeight(double height) Set and get the height and the width of the box.
boolean	setPlacement(int originDefinition) Get and specify the origin's definition.
boolean	setUnits(int unitsDefinition) Get and specify the definition of the units used for the size and origin's position.
boolean	setWidth(double width)
boolean	setX(double x) Set and get the x and y coordinate of the box's origin.
boolean	setY(double y)
int	units()
double	width()
double	x()
double	y()

Methods inherited from class hep.aida.ref.plotter.BaseStyle

addBaseStyle, addParameter, availableParameterOptions, availableParameters, child, children, deepestSetParameter, isParameterSet, isVisible, name, numberOfParameters, parameter, parameters, parameterValue, parent, reset, setName, setParameter, setParameter, setParameterDefault, setParent, setVisible, styleChanged, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface hep.aida.IBaseStyle

availableParameterOptions, availableParameters, child, children, isVisible, name, parameterValue, reset, setParameter, setParameter, setVisible, type

Constructor Detail

BoxStyle

public BoxStyle()

Method Detail

initializeBaseStyle

protected void initializeBaseStyle()

Description copied from class: BaseStyle

Initialize the BaseStyle. This method has to be overwritten by all Style that has to add parameters or internal BaseStyles.

Specified by:

initializeBaseStyle in class BaseStyle

backgroundStyle

public hep.aida.IFillStyle backgroundStyle()

Get the IFillStyle that controls the background of the scene part.

Specified by:

backgroundStyle in interface hep.aida.IBoxStyle

Returns:

The background IFillStyle.

setBackgroundStyle

public boolean setBackgroundStyle(hep.aida.IFillStyle fillStyle)

Specified by:

setBackgroundStyle in interface hep.aida.IBoxStyle

foregroundStyle

public hep.aida.IFillStyle foregroundStyle()

Get the IFillStyle that controls the foreground of the scene part. The foreground controls the color of what appears in front unless otherwise specified by other styles. (Is this really needed?)

Specified by:

foregroundStyle in interface hep.aida.IBoxStyle

Returns:

The foreground IFillStyle.

setForegroundStyle

public boolean setForegroundStyle(hep.aida.IFillStyle fillStyle)

Specified by:

setForegroundStyle in interface hep.aida.IBoxStyle

borderStyle

public hep.aida.IBorderStyle borderStyle()

Get the border style of the scene part.

Specified by:

borderStyle in interface hep.aida.IBoxStyle

Returns:

The border style.

setBorderStyle

public boolean setBorderStyle(hep.aida.IBorderStyle borderStyle)

Specified by:

setBorderStyle in interface hep.aida.IBoxStyle

setX

public boolean setX(double x)

Set and get the x and y coordinate of the box's origin.

Specified by:

setX in interface hep.aida.IBoxStyle

setY

public boolean setY(double y)

Specified by:

setY in interface hep.aida.IBoxStyle

x

public double x()

Specified by:

x in interface hep.aida.IBoxStyle

y

public double y()

Specified by:

y in interface hep.aida.IBoxStyle

setHeight

public boolean setHeight(double height)

Set and get the height and the width of the box.

Specified by:

setHeight in interface hep.aida.IBoxStyle

setWidth

public boolean setWidth(double width)

Specified by:

setWidth in interface hep.aida.IBoxStyle

height

public double height()

Specified by:

height in interface hep.aida.IBoxStyle

width

public double width()

Specified by:

width in interface hep.aida.IBoxStyle

setPlacement

public boolean setPlacement(int originDefinition)

Get and specify the origin's definition. The default is BOTTOM_LEFT.

Specified by:

setPlacement in interface hep.aida.IBoxStyle

placement

public int placement()

Specified by:

placement in interface hep.aida.IBoxStyle

setUnits

public boolean setUnits(int unitsDefinition)

Get and specify the definition of the units used for the size and origin's position. The default is PIXELS.

Specified by:

setUnits in interface hep.aida.IBoxStyle

units

public int units()

Specified by:

units in interface hep.aida.IBoxStyle