org.geotools.styling
Interface Mark

All Superinterfaces:

GTComponent, Symbol

All Known Subinterfaces:

TextMark

All Known Implementing Classes:

MarkImpl, TextMarkImpl

public interface Mark

extends 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.

Version:

$Id: Mark.java 18021 2006-02-14 20:36:18Z jdeolive $

Author:

James Macgill

Field Summary

static Mark[]

MARKS_EMPTY

Fields inherited from interface org.geotools.styling.Symbol

SYMBOLS_EMPTY

Method Summary

void	accept(StyleVisitor visitor)
Fill	getFill() This parameter defines which fill style to use when rendering the Mark.
Expression	getRotation()
Expression	getSize()
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	setFill(Fill fill) This parameter defines which fill style to use when rendering the Mark.
void	setRotation(Expression rotation)
void	setSize(Expression size)
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 org.geotools.event.GTComponent

changed, getNote, getParent, removed, setNote

Field Detail

MARKS_EMPTY

public static final Mark[] MARKS_EMPTY

Method Detail

getWellKnownName

public 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.

Returns:

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

setWellKnownName

public 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

public Stroke getStroke()

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

Returns:

The Stroke definition to use when rendering the Mark.

setStroke

public 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

public Fill getFill()

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

Returns:

the Fill definition to use when rendering the Mark.

setFill

public 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.

getSize

public Expression getSize()

setSize

public void setSize(Expression size)

getRotation

public Expression getRotation()

setRotation

public void setRotation(Expression rotation)

accept

public void accept(StyleVisitor visitor)

Specified by:

accept in interface Symbol