org.orbisgis.legend.thematic

Class PointParameters

java.lang.Object

org.orbisgis.legend.thematic.LineParameters

org.orbisgis.legend.thematic.AreaParameters

org.orbisgis.legend.thematic.PointParameters

All Implemented Interfaces:

SymbolParameters

public class PointParameters
extends AreaParameters

A simple java "tuple" that embeds the nine parameters needed to draw a graphic as defined with a MarkGraphic configured with a well-known name.

Author:

alexis

Constructor Summary

Constructors

Constructor and Description
PointParameters() Builds a new PointParameters with the default values that are defined for a SolidFill, a PenStroke and a MarkGraphic configured with a well-known name.
PointParameters(Color lineCol, Double lineOp, Double lineWidth, String lineDash, Color fillCol, Double fillOp, Double symWidth, Double symHeight, String symWkn) Build a new PointParameters with the given arguments.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
Double	getHeight() Gets the height of the configuration
Double	getWidth() Gets the width of the configuration
String	getWkn() Gets the well-known name that defines the form of the symbol defined by this configuration.
int	hashCode()

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

getFillColor, getFillOpacity

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

PointParameters

public PointParameters()

Builds a new PointParameters with the default values that are defined for a SolidFill, a PenStroke and a MarkGraphic configured with a well-known name.

PointParameters

public PointParameters(Color lineCol,
               Double lineOp,
               Double lineWidth,
               String lineDash,
               Color fillCol,
               Double fillOp,
               Double symWidth,
               Double symHeight,
               String symWkn)

Build a new PointParameters 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

symWidth - the width of the symbol

symHeight - the height of the symbol

symWkn - The well-known name that defines the shape of the mark.

Method Detail

getWidth

public Double getWidth()

Gets the width of the configuration

Returns:

the width of the symbol configured with these parameters.

getHeight

public Double getHeight()

Gets the height of the configuration

Returns:

the height of the symbol configured with these parameters.

getWkn

public String getWkn()

Gets the well-known name that defines the form of the symbol defined by this configuration.

Returns:

The well-known name as a string.

equals

public boolean equals(Object o)

Specified by:

equals in interface SymbolParameters

Overrides:

equals in class AreaParameters

hashCode

public int hashCode()

Specified by:

hashCode in interface SymbolParameters

Overrides:

hashCode in class AreaParameters