.
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:
Constructor Summary
Icon ()
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
refreshMode
protected RefreshMode refreshMode
RefreshMode
onChange, onInterval, onExpire
See Also:
See
refreshInterval
protected double refreshInterval
Indicates to refresh the file every n seconds.
viewRefreshMode
protected ViewRefreshMode viewRefreshMode
ViewRefreshMode
never, onRequest, onStop, onRegion
See Also:
See
viewRefreshTime
protected double viewRefreshTime
After camera movement stops, specifies the number of seconds to wait before refreshing
the view. (See and onStop above.)
viewBoundScale
protected double viewBoundScale
Scales the BBOX parameters before sending them to the server. A value less than
1 specifies to use less than the full view (screen). A value greater than 1 specifies
to fetch an area that extends beyond the edges of the current view.
viewFormat
protected java.lang.String viewFormat
BBOX=[bboxWest],[bboxSouth],[bboxEast],[bboxNorth]
If you specify a of onStop and do not include the
tag in the file, the following information is automatically appended to the query
string:
If you specify an empty tag, no information is appended to the query
string.
Specifies the format of the query string that is appended to the Link's before
the file is fetched.(If the specifies a local file, this element is ignored.)
This information matches the Web Map Service (WMS) bounding box specification.
You can also specify a custom set of viewing parameters to add to the query string.
If you supply a format string, it is used instead of the BBOX information. If you
also want the BBOX information, you need to add those parameters along with the
custom parameters.
You can use any of the following parameters in your format string (and Google Earth
will substitute the appropriate current value at the time it creates the query string):
[lookatLon], [lookatLat] - longitude and latitude of the point that is
viewing [lookatRange], [lookatTilt], [lookatHeading] - values used by the
element (see descriptions of , , and in ) [lookatTerrainLon],
[lookatTerrainLat], [lookatTerrainAlt] - point on the terrain in degrees/meters
that is viewing [cameraLon], [cameraLat], [cameraAlt] - degrees/meters
of the eyepoint for the camera [horizFov], [vertFov] - horizontal, vertical field
of view for the camera [horizPixels], [vertPixels] - size in pixels of the 3D viewer
[terrainEnabled] - indicates whether the 3D viewer is showing terrain
httpQuery
protected java.lang.String httpQuery
Appends information to the query string, based on the parameters specified. (Google
Earth substitutes the appropriate current value at the time it creates the query
string.) The following parameters are supported: [clientVersion] [kmlVersion] [clientName]
[language]
linkSimpleExtension
protected java.util.List<java.lang.Object> linkSimpleExtension
linkObjectExtension
protected java.util.List<AbstractObject > linkObjectExtension
This is an abstract base class and cannot be used directly in a KML file. It provides
the id attribute, which allows unique identification of a KML element, and the targetId
attribute, which is used to reference objects that have already been loaded into
Google Earth. The id attribute must be assigned if the mechanism is to
be used.
Syntax:
<!-- abstract element; do not create -->
<!-- Object id="ID" targetId="NCName" -->
<!-- /Object > -->
Icon
public Icon ()
getRefreshMode
public RefreshMode getRefreshMode ()
Returns: possible object is
RefreshMode
See Also: refreshMode
setRefreshMode
public void setRefreshMode (RefreshMode value)
Parameters: value
- allowed object is
RefreshMode
See Also: refreshMode
getRefreshInterval
public double getRefreshInterval ()
Returns: possible object is
Double
See Also: refreshInterval
setRefreshInterval
public void setRefreshInterval (double value)
Parameters: value
- allowed object is
Double
See Also: refreshInterval
getViewRefreshMode
public ViewRefreshMode getViewRefreshMode ()
Returns: possible object is
ViewRefreshMode
See Also: viewRefreshMode
setViewRefreshMode
public void setViewRefreshMode (ViewRefreshMode value)
Parameters: value
- allowed object is
ViewRefreshMode
See Also: viewRefreshMode
getViewRefreshTime
public double getViewRefreshTime ()
Returns: possible object is
Double
See Also: viewRefreshTime
setViewRefreshTime
public void setViewRefreshTime (double value)
Parameters: value
- allowed object is
Double
See Also: viewRefreshTime
getViewBoundScale
public double getViewBoundScale ()
Returns: possible object is
Double
See Also: viewBoundScale
setViewBoundScale
public void setViewBoundScale (double value)
Parameters: value
- allowed object is
Double
See Also: viewBoundScale
getViewFormat
public java.lang.String getViewFormat ()
Returns: possible object is
String
See Also: viewFormat
setViewFormat
public void setViewFormat (java.lang.String value)
Parameters: value
- allowed object is
String
See Also: viewFormat
getHttpQuery
public java.lang.String getHttpQuery ()
Returns: possible object is
String
See Also: httpQuery
setHttpQuery
public void setHttpQuery (java.lang.String value)
Parameters: value
- allowed object is
String
See Also: httpQuery
getLinkSimpleExtension
public java.util.List<java.lang.Object> getLinkSimpleExtension ()
See Also: linkSimpleExtension
getLinkObjectExtension
public java.util.List<AbstractObject > getLinkObjectExtension ()
See Also: linkObjectExtension
hashCode
public int hashCode ()
Overrides: hashCode
in class BasicLink
equals
public boolean equals (java.lang.Object obj)
Overrides: equals
in class BasicLink
setLinkSimpleExtension
public void setLinkSimpleExtension (java.util.List<java.lang.Object> linkSimpleExtension)
Parameters: linkSimpleExtension
- See Also: linkSimpleExtension
addToLinkSimpleExtension
public Icon addToLinkSimpleExtension (java.lang.Object linkSimpleExtension)
add a value to the linkSimpleExtension property collection
Parameters: linkSimpleExtension
- Objects of the following type are allowed in the list: Object
Returns: true (as general contract of Collection.add ).
setLinkObjectExtension
public void setLinkObjectExtension (java.util.List<AbstractObject > linkObjectExtension)
Parameters: linkObjectExtension
- See Also: linkObjectExtension
addToLinkObjectExtension
public Icon addToLinkObjectExtension (AbstractObject linkObjectExtension)
add a value to the linkObjectExtension property collection
Parameters: linkObjectExtension
- Objects of the following type are allowed in the list: AbstractObject
Returns: true (as general contract of Collection.add ).
setObjectSimpleExtension
public void setObjectSimpleExtension (java.util.List<java.lang.Object> objectSimpleExtension)
Overrides: setObjectSimpleExtension
in class BasicLink
See Also: objectSimpleExtension
addToObjectSimpleExtension
public Icon addToObjectSimpleExtension (java.lang.Object objectSimpleExtension)
Description copied from class: AbstractObject
add a value to the objectSimpleExtension property collection
Overrides: addToObjectSimpleExtension
in class BasicLink
Parameters: objectSimpleExtension
- Objects of the following type are allowed in the list: Object
Returns: true (as general contract of Collection.add ).
setBasicLinkSimpleExtension
public void setBasicLinkSimpleExtension (java.util.List<java.lang.Object> basicLinkSimpleExtension)
Description copied from class: BasicLink
Sets the value of the basicLinkSimpleExtension property Objects of the following type(s) are allowed in the list List.
Note:
This method does not make use of the fluent pattern.If you would like to make it fluent, use BasicLink.withBasicLinkSimpleExtension(java.util.List)
instead.
Overrides: setBasicLinkSimpleExtension
in class BasicLink
See Also: basicLinkSimpleExtension
addToBasicLinkSimpleExtension
public Icon addToBasicLinkSimpleExtension (java.lang.Object basicLinkSimpleExtension)
Description copied from class: BasicLink
add a value to the basicLinkSimpleExtension property collection
Overrides: addToBasicLinkSimpleExtension
in class BasicLink
Parameters: basicLinkSimpleExtension
- Objects of the following type are allowed in the list: Object
Returns: true (as general contract of Collection.add ).
setBasicLinkObjectExtension
public void setBasicLinkObjectExtension (java.util.List<AbstractObject > basicLinkObjectExtension)
Description copied from class: BasicLink
Sets the value of the basicLinkObjectExtension property Objects of the following type(s) are allowed in the list List.
Note:
This method does not make use of the fluent pattern.If you would like to make it fluent, use BasicLink.withBasicLinkObjectExtension(java.util.List)
instead.
Overrides: setBasicLinkObjectExtension
in class BasicLink
See Also: basicLinkObjectExtension
addToBasicLinkObjectExtension
public Icon addToBasicLinkObjectExtension (AbstractObject basicLinkObjectExtension)
Description copied from class: BasicLink
add a value to the basicLinkObjectExtension property collection
Overrides: addToBasicLinkObjectExtension
in class BasicLink
Parameters: basicLinkObjectExtension
- Objects of the following type are allowed in the list: AbstractObject
Returns: true (as general contract of Collection.add ).
withRefreshMode
public Icon withRefreshMode (RefreshMode refreshMode)
fluent setter
Parameters: refreshMode
- required parameterSee Also: setRefreshMode(RefreshMode)
withRefreshInterval
public Icon withRefreshInterval (double refreshInterval)
fluent setter
Parameters: refreshInterval
- required parameterSee Also: setRefreshInterval(double)
withViewRefreshMode
public Icon withViewRefreshMode (ViewRefreshMode viewRefreshMode)
fluent setter
Parameters: viewRefreshMode
- required parameterSee Also: setViewRefreshMode(ViewRefreshMode)
withViewRefreshTime
public Icon withViewRefreshTime (double viewRefreshTime)
fluent setter
Parameters: viewRefreshTime
- required parameterSee Also: setViewRefreshTime(double)
withViewBoundScale
public Icon withViewBoundScale (double viewBoundScale)
fluent setter
Parameters: viewBoundScale
- required parameterSee Also: setViewBoundScale(double)
withViewFormat
public Icon withViewFormat (java.lang.String viewFormat)
fluent setter
Parameters: viewFormat
- required parameterSee Also: setViewFormat(String)
withHttpQuery
public Icon withHttpQuery (java.lang.String httpQuery)
fluent setter
Parameters: httpQuery
- required parameterSee Also: setHttpQuery(String)
withLinkSimpleExtension
public Icon withLinkSimpleExtension (java.util.List<java.lang.Object> linkSimpleExtension)
fluent setter
Parameters: linkSimpleExtension
- required parameterSee Also: #setLinkSimpleExtension(List)
withLinkObjectExtension
public Icon withLinkObjectExtension (java.util.List<AbstractObject > linkObjectExtension)
fluent setter
Parameters: linkObjectExtension
- required parameterSee Also: #setLinkObjectExtension(List)
withObjectSimpleExtension
public Icon withObjectSimpleExtension (java.util.List<java.lang.Object> objectSimpleExtension)
Description copied from class: AbstractObject
fluent setter
Overrides: withObjectSimpleExtension
in class BasicLink
Parameters: objectSimpleExtension
- required parameterSee Also: #setObjectSimpleExtension(List)
withId
public Icon withId (java.lang.String id)
Description copied from class: AbstractObject
fluent setter
Overrides: withId
in class BasicLink
Parameters: id
- required parameterSee Also: AbstractObject.setId(String)
withTargetId
public Icon withTargetId (java.lang.String targetId)
Description copied from class: AbstractObject
fluent setter
Overrides: withTargetId
in class BasicLink
Parameters: targetId
- required parameterSee Also: AbstractObject.setTargetId(String)
withHref
public Icon withHref (java.lang.String href)
Description copied from class: BasicLink
fluent setter
Overrides: withHref
in class BasicLink
Parameters: href
- required parameterSee Also: BasicLink.setHref(String)
withBasicLinkSimpleExtension
public Icon withBasicLinkSimpleExtension (java.util.List<java.lang.Object> basicLinkSimpleExtension)
Description copied from class: BasicLink
fluent setter
Overrides: withBasicLinkSimpleExtension
in class BasicLink
Parameters: basicLinkSimpleExtension
- required parameterSee Also: #setBasicLinkSimpleExtension(List)
withBasicLinkObjectExtension
public Icon withBasicLinkObjectExtension (java.util.List<AbstractObject > basicLinkObjectExtension)
Description copied from class: BasicLink
fluent setter
Overrides: withBasicLinkObjectExtension
in class BasicLink
Parameters: basicLinkObjectExtension
- required parameterSee Also: #setBasicLinkObjectExtension(List)
clone
public Icon clone ()
Overrides: clone
in class BasicLink