org.orbisgis.legend.structure.stroke.constant

Interface ConstantPenStroke

All Superinterfaces:

LegendStructure, StrokeLegend

All Known Implementing Classes:

ConstantPenStrokeLegend, NullPenStrokeLegend

public interface ConstantPenStroke
extends StrokeLegend

Interface to be implemented by legends that are associated to constant PenStroke.

Author:

Alexis Guéganno

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.
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 interface org.orbisgis.legend.structure.stroke.StrokeLegend

getStroke

Method Detail

getStrokeUom

Uom getStrokeUom()

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

Returns:

setStrokeUom

void setStrokeUom(Uom u)

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

Parameters:

u -

getFillLegend

ConstantSolidFill getFillLegend()

Gets the analysis obtained from the inner solid fill.

Returns:

getLineColor

Color getLineColor()

Gets the color of the associated PenStroke.

Returns:

setLineColor

void setLineColor(Color col)

Sets the Color of the associated PenStroke.

Parameters:

col -

getLineWidth

double getLineWidth()

Gets the width of the associated PenStroke.

Returns:

setLineWidth

void setLineWidth(double width)

Sets the width of the associated PenStroke.

Parameters:

width -

getDashArray

String getDashArray()

Gest the String that represents 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

void setDashArray(String str)

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

Parameters:

dashes -

getLineOpacity

double getLineOpacity()

Gets the opacity of the associated PenStroke.

Returns:

setLineOpacity

void setLineOpacity(double tr)

Sets the opacity of the associated PenStroke.

Parameters:

tr -