org.orbisgis.legend.structure.stroke

Class ConstantColorAndDashesPSLegend

java.lang.Object

org.orbisgis.legend.structure.stroke.PenStrokeLegend

org.orbisgis.legend.structure.stroke.ConstantColorAndDashesPSLegend

All Implemented Interfaces:

LegendStructure, StrokeLegend

Direct Known Subclasses:

ConstantPenStrokeLegend, ProportionalStrokeLegend

public abstract class ConstantColorAndDashesPSLegend
extends PenStrokeLegend

Represents a PenStroke where the Color and the dash pattern are constant.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
ConstantColorAndDashesPSLegend()
ConstantColorAndDashesPSLegend(PenStroke ps, NumericLegend width, LegendStructure fill, LegendStructure dash) Build an instance of ConstantColorAndDashesPSLegend using the given parameters.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDashArray() Get the String that represent the dash pattern for the associated PenStroke.
Color	getLineColor() Gets the Color of the associated PenStroke.
double	getLineOpacity() Gets the Color of the associated PenStroke.
void	setDashArray(String str) Set the String that represent the dash pattern for the associated PenStroke.
void	setLineColor(Color col) Sets the Color of the associated PenStroke.
void	setLineOpacity(double opacity) Sets the Color of the associated PenStroke.

Methods inherited from class org.orbisgis.legend.structure.stroke.PenStrokeLegend

getDashLegend, getFillAnalysis, getLineWidthLegend, getStroke, getStrokeUom, setDashLegend, setLineWidthLegend, setStrokeUom

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstantColorAndDashesPSLegend

public ConstantColorAndDashesPSLegend()

ConstantColorAndDashesPSLegend

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

Build an instance of ConstantColorAndDashesPSLegend using the given parameters.

Parameters:

ps -

width -

fill -

dash -

Method Detail

getLineColor

public Color getLineColor()

Gets the Color of the associated PenStroke.

Returns:

setLineColor

public void setLineColor(Color col)

Sets the Color of the associated PenStroke.

Parameters:

col -

getLineOpacity

public double getLineOpacity()

Gets the Color of the associated PenStroke.

Returns:

setLineOpacity

public void setLineOpacity(double opacity)

Sets the Color of the associated PenStroke.

Parameters:

opacity - The new opacity.

getDashArray

public String getDashArray()

Get the String that represent the dash pattern for the associated PenStroke.

Returns:

The dash array in a string. Can't be null. Even if the underlying Symbolizer does not have such an array, an empty String is returned.

setDashArray

public void setDashArray(String str)

Set the String that represent the dash pattern for the associated PenStroke.

Parameters:

str - The new dash array.