de.micromata.opengis.kml.v_2_2_0
Class ListStyle

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

public class ListStyle
extends SubStyle
implements java.lang.Cloneable

Specifies how a Feature is displayed in the list view. The list view is a hierarchy of containers and children; in Google Earth, this is the Places panel.

Syntax:
<ListStyle id="ID">
   <!-- specific to ListStyle -->
   <listItemType>check</listItemType> <!-- kml:listItemTypeEnum:check,
                                           checkOffOnly,checkHideChildren,
                                          radioFolder -->
   <bgColor>ffffffff</bgColor>        <!-- kml:color -->
   <ItemIcon>                         <!-- 0 or more ItemIcon elements -->
     <state>open</state>   
       <!-- kml:itemIconModeEnum:open, closed, error, fetching0, fetching1, or fetching2 -->
     <href>...</href>                 <!-- anyURI -->
   </ItemIcon>
 </ListStyle>
Extends:


Field Summary
protected  java.lang.String bgColor
          
protected  java.util.List<ItemIcon> itemIcon
          
protected  ListItemType listItemType
          
protected  java.util.List<AbstractObject> listStyleObjectExtension
          
protected  java.util.List<java.lang.Object> listStyleSimpleExtension
           
protected  int maxSnippetLines
           
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.SubStyle
subStyleObjectExtension, subStyleSimpleExtension
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
id, objectSimpleExtension, targetId
 
Constructor Summary
ListStyle()
           
 
Method Summary
 ListStyle addToItemIcon(ItemIcon itemIcon)
          add a value to the itemIcon property collection
 ListStyle addToListStyleObjectExtension(AbstractObject listStyleObjectExtension)
          add a value to the listStyleObjectExtension property collection
 ListStyle addToListStyleSimpleExtension(java.lang.Object listStyleSimpleExtension)
          add a value to the listStyleSimpleExtension property collection
 ListStyle addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 ListStyle addToSubStyleObjectExtension(AbstractObject subStyleObjectExtension)
          add a value to the subStyleObjectExtension property collection
 ListStyle addToSubStyleSimpleExtension(java.lang.Object subStyleSimpleExtension)
          add a value to the subStyleSimpleExtension property collection
 ListStyle clone()
           
 ItemIcon createAndAddItemIcon()
          Creates a new instance of ItemIcon and adds it to itemIcon.
 boolean equals(java.lang.Object obj)
           
 java.lang.String getBgColor()
           
 java.util.List<ItemIcon> getItemIcon()
           
 ListItemType getListItemType()
           
 java.util.List<AbstractObject> getListStyleObjectExtension()
           
 java.util.List<java.lang.Object> getListStyleSimpleExtension()
           
 int getMaxSnippetLines()
           
 int hashCode()
           
 void setBgColor(java.lang.String value)
           
 void setItemIcon(java.util.List<ItemIcon> itemIcon)
           
 void setListItemType(ListItemType value)
           
 void setListStyleObjectExtension(java.util.List<AbstractObject> listStyleObjectExtension)
           
 void setListStyleSimpleExtension(java.util.List<java.lang.Object> listStyleSimpleExtension)
           
 void setMaxSnippetLines(int value)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 void setSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
          Sets the value of the subStyleObjectExtension property Objects of the following type(s) are allowed in the list List.
 void setSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
          Sets the value of the subStyleSimpleExtension property Objects of the following type(s) are allowed in the list List.
 ListStyle withBgColor(java.lang.String bgColor)
          fluent setter
 ListStyle withId(java.lang.String id)
          fluent setter
 ListStyle withItemIcon(java.util.List<ItemIcon> itemIcon)
          fluent setter
 ListStyle withListItemType(ListItemType listItemType)
          fluent setter
 ListStyle withListStyleObjectExtension(java.util.List<AbstractObject> listStyleObjectExtension)
          fluent setter
 ListStyle withListStyleSimpleExtension(java.util.List<java.lang.Object> listStyleSimpleExtension)
          fluent setter
 ListStyle withMaxSnippetLines(int maxSnippetLines)
          fluent setter
 ListStyle withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 ListStyle withSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
          fluent setter
 ListStyle withSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
          fluent setter
 ListStyle withTargetId(java.lang.String targetId)
          fluent setter
 
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.SubStyle
getSubStyleObjectExtension, getSubStyleSimpleExtension
 
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

listItemType

protected ListItemType listItemType

Specifies how a Feature is displayed in the list view. Possible values are: check (default) - The Feature's visibility is tied to its item's checkbox. radioFolder - When specified for a Container, only one of the Container's items is visible at a time checkOffOnly - When specified for a Container or Network Link, prevents all items from being made visible at once—that is, the user can turn everything in the Container or Network Link off but cannot turn everything on at the same time. This setting is useful for Containers or Network Links containing large amounts of data. checkHideChildren - Use a normal checkbox for visibility but do not display the Container or Network Link's children in the list view. A checkbox allows the user to toggle visibility of the child objects in the viewer.


bgColor

protected java.lang.String bgColor

Background color for the Snippet. Color and opacity 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.

Background color of the balloon (optional). 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). 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 alpha, 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, where alpha=0x7f, blue=0xff, green=0x00, and red=0x00. The default is opaque white (ffffffff).

Note: The use of the element within has been deprecated. Use instead.


itemIcon

protected java.util.List<ItemIcon> itemIcon

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:


maxSnippetLines

protected int maxSnippetLines

