org.orbisgis.legend.thematic

Class AreaParameters

java.lang.Object

org.orbisgis.legend.thematic.LineParameters

org.orbisgis.legend.thematic.AreaParameters

All Implemented Interfaces:

SymbolParameters

Direct Known Subclasses:

PointParameters

public class AreaParameters
extends LineParameters

A simple java "tuple" that embeds the six parameters needed to draw a polygon as defined with a SolidFill.

Author:

alexis

Constructor Summary

Constructors

Constructor and Description
AreaParameters() Builds a new AreaParameters with the default values that are defined for a SolidFill and a PenStroke.
AreaParameters(Color lineCol, Double lineOp, Double lineWidth, String lineDash, Color fillCol, Double fillOp) Build a new AreaParameters with the given arguments.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
Color	getFillColor() Gets the Color of the fill of this configuration.
Double	getFillOpacity() Gets the opacity of the fill of this configuration.
int	hashCode()

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

getLineColor, getLineDash, getLineOpacity, getLineWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

AreaParameters

public AreaParameters()

Builds a new AreaParameters with the default values that are defined for a SolidFill and a PenStroke.

AreaParameters

public AreaParameters(Color lineCol,
              Double lineOp,
              Double lineWidth,
              String lineDash,
              Color fillCol,
              Double fillOp)

Build a new AreaParameters with the given arguments.

Parameters:

lineCol - The line color, set to Color.BLACK if null

lineOp - The opacity, set to 1.0 if null. If it's out of [0,1], will be set to the closest extremum of this interval.

lineWidth - The width, set to 0.25 if null.

lineDash - The dash pattern, set to the empty string if null or not valid.

fillCol - the colour used to fill the area

fillOp - the opacity of the fill

Method Detail

getFillColor

public Color getFillColor()

Gets the Color of the fill of this configuration.

Returns:

The color we want to use to fill the polygon.

getFillOpacity

public Double getFillOpacity()

Gets the opacity of the fill of this configuration.

Returns:

The opacity of the colour we want to use to fill the polygon.

equals

public boolean equals(Object o)

Specified by:

equals in interface SymbolParameters

Overrides:

equals in class LineParameters

hashCode

public int hashCode()

Specified by:

hashCode in interface SymbolParameters

Overrides:

hashCode in class LineParameters