de.micromata.opengis.kml.v_2_2_0
Class ItemIcon

java.lang.Object
  extended by de.micromata.opengis.kml.v_2_2_0.AbstractObject
      extended by de.micromata.opengis.kml.v_2_2_0.ItemIcon
All Implemented Interfaces:
java.lang.Cloneable

public class ItemIcon
extends AbstractObject
implements java.lang.Cloneable

Specifies the current state of the NetworkLink or Folder. Possible values are open, closed, error, fetching0, fetching1, and fetching2. These values can be combined by inserting a space between two values (no comma). Specifies the URI of the image used in the List View for the Feature.

Icon used in the List view that reflects the state of a Folder or Link fetch. Icons associated with the open and closed modes are used for Folders and Network Links. Icons associated with the error and fetching0, fetching1, and fetching2 modes are used for Network Links. The following screen capture illustrates the Google Earth icons for these states:


Field Summary
protected  java.lang.String href
          
protected  java.util.List<AbstractObject> itemIconObjectExtension
          
protected  java.util.List<java.lang.Object> itemIconSimpleExtension
           
protected  java.util.List<ItemIconState> state
          
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
id, objectSimpleExtension, targetId
 
Constructor Summary
ItemIcon()
           
 
Method Summary
 ItemIcon addToItemIconObjectExtension(AbstractObject itemIconObjectExtension)
          add a value to the itemIconObjectExtension property collection
 ItemIcon addToItemIconSimpleExtension(java.lang.Object itemIconSimpleExtension)
          add a value to the itemIconSimpleExtension property collection
 ItemIcon addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 ItemIcon addToState(ItemIconState state)
          add a value to the state property collection
 ItemIcon clone()
           
 boolean equals(java.lang.Object obj)
           
 java.lang.String getHref()
           
 java.util.List<AbstractObject> getItemIconObjectExtension()
           
 java.util.List<java.lang.Object> getItemIconSimpleExtension()
           
 java.util.List<ItemIconState> getState()
           
 int hashCode()
           
 void setHref(java.lang.String value)
           
 void setItemIconObjectExtension(java.util.List<AbstractObject> itemIconObjectExtension)
           
 void setItemIconSimpleExtension(java.util.List<java.lang.Object> itemIconSimpleExtension)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 void setState(java.util.List<ItemIconState> state)
           
 ItemIcon withHref(java.lang.String href)
          fluent setter
 ItemIcon withId(java.lang.String id)
          fluent setter
 ItemIcon withItemIconObjectExtension(java.util.List<AbstractObject> itemIconObjectExtension)
          fluent setter
 ItemIcon withItemIconSimpleExtension(java.util.List<java.lang.Object> itemIconSimpleExtension)
          fluent setter
 ItemIcon withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 ItemIcon withState(java.util.List<ItemIconState> state)
          fluent setter
 ItemIcon withTargetId(java.lang.String targetId)
          fluent setter
 
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

state

protected java.util.List<ItemIconState> state

Specifies the current state of the NetworkLink or Folder. Possible values are open, closed, error, fetching0, fetching1, and fetching2. These values can be combined by inserting a space between two values (no comma).


href

protected java.lang.String href

A URL (either an HTTP address or a local file specification). When the parent of is a NetworkLink, is a KML file. When the parent of is a Model, is a COLLADA file. When the parent of (same fields as ) is an Overlay, is an image. Relative URLs can be used in this tag and are evaluated relative to the enclosing KML file.

An HTTP address or a local file specification used to load an icon.

Specifies the URI of the image used in the List View for the Feature.


itemIconSimpleExtension

protected java.util.List<java.lang.Object> itemIconSimpleExtension

itemIconObjectExtension

protected java.util.List<AbstractObject> itemIconObjectExtension

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> -->

Constructor Detail

ItemIcon

public ItemIcon()
Method Detail

getState

public java.util.List<ItemIconState> getState()
See Also:
state

getHref

public java.lang.String getHref()
Returns:
possible object is String
See Also:
href

setHref

public void setHref(java.lang.String value)
Parameters:
value - allowed object is String
See Also:
href

getItemIconSimpleExtension

public java.util.List<java.lang.Object> getItemIconSimpleExtension()
See Also:
itemIconSimpleExtension

getItemIconObjectExtension

public java.util.List<AbstractObject> getItemIconObjectExtension()
See Also:
itemIconObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class AbstractObject

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class AbstractObject

setState

public void setState(java.util.List<ItemIconState> state)
Parameters:
state -
See Also:
state

addToState

public ItemIcon addToState(ItemIconState state)
add a value to the state property collection

Parameters:
state - Objects of the following type are allowed in the list: ItemIconState
Returns:
true (as general contract of Collection.add).

setItemIconSimpleExtension

public void setItemIconSimpleExtension(java.util.List<java.lang.Object> itemIconSimpleExtension)
Parameters:
itemIconSimpleExtension -
See Also:
itemIconSimpleExtension

addToItemIconSimpleExtension

public ItemIcon addToItemIconSimpleExtension(java.lang.Object itemIconSimpleExtension)
add a value to the itemIconSimpleExtension property collection

Parameters:
itemIconSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setItemIconObjectExtension

public void setItemIconObjectExtension(java.util.List<AbstractObject> itemIconObjectExtension)
Parameters:
itemIconObjectExtension -
See Also:
itemIconObjectExtension

addToItemIconObjectExtension

public ItemIcon addToItemIconObjectExtension(AbstractObject itemIconObjectExtension)
add a value to the itemIconObjectExtension property collection

Parameters:
itemIconObjectExtension - 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 AbstractObject
See Also:
objectSimpleExtension

addToObjectSimpleExtension

public ItemIcon addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
Description copied from class: AbstractObject
add a value to the objectSimpleExtension property collection

Overrides:
addToObjectSimpleExtension in class AbstractObject
Parameters:
objectSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

withState

public ItemIcon withState(java.util.List<ItemIconState> state)
fluent setter

Parameters:
state - required parameter
See Also:
#setState(List)

withHref

public ItemIcon withHref(java.lang.String href)
fluent setter

Parameters:
href - required parameter
See Also:
setHref(String)

withItemIconSimpleExtension

public ItemIcon withItemIconSimpleExtension(java.util.List<java.lang.Object> itemIconSimpleExtension)
fluent setter

Parameters:
itemIconSimpleExtension - required parameter
See Also:
#setItemIconSimpleExtension(List)

withItemIconObjectExtension

public ItemIcon withItemIconObjectExtension(java.util.List<AbstractObject> itemIconObjectExtension)
fluent setter

Parameters:
itemIconObjectExtension - required parameter
See Also:
#setItemIconObjectExtension(List)

withObjectSimpleExtension

public ItemIcon withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Description copied from class: AbstractObject
fluent setter

Overrides:
withObjectSimpleExtension in class AbstractObject
Parameters:
objectSimpleExtension - required parameter
See Also:
#setObjectSimpleExtension(List)

withId

public ItemIcon withId(java.lang.String id)
Description copied from class: AbstractObject
fluent setter

Overrides:
withId in class AbstractObject
Parameters:
id - required parameter
See Also:
AbstractObject.setId(String)

withTargetId

public ItemIcon withTargetId(java.lang.String targetId)
Description copied from class: AbstractObject
fluent setter

Overrides:
withTargetId in class AbstractObject
Parameters:
targetId - required parameter
See Also:
AbstractObject.setTargetId(String)

clone

public ItemIcon clone()
Overrides:
clone in class AbstractObject