org.geotools.styling
Interface ExternalMark

All Superinterfaces:
ExternalMark

public interface ExternalMark
extends ExternalMark

Specify a mark using an image files (svg, png, gif) or using mark index a true type font file.

Please note that not all render can handle all image file formats; please organize your marks into a preferred order with the most specific (say SVG) followed by common formats (PNG, GIF) and ending with an appropriate WellKnownName.


Method Summary
 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.
 Icon getInlineContent()
          Inline content.
 void getInlineContent(Icon inline)
          Deprecated. use setInlineContent(Icon)
 int getMarkIndex()
          Returns an integer value that can used for accessing a particular Font character in a TTF file or a catalog for example.
 OnLineResource getOnlineResource()
          Online resource defined by an URI.
 void setFormat(String mimeType)
           
 void setInlineContent(Icon inline)
          Icon to use for inline content.
 void setMarkIndex(int markIndex)
          Mark index used to specify true type font character; or frame of an animated gif.
 void setOnlineResource(OnLineResource resource)
           
 
Methods inherited from interface ExternalMark
accept
 

Method Detail

getOnlineResource

OnLineResource getOnlineResource()
Online resource defined by an URI.

Only one of OnlineResource or InlineContent can be supplied.

Specified by:
getOnlineResource in interface ExternalMark
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.

Specified by:
getInlineContent in interface ExternalMark
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()

Parameters:
inline -

getInlineContent

void getInlineContent(Icon inline)
Deprecated. use setInlineContent(Icon)


getFormat

String getFormat()
Mime type of the onlineResource/InlineContent

Common examples:

This information is used by a renderer to determine if it can support the image format being supplied.

Specified by:
getFormat in interface ExternalMark
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.

Specified by:
getMarkIndex in interface ExternalMark
Returns:
integer

setMarkIndex

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

Parameters:
markIndex -


Copyright © 1996-2014 Geotools. All Rights Reserved.