de.micromata.opengis.kml.v_2_2_0

Class Overlay

java.lang.Object

de.micromata.opengis.kml.v_2_2_0.AbstractObject

de.micromata.opengis.kml.v_2_2_0.Feature

de.micromata.opengis.kml.v_2_2_0.Overlay

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

GroundOverlay, PhotoOverlay, ScreenOverlay

public abstract class Overlay
extends Feature
implements Cloneable

This is an abstract element and cannot be used directly in a KML file. is the base type for image overlays drawn on the planet surface or on the screen. specifies the image to use and can be configured to reload images based on a timer or by camera changes. This element also includes specifications for stacking order of multiple overlays and for adding color and transparency values to the base image.

Syntax:

<!-- abstract element; do not create -->
 <!-- Overlay id="ID" -->                    <!-- GroundOverlay,ScreenOverlay -->
   <!-- inherited from Feature element -->
   <name>...</name>                      <!-- string -->
   <visibility>1</visibility>            <!-- boolean -->
   <open>0</open>                        <!-- boolean -->
   <atom:author>...<atom:author>         <!-- xmlns:atom -->
   <atom:link>...</atom:link>            <!-- xmlns:atom -->
   <address>...</address>                <!-- string -->
   <xal:AddressDetails>...</xal:AddressDetails>  <!-- xmlns:xal -->
  <phoneNumber>...</phoneNumber>        <!-- string -->
  <Snippet maxLines="2">...</Snippet>   <!-- string -->
   <description>...</description>        <!-- string -->
   <AbstractView>...</AbstractView>      <!-- Camera or LookAt -->
   <TimePrimitive>...</TimePrimitive>
   <styleUrl>...</styleUrl>              <!-- anyURI -->
   <StyleSelector>...</StyleSelector>
   <Region>...</Region>
   <Metadata>...</Metadata>              <!-- deprecated in KML 2.2 -->
   <ExtendedData>...</ExtendedData>      <!-- new in KML 2.2 -->
 
   <!-- specific to Overlay -->
   <color>ffffffff</color>                   <!-- kml:color -->
   <drawOrder>0</drawOrder>                  <!-- int -->
   <Icon>
     <href>...</href>
   </Icon>
 <!-- /Overlay -->

Extends:

Field Summary

Fields

Modifier and Type	Field and Description
protected String	color Color and opacity (alpha) values are expressed in hexadecimal notation.
protected int	drawOrder This element defines the stacking order for the images in overlapping overlays.
protected Icon	icon see also .
protected List<AbstractObject>	overlayObjectExtension
protected List<Object>	overlaySimpleExtension

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.Feature

abstractView, address, atomAuthor, atomLink, description, extendedData, featureObjectExtension, featureSimpleExtension, metadata, name, open, phoneNumber, region, snippet, snippetd, styleSelector, styleUrl, timePrimitive, visibility, xalAddressDetails

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject

id, objectSimpleExtension, targetId

Constructor Summary

Constructors

Constructor and Description
Overlay()

Method Summary

Methods

Modifier and Type	Method and Description
Overlay	addToFeatureObjectExtension(AbstractObject featureObjectExtension) add a value to the featureObjectExtension property collection
Overlay	addToFeatureSimpleExtension(Object featureSimpleExtension) add a value to the featureSimpleExtension property collection
Overlay	addToObjectSimpleExtension(Object objectSimpleExtension) add a value to the objectSimpleExtension property collection
Overlay	addToOverlayObjectExtension(AbstractObject overlayObjectExtension) add a value to the overlayObjectExtension property collection
Overlay	addToOverlaySimpleExtension(Object overlaySimpleExtension) add a value to the overlaySimpleExtension property collection
Overlay	addToStyleSelector(StyleSelector styleSelector) add a value to the styleSelector property collection
Overlay	clone()
Icon	createAndSetIcon() Creates a new instance of Icon and set it to icon.
boolean	equals(Object obj)
String	getColor()
int	getDrawOrder()
Icon	getIcon()
List<AbstractObject>	getOverlayObjectExtension()
List<Object>	getOverlaySimpleExtension()
int	hashCode()
void	setColor(String value)
void	setDrawOrder(int value)
void	setFeatureObjectExtension(List<AbstractObject> featureObjectExtension)
void	setFeatureSimpleExtension(List<Object> featureSimpleExtension)
void	setIcon(Icon value)
void	setObjectSimpleExtension(List<Object> objectSimpleExtension)
void	setOverlayObjectExtension(List<AbstractObject> overlayObjectExtension)
void	setOverlaySimpleExtension(List<Object> overlaySimpleExtension)
void	setStyleSelector(List<StyleSelector> styleSelector)
Overlay	withAbstractView(AbstractView abstractView) fluent setter
Overlay	withAddress(String address) fluent setter
Overlay	withAtomAuthor(Author atomAuthor) fluent setter
Overlay	withAtomLink(Link atomLink) fluent setter
Overlay	withColor(String color) fluent setter
Overlay	withDescription(String description) fluent setter
Overlay	withDrawOrder(int drawOrder) fluent setter
Overlay	withExtendedData(ExtendedData extendedData) fluent setter
Overlay	withFeatureObjectExtension(List<AbstractObject> featureObjectExtension) fluent setter
Overlay	withFeatureSimpleExtension(List<Object> featureSimpleExtension) fluent setter
Overlay	withIcon(Icon icon) fluent setter
Overlay	withId(String id) fluent setter
Overlay	withMetadata(Metadata metadata) fluent setter
Overlay	withName(String name) fluent setter
Overlay	withObjectSimpleExtension(List<Object> objectSimpleExtension) fluent setter
Overlay	withOpen(Boolean open) fluent setter
Overlay	withOverlayObjectExtension(List<AbstractObject> overlayObjectExtension) fluent setter
Overlay	withOverlaySimpleExtension(List<Object> overlaySimpleExtension) fluent setter
Overlay	withPhoneNumber(String phoneNumber) fluent setter
Overlay	withRegion(Region region) fluent setter
Overlay	withSnippet(Snippet snippet) fluent setter
Overlay	withSnippetd(String snippetd) fluent setter
Overlay	withStyleSelector(List<StyleSelector> styleSelector) fluent setter
Overlay	withStyleUrl(String styleUrl) fluent setter
Overlay	withTargetId(String targetId) fluent setter
Overlay	withTimePrimitive(TimePrimitive timePrimitive) fluent setter
Overlay	withVisibility(Boolean visibility) fluent setter
Overlay	withXalAddressDetails(AddressDetails xalAddressDetails) fluent setter

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.Feature

