org.orbisgis.legend.thematic

Class ConstantStrokeArea

java.lang.Object

org.orbisgis.legend.thematic.SymbolizerLegend

org.orbisgis.legend.thematic.ConstantStrokeArea

All Implemented Interfaces:

Legend, LegendStructure, StrokeUom

Direct Known Subclasses:

UniqueSymbolArea

public abstract class ConstantStrokeArea
extends SymbolizerLegend

Represents an AreaSymbolizer of which the Stroke is a constant PenStroke instance, that can be recognized as a ConstantPenStrokeLegend.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
ConstantStrokeArea() Builds a new default ConstantStrokeArea from scratch.
ConstantStrokeArea(AreaSymbolizer symbolizer) Build a new ConstantStrokeArea directly from the given AreaSymbolizer.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDashArray() Gets the dash array used to draw the outer line of this AreaSymbolizer.
Color	getLineColor() Get the colour of the line that outlines the inner AreaSymbolizer.
Double	getLineWidth() Get the width of the line that outlines the inner AreaSymbolizer.
ConstantPenStroke	getStrokeLegend() Exposes the inner LegendStructure that represents the analysis made on the PenStroke.
Uom	getStrokeUom() Gets the unit of measure used to compute the form of the stroke.
Symbolizer	getSymbolizer() Get the symbolizer associated to this ConstantStrokeArea.
void	setDashArray(String s) Sets the dash array used to draw the outer line of this AreaSymbolizer.
void	setLineColor(Color col) Set the colour of the line that outlines the inner AreaSymbolizer.
void	setLineWidth(Double width) Set the width of the line that outlines the inner AreaSymbolizer.
void	setStrokeLegend(ConstantPenStroke cfl) Sets the legend describing the structure of the fill contained in the inner AreaSymbolizer.
void	setStrokeUom(Uom u) Sets the unit of measure used to compute the form of the stroke.

Methods inherited from class org.orbisgis.legend.thematic.SymbolizerLegend

getLegendTypeId, getMaxScale, getMinScale, getName, setMaxScale, setMinScale, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orbisgis.legend.Legend

getLegendTypeName

Constructor Detail

ConstantStrokeArea

public ConstantStrokeArea()

Builds a new default ConstantStrokeArea from scratch. It contains a default AreaSymbolizer, which is associated to a constant PenStroke.

ConstantStrokeArea

public ConstantStrokeArea(AreaSymbolizer symbolizer)

Build a new ConstantStrokeArea directly from the given AreaSymbolizer.

Parameters:

symbolizer -

Method Detail

getSymbolizer

public Symbolizer getSymbolizer()

Get the symbolizer associated to this ConstantStrokeArea.

Returns:

getStrokeLegend

public ConstantPenStroke getStrokeLegend()

Exposes the inner LegendStructure that represents the analysis made on the PenStroke.

Returns:

setStrokeLegend

public void setStrokeLegend(ConstantPenStroke cfl)

Sets the legend describing the structure of the fill contained in the inner AreaSymbolizer. This will update the fill of the AreaSymbolizer in question.

Parameters:

cfl -

getLineWidth

public Double getLineWidth()

Get the width of the line that outlines the inner AreaSymbolizer.

Returns:

setLineWidth

public void setLineWidth(Double width)

Set the width of the line that outlines the inner AreaSymbolizer.

Parameters:

width -

getLineColor

public Color getLineColor()

Get the colour of the line that outlines the inner AreaSymbolizer.

Returns:

setLineColor

public void setLineColor(Color col)

Set the colour of the line that outlines the inner AreaSymbolizer.

Parameters:

col -

getDashArray

public String getDashArray()

Gets the dash array used to draw the outer line of this AreaSymbolizer.

Returns:

setDashArray

public void setDashArray(String s)

Sets the dash array used to draw the outer line of this AreaSymbolizer.

Parameters:

s -

getStrokeUom

public Uom getStrokeUom()

Description copied from interface: StrokeUom

Gets the unit of measure used to compute the form of the stroke.

Returns:

setStrokeUom

public void setStrokeUom(Uom u)

Description copied from interface: StrokeUom

Sets the unit of measure used to compute the form of the stroke.