org.orbisgis.legend.structure.graphic

Class ConstantWKNLegend

java.lang.Object

org.orbisgis.legend.structure.graphic.MarkGraphicLegend

org.orbisgis.legend.structure.graphic.ConstantFormWKN

org.orbisgis.legend.structure.graphic.ConstantWKNLegend

All Implemented Interfaces:

LegendStructure

public class ConstantWKNLegend
extends ConstantFormWKN

A Markgraphic, defined with a well-known name, whose all parameters are constant, whatever the input data.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
ConstantWKNLegend(MarkGraphic mg)
ConstantWKNLegend(MarkGraphic mark, StringLiteralLegend wknLegend, ConstantViewBox viewBoxLegend, ConstantSolidFillLegend fillLegend, ConstantPenStrokeLegend strokeLegend) Build a new ConstantWKNLegend, associated to the given MarkGraphic.

Method Summary

Methods

Modifier and Type	Method and Description
Double	getViewBoxHeight() Get the height of the ViewBox used to define the size of the associated MarkGraphic.
Double	getViewBoxWidth() Get the width of the ViewBox used to define the size of the associated MarkGraphic.
void	setViewBoxHeight(Double d) Set the height of the ViewBox used to define the size of the associated MarkGraphic.
void	setViewBoxWidth(Double d) Set the width of the ViewBox used to define the size of the associated MarkGraphic.

Methods inherited from class org.orbisgis.legend.structure.graphic.ConstantFormWKN

getPenStroke, getSolidFill, getStrokeUom, getSymbolUom, getWellKnownName, setPenStroke, setStrokeUom, setSymbolUom, setWellKnownName

Methods inherited from class org.orbisgis.legend.structure.graphic.MarkGraphicLegend

getFillLegend, getMarkGraphic, getStrokeLegend, getViewBoxLegend, getWknLegend, setFillLegend, setMarkGraphic, setStrokeLegend, setViewBoxLegend, setWknLegend

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstantWKNLegend

public ConstantWKNLegend(MarkGraphic mg)

ConstantWKNLegend

public ConstantWKNLegend(MarkGraphic mark,
                 StringLiteralLegend wknLegend,
                 ConstantViewBox viewBoxLegend,
                 ConstantSolidFillLegend fillLegend,
                 ConstantPenStrokeLegend strokeLegend)

Build a new ConstantWKNLegend, associated to the given MarkGraphic.

Parameters:

mark -

wknLegend -

viewBoxLegend -

fillLegend -

strokeLegend -

Method Detail

getViewBoxHeight

public Double getViewBoxHeight()

Get the height of the ViewBox used to define the size of the associated MarkGraphic.

Returns:

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

getViewBoxWidth

public Double getViewBoxWidth()

Get the width of the ViewBox used to define the size of the associated MarkGraphic.

Returns:

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

setViewBoxHeight

public void setViewBoxHeight(Double d)

Set the height of the ViewBox used to define the size of the associated MarkGraphic.

Parameters:

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

setViewBoxWidth

public void setViewBoxWidth(Double d)

Set the width of the ViewBox used to define the size of the associated MarkGraphic.

Parameters:

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