org.orbisgis.legend.structure.graphic

Class ConstantFormWKN

java.lang.Object

org.orbisgis.legend.structure.graphic.MarkGraphicLegend

org.orbisgis.legend.structure.graphic.ConstantFormWKN

All Implemented Interfaces:

LegendStructure

Direct Known Subclasses:

ConstantWKNLegend, ProportionalWKNLegend

public abstract class ConstantFormWKN
extends MarkGraphicLegend

This abstract class is a common LegendStructure description for all the MarkGraphic instances where the only varying parameters are the dimensions of the associated ViewBox. That means the Fill, the Stroke and the StringParameter containing the well-known name definition are constants.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
ConstantFormWKN() Builds a new default ConstantFormWKN associated to a default MarkGraphic.
ConstantFormWKN(MarkGraphic mark, LegendStructure viewBoxLegend) Builds a new ConstantFormWKN from the given mark and viewBoxLegend.
ConstantFormWKN(MarkGraphic mark, StringLiteralLegend wknLegend, LegendStructure viewBoxLegend, ConstantSolidFill fillLegend, ConstantPenStroke strokeLegend) Build a default LegendStructure that describes a MarkGraphic instance.

Method Summary

Methods

Modifier and Type	Method and Description
ConstantPenStroke	getPenStroke() Retrieves the ConstantPenStroke that is associated to this mark graphic.
ConstantSolidFill	getSolidFill() Retrieves the ConstantSolidFill that is associated to this mark graphic.
Uom	getStrokeUom() Gets the unit of measure used to draw the associated Stroke.
Uom	getSymbolUom() Gets the unit of measure used to size the associated Stroke.
String	getWellKnownName() Gets the well-known name that describes the shape of the inner MarkGraphic.
void	setPenStroke(ConstantPenStroke cps) Sets the ConstantPenStroke that is associated to this mark graphic.
void	setStrokeUom(Uom u) Sets the unit of measure used to draw the associated Stroke.
void	setSymbolUom(Uom u) Sets the unit of measure used to size the associated Stroke.
void	setWellKnownName(String string) Sets the well-known name that describes the shape of the inner MarkGraphic.

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

ConstantFormWKN

public ConstantFormWKN(MarkGraphic mark,
               LegendStructure viewBoxLegend)

Builds a new ConstantFormWKN from the given mark and viewBoxLegend. We consider that the varying parameters are all gathered in the mark's view box. All the other parameters are considered to be constant. It's up to you to be sure it is.

Parameters:

mark -

viewBoxLegend -

ConstantFormWKN

public ConstantFormWKN()

Builds a new default ConstantFormWKN associated to a default MarkGraphic.

ConstantFormWKN

public ConstantFormWKN(MarkGraphic mark,
               StringLiteralLegend wknLegend,
               LegendStructure viewBoxLegend,
               ConstantSolidFill fillLegend,
               ConstantPenStroke strokeLegend)

Build a default LegendStructure that describes a MarkGraphic instance.

Parameters:

mark -

wknLegend -

viewBoxLegend -

fillLegend -

strokeLegend -

Method Detail

getSolidFill

public ConstantSolidFill getSolidFill()

Retrieves the ConstantSolidFill that is associated to this mark graphic. It can be used to configure safely the underlying MarkGraphic without threatening the found analysis.

Returns:

getPenStroke

public ConstantPenStroke getPenStroke()

Retrieves the ConstantPenStroke that is associated to this mark graphic. It can be used to configure safely the underlying PenStroke without threatening the found analysis.

Returns:

setPenStroke

public void setPenStroke(ConstantPenStroke cps)

Sets the ConstantPenStroke that is associated to this mark graphic.

Parameters:

cps -

getWellKnownName

public String getWellKnownName()

Gets the well-known name that describes the shape of the inner MarkGraphic.

Returns:

setWellKnownName

public void setWellKnownName(String string)

Sets the well-known name that describes the shape of the inner MarkGraphic.

Parameters:

string - The new WellKnownName.

getStrokeUom

public Uom getStrokeUom()

Gets the unit of measure used to draw the associated Stroke.

Returns:

setStrokeUom

public void setStrokeUom(Uom u)

Sets the unit of measure used to draw the associated Stroke.

Parameters:

u -

getSymbolUom

public Uom getSymbolUom()

Gets the unit of measure used to size the associated Stroke.

Returns:

setSymbolUom

public void setSymbolUom(Uom u)

Sets the unit of measure used to size the associated Stroke.

Parameters:

u -