org.orbisgis.legend.structure.stroke.constant

Class ConstantPenStrokeLegend

java.lang.Object

org.orbisgis.legend.structure.stroke.PenStrokeLegend

org.orbisgis.legend.structure.stroke.ConstantColorAndDashesPSLegend

org.orbisgis.legend.structure.stroke.constant.ConstantPenStrokeLegend

All Implemented Interfaces:

LegendStructure, ConstantPenStroke, StrokeLegend

public class ConstantPenStrokeLegend
extends ConstantColorAndDashesPSLegend
implements ConstantPenStroke

This class is used to represent instances of PenStroke whose parameters (width, fill and dash array) are all constant.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
ConstantPenStrokeLegend()
ConstantPenStrokeLegend(PenStroke ps) Build a new instance of ConstantPenStrokeLegend.
ConstantPenStrokeLegend(PenStroke ps, RealLiteralLegend width, ConstantFillLegend fill, StringLiteralLegend dash) Build a new instance of ConstantPenStrokeLegend.

Method Summary

Methods

Modifier and Type	Method and Description
ConstantSolidFill	getFillLegend() Gets the analysis obtained from the inner solid fill.
double	getLineWidth() Get the width of the associated PenStroke.
void	setLineWidth(double width) Set the width of the associated PenStroke.

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

getDashArray, getLineColor, getLineOpacity, setDashArray, setLineColor, setLineOpacity

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

Methods inherited from interface org.orbisgis.legend.structure.stroke.constant.ConstantPenStroke

getDashArray, getLineColor, getLineOpacity, getStrokeUom, setDashArray, setLineColor, setLineOpacity, setStrokeUom

Methods inherited from interface org.orbisgis.legend.structure.stroke.StrokeLegend

getStroke

Constructor Detail

ConstantPenStrokeLegend

public ConstantPenStrokeLegend(PenStroke ps)

Build a new instance of ConstantPenStrokeLegend. Use at your own risk : if ps can't be recognize as a ConstantPenStrokeLegend, you'll receive runtime exceptions...

Parameters:

ps -

Throws:

ClassCastException - if some ps fields can't be recognize as valid parameters for this legend.

ConstantPenStrokeLegend

public ConstantPenStrokeLegend()

ConstantPenStrokeLegend

public ConstantPenStrokeLegend(PenStroke ps,
                       RealLiteralLegend width,
                       ConstantFillLegend fill,
                       StringLiteralLegend dash)

Build a new instance of ConstantPenStrokeLegend.

Parameters:

ps -

width -

fill -

dash -

Method Detail

getLineWidth

public double getLineWidth()

Get the width of the associated PenStroke.

Specified by:

getLineWidth in interface ConstantPenStroke

Returns:

setLineWidth

public void setLineWidth(double width)

Set the width of the associated PenStroke.

Specified by:

setLineWidth in interface ConstantPenStroke

Parameters:

width -

getFillLegend

public ConstantSolidFill getFillLegend()

Description copied from interface: ConstantPenStroke

Gets the analysis obtained from the inner solid fill.

Specified by:

getFillLegend in interface ConstantPenStroke

Returns: