Package org.geotools.api.style

Interface ExternalMark

All Known Implementing Classes:
ExternalMarkImpl
public interface ExternalMark
The alternative to a WellKnownName is an external mark format. The MarkIndex allows an individual mark in a mark archive to be selected. An example format for an external mark archive would be a TrueType font file, with MarkIndex being used to select an individual glyph from that file.
Since:
GeoAPI 2.2
Author:
Open Geospatial Consortium, Johann Sorel (Geomatys)

  • Method Details

    • getOnlineResource

      OnLineResource getOnlineResource()
      Online resource defined by an URI.

      Only one of OnlineResource or InlineContent can be supplied.

      Returns:
      OnlineResource or null

    • setOnlineResource

      void setOnlineResource(OnLineResource resource)
      Parameters:
      resource - Online resource with format defined by getFormat()

    • getInlineContent

      Icon getInlineContent()
      Inline content.

      Only one of OnlineResource or InlineContent can be supplied.

      Returns:
      InlineContent or null

    • setInlineContent

      void setInlineContent(Icon inline)
      Icon to use for inline content.

      This is often a SwingImageIcon with a format defined by getFormat()

    • getFormat

      String getFormat()
      Mime type of the onlineResource/InlineContent

      Common examples:

      • image/svg
      • image/png
      • image/gif
      This information is used by a renderer to determine if it can support the image format being supplied.
      Returns:
      mime type

    • setFormat

      void setFormat(String mimeType)
      Parameters:
      mimeType - Mime type of external (or internal) resource

    • getMarkIndex

      int getMarkIndex()
      Returns an integer value that can used for accessing a particular Font character in a TTF file or a catalog for example.
      Returns:
      integer

    • accept

      Object accept(TraversingStyleVisitor visitor, Object extraData)
      calls the visit method of a StyleVisitor
      Parameters:
      visitor - the style visitor

    • setMarkIndex

      void setMarkIndex(int markIndex)
      Mark index used to specify true type font character; or frame of an animated gif.