org.geotools.styling

Interface Mark

All Superinterfaces:

GraphicalSymbol, Mark, Symbol

public interface Mark
extends Mark, Symbol

A Mark element defines a "shape" which has coloring applied to it.

The details of this object are taken from the OGC Styled-Layer Descriptor Report (OGC 02-070) version 1.0.0.:

 <xsd:element name="Mark">
   <xsd:annotation>
     <xsd:documentation>
       A "Mark" specifies a geometric shape and applies coloring to it.
     </xsd:documentation>
   </xsd:annotation>
   <xsd:complexType>
     <xsd:sequence>
       <xsd:element ref="sld:WellKnownName" minOccurs="0"/>
       <xsd:element ref="sld:Fill" minOccurs="0"/>
       <xsd:element ref="sld:Stroke" minOccurs="0"/>
     </xsd:sequence>
   </xsd:complexType>
 </xsd:element>
 

Renderers can use this information when displaying styled features, though it must be remembered that not all renderers will be able to fully represent strokes as set out by this interface. For example, opacity may not be supported.

Notes:

• The graphical parameters and their values are derived from SVG/CSS2 standards with names and semantics which are as close as possible.

Author:

James Macgill

Field Summary

Fields

Modifier and Type	Field and Description
static Mark[]	MARKS_EMPTY

Fields inherited from interface Symbol

SYMBOLS_EMPTY

Method Summary

Modifier and Type	Method and Description
void	accept(StyleVisitor visitor)
ExternalMark	getExternalMark() Mark defined by an external resource.
Fill	getFill() This parameter defines which fill style to use when rendering the Mark.
Stroke	getStroke() This paramterer defines which stroke style should be used when rendering the Mark.
Expression	getWellKnownName() This parameter gives the well-known name of the shape of the mark.
void	setExternalMark(ExternalMark externalMark) Mark defined by an external resource.
void	setFill(Fill fill) This parameter defines which fill style to use when rendering the Mark.
void	setStroke(Stroke stroke) This paramterer defines which stroke style should be used when rendering the Mark.
void	setWellKnownName(Expression wellKnownName) This parameter gives the well-known name of the shape of the mark.

Methods inherited from interface Mark

accept

Field Detail

MARKS_EMPTY

static final Mark[] MARKS_EMPTY

Method Detail

getWellKnownName

Expression getWellKnownName()

This parameter gives the well-known name of the shape of the mark.
Allowed names include at least "square", "circle", "triangle", "star", "cross" and "x" though renderers may draw a different symbol instead if they don't have a shape for all of these.

Specified by:

getWellKnownName in interface Mark

Returns:

The well-known name of a shape. The default value is "square".

setWellKnownName

void setWellKnownName(Expression wellKnownName)

This parameter gives the well-known name of the shape of the mark.
Allowed names include at least "square", "circle", "triangle", "star", "cross" and "x" though renderers may draw a different symbol instead if they don't have a shape for all of these.

Parameters:

wellKnownName - The well-known name of a shape. The default value is "square".

getStroke

Stroke getStroke()

This paramterer defines which stroke style should be used when rendering the Mark.

Specified by:

getStroke in interface Mark

Returns:

The Stroke definition to use when rendering the Mark.

setStroke

void setStroke(Stroke stroke)

This paramterer defines which stroke style should be used when rendering the Mark.

Parameters:

stroke - The Stroke definition to use when rendering the Mark.

getFill

Fill getFill()

This parameter defines which fill style to use when rendering the Mark.

Specified by:

getFill in interface Mark

Returns:

the Fill definition to use when rendering the Mark.

setFill

void setFill(Fill fill)

This parameter defines which fill style to use when rendering the Mark.

Parameters:

fill - the Fill definition to use when rendering the Mark.

getExternalMark

ExternalMark getExternalMark()

Mark defined by an external resource.

Specified by:

getExternalMark in interface Mark

Returns:

ExternalMark or null if WellKNownName is being used

setExternalMark

void setExternalMark(ExternalMark externalMark)

Mark defined by an external resource.

Parameters:

externalMark - Indicate an mark defined by an external resource

accept

void accept(StyleVisitor visitor)

Specified by:

accept in interface Symbol