org.geotools.styling
Interface ExternalMark

All Superinterfaces:
org.opengis.style.ExternalMark

public interface ExternalMark
extends org.opengis.style.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
 java.lang.String getFormat()
          Mime type of the onlineResource/InlineContent
 javax.swing.Icon getInlineContent()
          Inline content.
 void getInlineContent(javax.swing.Icon inline)
          Icon to use for inline content.
 int getMarkIndex()
          Returns an integer value that can used for accessing a particular Font character in a TTF file or a catalog for example.
 org.opengis.metadata.citation.OnLineResource getOnlineResource()
          Online resource defined by an URI.
 void setFormat(java.lang.String mimeType)
           
 void setMarkIndex(int markIndex)
          Mark index used to specify true type font character; or frame of an animated gif.
 void setOnlineResource(org.opengis.metadata.citation.OnLineResource resource)
           
 
Methods inherited from interface org.opengis.style.ExternalMark
accept
 

Method Detail

getOnlineResource

org.opengis.metadata.citation.OnLineResource getOnlineResource()
Online resource defined by an URI.

Only one of OnlineResource or InlineContent can be supplied.

Specified by:
getOnlineResource in interface org.opengis.style.ExternalMark
Returns:
OnlineResource or null

setOnlineResource

void setOnlineResource(org.opengis.metadata.citation.OnLineResource resource)
Parameters:
resource - Online resource with format defined by getFormat()

getInlineContent

javax.swing.Icon getInlineContent()
Inline content. Only one of OnlineResource or InlineContent can be supplied.

Specified by:
getInlineContent in interface org.opengis.style.ExternalMark
Returns:
InlineContent or null

getInlineContent

void getInlineContent(javax.swing.Icon inline)
Icon to use for inline content.

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

Parameters:
inline -

getFormat

java.lang.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 org.opengis.style.ExternalMark
Returns:
mime type

setFormat

void setFormat(java.lang.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 org.opengis.style.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-2010 Geotools. All Rights Reserved.