org.orbisgis.legend.structure.stroke

Class PenStrokeLegend

java.lang.Object

org.orbisgis.legend.structure.stroke.PenStrokeLegend

All Implemented Interfaces:

LegendStructure, StrokeLegend

Direct Known Subclasses:

CategorizedDashesPSLegend, ConstantColorAndDashesPSLegend, RecodedDashesPSLegend

public class PenStrokeLegend
extends Object
implements StrokeLegend

A LegendStructure that gathers all the analysis that can be made inside a PenStroke. When a more accurate analysis can be recognized, it's really better to instanciate the corresponding specialization of this class.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
PenStrokeLegend()
PenStrokeLegend(PenStroke ps, NumericLegend width, LegendStructure fill, LegendStructure dash) Build a new, default, PenStrokeLegend instance.

Method Summary

Methods

Modifier and Type	Method and Description
LegendStructure	getDashLegend() Get the analysis made on the dash array.
LegendStructure	getFillAnalysis() Get the analysis made on the Fill used to draw the associated PenStroke.
NumericLegend	getLineWidthLegend() Gets the analysis made on the Width associated to this PenStroke.
Stroke	getStroke() Retrieve the PenStroke contained in this LegendStructure.
Uom	getStrokeUom() Gets the unit of measure of the associated Stroke.
protected void	setDashLegend(LegendStructure ls) Replace the analysis that has been made on the dash array.
void	setLineWidthLegend(NumericLegend param) Sets the analysis made on the Width associated to this PenStroke.
void	setStrokeUom(Uom u) Sets the unit of measure of the associated Stroke.

Methods inherited from class java.lang.Object

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

Constructor Detail

PenStrokeLegend

public PenStrokeLegend()

PenStrokeLegend

public PenStrokeLegend(PenStroke ps,
               NumericLegend width,
               LegendStructure fill,
               LegendStructure dash)

Build a new, default, PenStrokeLegend instance.

Parameters:

ps -

Method Detail

getStroke

public Stroke getStroke()

Retrieve the PenStroke contained in this LegendStructure.

Specified by:

getStroke in interface StrokeLegend

Returns:

getStrokeUom

public Uom getStrokeUom()

Gets the unit of measure of the associated Stroke.

Returns:

setStrokeUom

public void setStrokeUom(Uom u)

Sets the unit of measure of the associated Stroke.

Parameters:

u -

getDashLegend

public LegendStructure getDashLegend()

Get the analysis made on the dash array. Rememeber that this array can be null.

Returns:

setDashLegend

protected void setDashLegend(LegendStructure ls)

Replace the analysis that has been made on the dash array.

Parameters:

ls -

getFillAnalysis

public LegendStructure getFillAnalysis()

Get the analysis made on the Fill used to draw the associated PenStroke.

Returns:

getLineWidthLegend

public NumericLegend getLineWidthLegend()

Gets the analysis made on the Width associated to this PenStroke.

Returns:

setLineWidthLegend

public void setLineWidthLegend(NumericLegend param)

Sets the analysis made on the Width associated to this PenStroke.

Parameters:

param -