createAndAddStyle, createAndAddStyleMap, createAndSetAtomAuthor, createAndSetAtomLink, createAndSetCamera, createAndSetExtendedData, createAndSetLookAt, createAndSetMetadata, createAndSetRegion, createAndSetSnippet, createAndSetTimeSpan, createAndSetTimeStamp, createAndSetXalAddressDetails, getAbstractView, getAddress, getAtomAuthor, getAtomLink, getDescription, getExtendedData, getFeatureObjectExtension, getFeatureSimpleExtension, getMetadata, getName, getPhoneNumber, getRegion, getSnippet, getSnippetd, getStyleSelector, getStyleUrl, getTimePrimitive, getXalAddressDetails, isOpen, isVisibility, setAbstractView, setAddress, setAtomAuthor, setAtomLink, setDescription, setExtendedData, setMetadata, setName, setOpen, setPhoneNumber, setRegion, setSnippet, setSnippetd, setStyleUrl, setTimePrimitive, setVisibility, setXalAddressDetails

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject

getId, getObjectSimpleExtension, getTargetId, setId, setTargetId

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

color

protected String color

Color and opacity (alpha) values are expressed in hexadecimal notation. The range of values for any one color is 0 to 255 (00 to ff). For alpha, 00 is fully transparent and ff is fully opaque. The order of expression is aabbggrr, where aa=alpha (00 to ff); bb=blue (00 to ff); gg=green (00 to ff); rr=red (00 to ff). For example, if you want to apply a blue color with 50 percent opacity to an overlay, you would specify the following: 7fff0000, where alpha=0x7f, blue=0xff, green=0x00, and red=0x00.

Color values are expressed in hexadecimal notation, including opacity (alpha) values. The order of expression is alpha, blue, green, red (aabbggrr). The range of values for any one color is 0 to 255 (00 to ff). For opacity, 00 is fully transparent and ff is fully opaque. For example, if you want to apply a blue color with 50 percent opacity to an overlay, you would specify the following: 7fff0000

Note: The element has been deprecated. Use instead.

drawOrder

protected int drawOrder

This element defines the stacking order for the images in overlapping overlays. Overlays with higher values are drawn on top of overlays with lower values.

icon

protected Icon icon

see also .

Sunset.jpg

A custom Icon. In , the only child element of is : : An HTTP address or a local file specification used to load an icon.

Defines an image associated with an Icon style or overlay. has the same child elements as . The required child element defines the location of the image to be used as the overlay or as the icon for the placemark. This location can either be on a local file system or a remote web server.

Defines the image associated with the Overlay. The element defines the location of the image to be used as the Overlay. This location can be either on a local file system or on a web server. If this element is omitted or contains no , a rectangle is drawn using the color and size defined by the ground or screen overlay. icon.jpg

Syntax:

<Icon id="ID">
   <!-- specific to Icon -->
   <href>...</href>                      <!-- anyURI -->
   <refreshMode>onChange</refreshMode>   
     <!-- kml:refreshModeEnum: onChange, onInterval, or onExpire -->   
   <refreshInterval>4</refreshInterval>  <!-- float -->
   <viewRefreshMode>never</viewRefreshMode> 
     <!-- kml:viewRefreshModeEnum: never, onStop, onRequest, onRegion -->
   <viewRefreshTime>4</viewRefreshTime>  <!-- float -->
   <viewBoundScale>1</viewBoundScale>    <!-- float -->
   <viewFormat>...</viewFormat>          <!-- string -->
   <httpQuery>...</httpQuery>            <!-- string -->
   </Icon>

Contained By:

overlaySimpleExtension

protected List<Object> overlaySimpleExtension

overlayObjectExtension

protected List<AbstractObject> overlayObjectExtension