listStyleSimpleExtension

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

listStyleObjectExtension

protected java.util.List<AbstractObject> listStyleObjectExtension

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

ListStyle

public ListStyle()
Method Detail

getListItemType

public ListItemType getListItemType()
Returns:
possible object is ListItemType
See Also:
listItemType

setListItemType

public void setListItemType(ListItemType value)
Parameters:
value - allowed object is ListItemType
See Also:
listItemType

getBgColor

public java.lang.String getBgColor()
Returns:
possible object is String
See Also:
bgColor

setBgColor

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

getItemIcon

public java.util.List<ItemIcon> getItemIcon()
See Also:
itemIcon

getMaxSnippetLines

public int getMaxSnippetLines()
Returns:
possible object is Integer
See Also:
maxSnippetLines

setMaxSnippetLines

public void setMaxSnippetLines(int value)
Parameters:
value - allowed object is Integer
See Also:
maxSnippetLines

getListStyleSimpleExtension

public java.util.List<java.lang.Object> getListStyleSimpleExtension()
See Also:
listStyleSimpleExtension

getListStyleObjectExtension

public java.util.List<AbstractObject> getListStyleObjectExtension()
See Also:
listStyleObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class SubStyle

equals

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

createAndAddItemIcon

public ItemIcon createAndAddItemIcon()
Creates a new instance of ItemIcon and adds it to itemIcon. This method is a short version for: ItemIcon itemIcon = new ItemIcon(); this.getItemIcon().add(itemIcon);


setItemIcon

public void setItemIcon(java.util.List<ItemIcon> itemIcon)
Parameters:
itemIcon -
See Also:
itemIcon

addToItemIcon

public ListStyle addToItemIcon(ItemIcon itemIcon)
add a value to the itemIcon property collection

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

setListStyleSimpleExtension

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

addToListStyleSimpleExtension

public ListStyle addToListStyleSimpleExtension(java.lang.Object listStyleSimpleExtension)
add a value to the listStyleSimpleExtension property collection

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

setListStyleObjectExtension

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

addToListStyleObjectExtension

public ListStyle addToListStyleObjectExtension(AbstractObject listStyleObjectExtension)
add a value to the listStyleObjectExtension property collection

Parameters:
listStyleObjectExtension - 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 SubStyle
See Also:
objectSimpleExtension

addToObjectSimpleExtension

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

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

setSubStyleSimpleExtension

public void setSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
Description copied from class: SubStyle
Sets the value of the subStyleSimpleExtension 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 SubStyle.withSubStyleSimpleExtension(java.util.List) instead.

Overrides:
setSubStyleSimpleExtension in class SubStyle
See Also:
subStyleSimpleExtension

addToSubStyleSimpleExtension

public ListStyle addToSubStyleSimpleExtension(java.lang.Object subStyleSimpleExtension)
Description copied from class: SubStyle
add a value to the subStyleSimpleExtension property collection

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

setSubStyleObjectExtension

public void setSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
Description copied from class: SubStyle
Sets the value of the subStyleObjectExtension 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 SubStyle.withSubStyleObjectExtension(java.util.List) instead.

Overrides:
setSubStyleObjectExtension in class SubStyle
See Also:
subStyleObjectExtension

addToSubStyleObjectExtension

public ListStyle addToSubStyleObjectExtension(AbstractObject subStyleObjectExtension)
Description copied from class: SubStyle
add a value to the subStyleObjectExtension property collection

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

withListItemType

public ListStyle withListItemType(ListItemType listItemType)
fluent setter

Parameters:
listItemType - required parameter
See Also:
setListItemType(ListItemType)

withBgColor

public ListStyle withBgColor(java.lang.String bgColor)
fluent setter

Parameters:
bgColor - required parameter
See Also:
setBgColor(String)

withItemIcon

public ListStyle withItemIcon(java.util.List<ItemIcon> itemIcon)
fluent setter

Parameters:
itemIcon - required parameter
See Also:
#setItemIcon(List)

withMaxSnippetLines

public ListStyle withMaxSnippetLines(int maxSnippetLines)
fluent setter

Parameters:
maxSnippetLines - required parameter
See Also:
setMaxSnippetLines(int)

withListStyleSimpleExtension

public ListStyle withListStyleSimpleExtension(java.util.List<java.lang.Object> listStyleSimpleExtension)
fluent setter

Parameters:
listStyleSimpleExtension - required parameter
See Also:
#setListStyleSimpleExtension(List)

withListStyleObjectExtension

public ListStyle withListStyleObjectExtension(java.util.List<AbstractObject> listStyleObjectExtension)
fluent setter

Parameters:
listStyleObjectExtension - required parameter
See Also:
#setListStyleObjectExtension(List)

withObjectSimpleExtension

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

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

withId

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

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

withTargetId

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

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

withSubStyleSimpleExtension

public ListStyle withSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
Description copied from class: SubStyle
fluent setter

Overrides:
withSubStyleSimpleExtension in class SubStyle
Parameters:
subStyleSimpleExtension - required parameter
See Also:
#setSubStyleSimpleExtension(List)

withSubStyleObjectExtension

public ListStyle withSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
Description copied from class: SubStyle
fluent setter

Overrides:
withSubStyleObjectExtension in class SubStyle
Parameters:
subStyleObjectExtension - required parameter
See Also:
#setSubStyleObjectExtension(List)

clone

public ListStyle clone()
Overrides:
clone in class SubStyle