hep.aida
Interface IBoxStyle

All Superinterfaces:

IBaseStyle

public interface IBoxStyle

extends IBaseStyle

Generic style for any "scene part" on the plot. Scene parts are independent plottable objects like statistics and legend box, data area, title area etc etc.

Author:

The AIDA team (http://aida.freehep.org/)

Field Summary

static int	BOTTOM_CENTER Constants specifying position of the box's origin.
static int	BOTTOM_LEFT Constants specifying position of the box's origin.
static int	BOTTOM_RIGHT Constants specifying position of the box's origin.
static int	CENTER Constants specifying position of the box's origin.
static int	MIDDLE_LEFT Constants specifying position of the box's origin.
static int	MIDDLE_RIGHT Constants specifying position of the box's origin.
static int	TOP_CENTER Constants specifying position of the box's origin.
static int	TOP_LEFT Constants specifying position of the box's origin.
static int	TOP_RIGHT Constants specifying position of the box's origin.

Method Summary

IFillStyle	backgroundStyle() Get the IFillStyle that controls the background of the scene part.
IBorderStyle	borderStyle() Get the border style of the scene part.
IFillStyle	foregroundStyle() Get the IFillStyle that controls the foreground of the scene part.
double	height()
int	placement()
boolean	setBackgroundStyle(IFillStyle fillStyle)
boolean	setBorderStyle(IBorderStyle borderStyle)
boolean	setForegroundStyle(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 interface hep.aida.IBaseStyle

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

Field Detail

BOTTOM_LEFT

public static final int BOTTOM_LEFT

Constants specifying position of the box's origin.

See Also:

Constant Field Values

MIDDLE_LEFT

public static final int MIDDLE_LEFT

Constants specifying position of the box's origin.

See Also:

Constant Field Values

TOP_LEFT

public static final int TOP_LEFT

Constants specifying position of the box's origin.

See Also:

Constant Field Values

TOP_CENTER

public static final int TOP_CENTER

Constants specifying position of the box's origin.

See Also:

Constant Field Values

TOP_RIGHT

public static final int TOP_RIGHT

Constants specifying position of the box's origin.

See Also:

Constant Field Values

MIDDLE_RIGHT

public static final int MIDDLE_RIGHT

Constants specifying position of the box's origin.

See Also:

Constant Field Values

BOTTOM_RIGHT

public static final int BOTTOM_RIGHT

Constants specifying position of the box's origin.

See Also:

Constant Field Values

BOTTOM_CENTER

public static final int BOTTOM_CENTER

Constants specifying position of the box's origin.

See Also:

Constant Field Values

CENTER

public static final int CENTER

Constants specifying position of the box's origin.

See Also:

Constant Field Values

Method Detail

backgroundStyle

public IFillStyle backgroundStyle()

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

Returns:

The background IFillStyle.

setBackgroundStyle

public boolean setBackgroundStyle(IFillStyle fillStyle)

foregroundStyle

public 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?)

Returns:

The foreground IFillStyle.

setForegroundStyle

public boolean setForegroundStyle(IFillStyle fillStyle)

borderStyle

public IBorderStyle borderStyle()

Get the border style of the scene part.

Returns:

The border style.

setBorderStyle

public boolean setBorderStyle(IBorderStyle borderStyle)

setX

public boolean setX(double x)

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

setY

public boolean setY(double y)

x

public double x()

y

public double y()

setHeight

public boolean setHeight(double height)

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

setWidth

public boolean setWidth(double width)

height

public double height()

width

public double width()

setPlacement

public boolean setPlacement(int originDefinition)

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

placement

public int placement()

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.

units

public int units()