|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ExternalGraphic
Holds a reference to an external graphics file with a URL to its location and its expected MIME type. Knowing the MIME type in advance allows stylers to select best-supported formats from a list of external graphics.
The details of this object are taken from the OGC Styled-Layer Descriptor Report (OGC 02-070) version 1.0.0.:
<xsd:element name="ExternalGraphic">
<xsd:annotation>
<xsd:documentation>
An "ExternalGraphic" gives a reference to an external raster or
vector graphical object.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="sld:OnlineResource"/>
<xsd:element ref="sld:Format"/>
</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:
modules/library/api (gt-api.jar)
Field Summary | |
---|---|
static ExternalGraphic[] |
EXTERNAL_GRAPHICS_EMPTY
|
Fields inherited from interface Symbol |
---|
SYMBOLS_EMPTY |
Method Summary | |
---|---|
Map<String,Object> |
getCustomProperties()
Custom user supplied properties available when working with an external graphic. |
URL |
getLocation()
Provides the URL for where the external graphic resource can be located. |
void |
setCustomProperties(Map<String,Object> properties)
Custom properties; renderer may consult these values when drawing graphic. |
void |
setFormat(String format)
Provides the format of the external graphic. |
void |
setLocation(URL url)
Provides the URL for where the external graphic resource can be located. |
void |
setURI(String uri)
Converts a URI in a string to the location URL |
Methods inherited from interface ExternalGraphic |
---|
accept, getColorReplacements, getFormat, getInlineContent, getOnlineResource |
Methods inherited from interface Symbol |
---|
accept |
Field Detail |
---|
static final ExternalGraphic[] EXTERNAL_GRAPHICS_EMPTY
Method Detail |
---|
void setURI(String uri)
uri
- the uri of the external graphicURL getLocation() throws MalformedURLException
This method will be replaced by getOnlineResource().getLinkage() in 2.6.x
MalformedURLException
- If the url held in the ExternalGraphic is
malformed.void setLocation(URL url)
url
- The URL of the ExternalGraphicvoid setFormat(String format)
format
- The format of the external graphic. Reported as its MIME
type in a String object.void setCustomProperties(Map<String,Object> properties)
The default GeoTools renderer uses the following:
properties
- Map<String,Object> getCustomProperties()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |