org.orbisgis.legend.structure.stroke.constant

Class NullPenStrokeLegend

java.lang.Object

org.orbisgis.legend.structure.stroke.constant.NullPenStrokeLegend

All Implemented Interfaces:

LegendStructure, ConstantPenStroke, StrokeLegend

public class NullPenStrokeLegend
extends Object
implements ConstantPenStroke

A PenStroke that is null can be considered as a constant : it is not dependant upon any parameter and will always be (not) rendered the same way. It can happen in a AreaSymbolizer where only the Fill is set.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
NullPenStrokeLegend()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDashArray() Gest the String that represents the dash pattern for the associated PenStroke.
ConstantSolidFill	getFillLegend() Gets the analysis obtained from the inner solid fill.
Color	getLineColor() Gets the color of the associated PenStroke.
double	getLineOpacity() Gets the opacity of the associated PenStroke.
double	getLineWidth() Gets the width of the associated PenStroke.
Stroke	getStroke() Gets the Stroke instance associated to this StrokeLegend.
Uom	getStrokeUom() Gets the unit of measure used to drawn the underlying PenStroke.
void	setDashArray(String str) Sets the String that represents the dash pattern for the associated PenStroke.
void	setLineColor(Color col) Sets the Color of the associated PenStroke.
void	setLineOpacity(double tr) Sets the opacity of the associated PenStroke.
void	setLineWidth(double width) Sets the width of the associated PenStroke.
void	setStrokeUom(Uom u) Sets the unit of measure used to drawn the underlying PenStroke.

Methods inherited from class java.lang.Object

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

Constructor Detail

NullPenStrokeLegend

public NullPenStrokeLegend()

Method Detail

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:

getLineColor

public Color getLineColor()

Description copied from interface: ConstantPenStroke

Gets the color of the associated PenStroke.

Specified by:

getLineColor in interface ConstantPenStroke

Returns:

getStroke

public Stroke getStroke()

Description copied from interface: StrokeLegend

Gets the Stroke instance associated to this StrokeLegend.

Specified by:

getStroke in interface StrokeLegend

Returns:

setLineColor

public void setLineColor(Color col)

Description copied from interface: ConstantPenStroke

Sets the Color of the associated PenStroke.

Specified by:

setLineColor in interface ConstantPenStroke

getLineWidth

public double getLineWidth()

Description copied from interface: ConstantPenStroke

Gets the width of the associated PenStroke.

Specified by:

getLineWidth in interface ConstantPenStroke

Returns:

setLineWidth

public void setLineWidth(double width)

Description copied from interface: ConstantPenStroke

Sets the width of the associated PenStroke.

Specified by:

setLineWidth in interface ConstantPenStroke

getDashArray

public String getDashArray()

Description copied from interface: ConstantPenStroke

Gest the String that represents the dash pattern for the associated PenStroke.

Specified by:

getDashArray in interface ConstantPenStroke

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)

Description copied from interface: ConstantPenStroke

Sets the String that represents the dash pattern for the associated PenStroke.

Specified by:

setDashArray in interface ConstantPenStroke

getLineOpacity

public double getLineOpacity()

Description copied from interface: ConstantPenStroke

Gets the opacity of the associated PenStroke.

Specified by:

getLineOpacity in interface ConstantPenStroke

Returns:

setLineOpacity

public void setLineOpacity(double tr)

Description copied from interface: ConstantPenStroke

Sets the opacity of the associated PenStroke.

Specified by:

setLineOpacity in interface ConstantPenStroke

getStrokeUom

public Uom getStrokeUom()

Description copied from interface: ConstantPenStroke

Gets the unit of measure used to drawn the underlying PenStroke.

Specified by:

getStrokeUom in interface ConstantPenStroke

Returns:

setStrokeUom

public void setStrokeUom(Uom u)

Description copied from interface: ConstantPenStroke

Sets the unit of measure used to drawn the underlying PenStroke.

Specified by:

setStrokeUom in interface ConstantPenStroke