org.orbisgis.legend.structure.viewbox

Class DefaultViewBox

java.lang.Object

org.orbisgis.legend.structure.viewbox.DefaultViewBox

All Implemented Interfaces:

LegendStructure, ViewBoxLegend

Direct Known Subclasses:

BivariateProportionalViewBox, ConstantViewBox, MonovariateLinearVB, MonovariateProportionalViewBox

public class DefaultViewBox
extends Object
implements ViewBoxLegend

ViewBox instances can all be described as being associated to two random NumericLegend instances. Consequently, this class is the base legend description of ViewBox, and can be reused freely for more accurate descriptions.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
DefaultViewBox() Builds a new DefaultViewBox with 3 as height and width.
DefaultViewBox(NumericLegend nl, boolean isHeight, ViewBox view) Build a new DefaultViewBox.
DefaultViewBox(NumericLegend height, NumericLegend width, ViewBox view) Build a new DefaultViewBox with the given parameters, using directly the two needed NumericLegend instances.

Method Summary

Methods

Modifier and Type	Method and Description
NumericLegend	getHeightLegend() Gets the LegendStructure associated to the height of this ViewBox.
ViewBox	getViewBox() Gets the ViewBox associated to this LegendStructure.
NumericLegend	getWidthLegend() Gets the LegendStructure associated to the width of this ViewBox.
void	setHeightLegend(NumericLegend nl) Gets the LegendStructure associated to the height of this ViewBox.
void	setWidthLegend(NumericLegend nl) Gets the LegendStructure associated to the width of this ViewBox.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultViewBox

public DefaultViewBox()

Builds a new DefaultViewBox with 3 as height and width.

DefaultViewBox

public DefaultViewBox(NumericLegend height,
              NumericLegend width,
              ViewBox view)

Build a new DefaultViewBox with the given parameters, using directly the two needed NumericLegend instances.

Parameters:

height -

width -

view -

DefaultViewBox

public DefaultViewBox(NumericLegend nl,
              boolean isHeight,
              ViewBox view)

Build a new DefaultViewBox. We have just one NumericLegend here. Its meaning is dependant on isHeight. If isHeight, nl is supposed to be the description of the height of view. If not , it is the description of the width.

Parameters:

nl -

isHeight -

view -

Method Detail

getViewBox

public ViewBox getViewBox()

Gets the ViewBox associated to this LegendStructure.

Specified by:

getViewBox in interface ViewBoxLegend

Returns:

getHeightLegend

public NumericLegend getHeightLegend()

Gets the LegendStructure associated to the height of this ViewBox.

Returns:

getWidthLegend

public NumericLegend getWidthLegend()

Gets the LegendStructure associated to the width of this ViewBox.

Returns:

setHeightLegend

public void setHeightLegend(NumericLegend nl)

Gets the LegendStructure associated to the height of this ViewBox.

setWidthLegend

public void setWidthLegend(NumericLegend nl)

Gets the LegendStructure associated to the width of this ViewBox.

Parameters:

nl -