org.orbisgis.legend.structure.viewbox

Class ConstantViewBox

java.lang.Object

org.orbisgis.legend.structure.viewbox.DefaultViewBox

org.orbisgis.legend.structure.viewbox.ConstantViewBox

All Implemented Interfaces:

LegendStructure, ViewBoxLegend

public class ConstantViewBox
extends DefaultViewBox

Represents a ViewBox that does not change, whatever the processed data is.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
ConstantViewBox(RealLiteralLegend realLiteralLegend, boolean isHeight, ViewBox vb) As ViewBox instances can be defined with only one dimension parameter, we must be able to treat this case.
ConstantViewBox(RealLiteralLegend height, RealLiteralLegend width, ViewBox view) Build a new instance of ConstantViewBox.

Method Summary

Methods

Modifier and Type	Method and Description
Double	getHeight() Gets the height of the associated ViewBox.
Double	getWidth() Gets the width of the associated ViewBox.
void	setHeight(Double d) Set the Width of this ViewBox.
void	setWidth(Double d) Set the Width of this ViewBox.

Methods inherited from class org.orbisgis.legend.structure.viewbox.DefaultViewBox

getHeightLegend, getViewBox, getWidthLegend, setHeightLegend, setWidthLegend

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstantViewBox

public ConstantViewBox(RealLiteralLegend height,
               RealLiteralLegend width,
               ViewBox view)

Build a new instance of ConstantViewBox. We directly use RealLiteralLegend instances.

Parameters:

height -

width -

view -

ConstantViewBox

public ConstantViewBox(RealLiteralLegend realLiteralLegend,
               boolean isHeight,
               ViewBox vb)

As ViewBox instances can be defined with only one dimension parameter, we must be able to treat this case.

Parameters:

realLiteralLegend -

isHeight -

vb -

Method Detail

getWidth

public Double getWidth()

Gets the width of the associated ViewBox. As it is defined as a Literal, its value is constant whatever the input data are.

Returns:

A Double that can be null. A ViewBox can be defined with only one dimension set.

getHeight

public Double getHeight()

Gets the height of the associated ViewBox. As it is defined as a Literal, its value is constant whatever the input data are.

Returns:

A Double that can be null. A ViewBox can be defined with only one dimension set.

setHeight

public void setHeight(Double d)

Set the Width of this ViewBox.

Parameters:

d - A Double that can be null. A ViewBox can be defined with only one dimension set.

Throws:

IllegalArgumentException - If d is null and getHeight() returns null too. At least one of the dimensions must be not null.

setWidth

public void setWidth(Double d)

Set the Width of this ViewBox.

Parameters:

d - A Double that can be null. A ViewBox can be defined with only one dimension set.

Throws:

IllegalArgumentException - If d is null and getHeight() returns null too. At least one of the dimensions must be not null.