org.orbisgis.legend.structure.viewbox

Class ViewBoxLegendFactory

java.lang.Object

org.orbisgis.legend.structure.viewbox.ViewBoxLegendFactory

public final class ViewBoxLegendFactory
extends Object

This factory can be used to quickly create legends representing known viewbox configurations.

Author:

Alexis Guéganno

Method Summary

Methods

Modifier and Type	Method and Description
static ConstantViewBox	createConstantViewBox(ViewBox vb) This utility method is used to create ConstantViewBox instances quickly.
static MonovariateProportionalViewBox	createMonovariateProportionalViewBox(ViewBox vb) This utility method is used to create MonovariateProportionalViewBox instances quickly.

Methods inherited from class java.lang.Object

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

Method Detail

createConstantViewBox

public static ConstantViewBox createConstantViewBox(ViewBox vb)

This utility method is used to create ConstantViewBox instances quickly. It does not test the given ViewBox much, so it's up to the caller to check it can be used to build a ConstantViewbox.

Parameters:

vb -

Returns:

Throws:

ClassCastException - If some argument of the ViewBox are not compatible with a ConstantViewBox.

IllegalArgumentException - if both height and width are null in the ViewBox.

createMonovariateProportionalViewBox

public static MonovariateProportionalViewBox createMonovariateProportionalViewBox(ViewBox vb)

This utility method is used to create MonovariateProportionalViewBox instances quickly. It does not test the given ViewBox much, so it's up to the caller to check it can be used to build a MonovariateProportionalViewBox.

Parameters:

vb -

Returns:

Throws:

ClassCastException - If some argument of the ViewBox are not compatible with a MonovariateProportionalViewBox.

IllegalArgumentException - if both height and width are null or both are not null in the ViewBox.