Package org.geotools.api.style

Interface PolygonSymbolizer

All Superinterfaces:

Symbolizer

All Known Implementing Classes:

PolygonSymbolizerImpl

public interface PolygonSymbolizer
extends Symbolizer

Holds the information that indicates how to draw the lines and the interior of polygons.

Since:

GeoAPI 2.2

Author:

Open Geospatial Consortium, Johann Sorel (Geomatys), Chris Dillard (SYS Technologies)

Field Summary

Fields

Modifier and Type	Field	Description
static String	GRAPHIC_MARGIN_KEY	Pixels between each graphic of a polygon fill

Method Summary

Modifier and Type	Method	Description
Object	accept(TraversingStyleVisitor visitor, Object extraData)	calls the visit method of a StyleVisitor
Displacement	getDisplacement()	The Displacement gives the X and Y displacements from the original geometry.
Fill	getFill()	Returns the object that holds the information about how the interior of polygons should be filled.
Expression	getPerpendicularOffset()	PerpendicularOffset works as defined for LineSymbolizer, allowing to draw polygons smaller or larger than their actual geometry.
Stroke	getStroke()	Returns the object containing all the information necessary to draw styled lines.
void	setDisplacement(Displacement displacement)	Provide x / y offset in pixels used to crate shadows.
void	setFill(Fill fill)	Provides the graphical-symbolization parameter to use to fill the area of the geometry.
void	setPerpendicularOffset(Expression offset)	PerpendicularOffset works as defined for LineSymbolizer, allowing to draw polygons smaller or larger than their actual geometry.
void	setStroke(Stroke stroke)	Provides the graphical-symbolization parameter to use for the outline of the Polygon.

Methods inherited from interface Symbolizer

accept, getDescription, getGeometry, getGeometryPropertyName, getName, getOptions, getUnitOfMeasure, hasOption, setDescription, setGeometry, setGeometryPropertyName, setName, setUnitOfMeasure

Field Detail

GRAPHIC_MARGIN_KEY

static final String GRAPHIC_MARGIN_KEY

Pixels between each graphic of a polygon fill

See Also:

Constant Field Values

Method Detail

setFill

void setFill(Fill fill)

Provides the graphical-symbolization parameter to use to fill the area of the geometry. Note that the area should be filled first before the outline is rendered.

Parameters:

fill - The Fill style to use when rendering the area.

getStroke

Stroke getStroke()

Returns the object containing all the information necessary to draw styled lines. This is used for the edges of polygons.

Returns:

Stroke

getFill

Fill getFill()

Returns the object that holds the information about how the interior of polygons should be filled. This may be null if the polygons are not to be filled at all.

Returns:

Fill

setStroke

void setStroke(Stroke stroke)

Provides the graphical-symbolization parameter to use for the outline of the Polygon.

Parameters:

stroke - The Stroke style to use when rendering lines.

setPerpendicularOffset

void setPerpendicularOffset(Expression offset)

PerpendicularOffset works as defined for LineSymbolizer, allowing to draw polygons smaller or larger than their actual geometry.

Parameters:

offset - Offset from the edge polygon positive outside; negative to the inside with a default of 0.

getDisplacement

Displacement getDisplacement()

The Displacement gives the X and Y displacements from the original geometry. This element may be used to avoid over-plotting of multiple PolygonSymbolizers for one geometry or supplying "shadows" of polygon gemeotries. The displacements are in units of pixels above and to the right of the point. The default displacement is X=0, Y=0.

Returns:

Displacement

getPerpendicularOffset

Expression getPerpendicularOffset()

PerpendicularOffset works as defined for LineSymbolizer, allowing to draw polygons smaller or larger than their actual geometry. The distance is in uoms and is positive to the outside of the polygon. Negative numbers mean drawing the polygon smaller. The default offset is 0.

Returns:

Expression

accept

Object accept(TraversingStyleVisitor visitor,
              Object extraData)

calls the visit method of a StyleVisitor

Specified by:

accept in interface Symbolizer

Parameters:

visitor - the style visitor

Returns:

value produced

setDisplacement

void setDisplacement(Displacement displacement)

Provide x / y offset in pixels used to crate shadows.