de.micromata.opengis.kml.v_2_2_0

Class ListStyle

java.lang.Object

de.micromata.opengis.kml.v_2_2_0.AbstractObject

de.micromata.opengis.kml.v_2_2_0.SubStyle

de.micromata.opengis.kml.v_2_2_0.ListStyle

All Implemented Interfaces:

Cloneable

public class ListStyle
extends SubStyle
implements 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

Fields

Modifier and Type	Field and Description
protected String	bgColor Background color for the Snippet.
protected List<ItemIcon>	itemIcon Specifies the current state of the NetworkLink or Folder.
protected ListItemType	listItemType Specifies how a Feature is displayed in the list view.
protected List<AbstractObject>	listStyleObjectExtension
protected List<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

Constructors

Constructor and Description
ListStyle()

Method Summary

Methods

Modifier and Type	Method and Description
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(Object listStyleSimpleExtension) add a value to the listStyleSimpleExtension property collection
ListStyle	addToObjectSimpleExtension(Object objectSimpleExtension) add a value to the objectSimpleExtension property collection
ListStyle	addToSubStyleObjectExtension(AbstractObject subStyleObjectExtension) add a value to the subStyleObjectExtension property collection
ListStyle	addToSubStyleSimpleExtension(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(Object obj)
String	getBgColor()
List<ItemIcon>	getItemIcon()
ListItemType	getListItemType()
List<AbstractObject>	getListStyleObjectExtension()
List<Object>	getListStyleSimpleExtension()
int	getMaxSnippetLines()
int	hashCode()
void	setBgColor(String value)
void	setItemIcon(List<ItemIcon> itemIcon)
void	setListItemType(ListItemType value)
void	setListStyleObjectExtension(List<AbstractObject> listStyleObjectExtension)
void	setListStyleSimpleExtension(List<Object> listStyleSimpleExtension)
void	setMaxSnippetLines(int value)
void	setObjectSimpleExtension(List<Object> objectSimpleExtension)
void	setSubStyleObjectExtension(List<AbstractObject> subStyleObjectExtension) Sets the value of the subStyleObjectExtension property Objects of the following type(s) are allowed in the list List.
void	setSubStyleSimpleExtension(List<Object> subStyleSimpleExtension) Sets the value of the subStyleSimpleExtension property Objects of the following type(s) are allowed in the list List
ListStyle	withBgColor(String bgColor) fluent setter
ListStyle	withId(String id) fluent setter
ListStyle	withItemIcon(List<ItemIcon> itemIcon) fluent setter
ListStyle	withListItemType(ListItemType listItemType) fluent setter
ListStyle	withListStyleObjectExtension(List<AbstractObject> listStyleObjectExtension) fluent setter
ListStyle	withListStyleSimpleExtension(List<Object> listStyleSimpleExtension) fluent setter
ListStyle	withMaxSnippetLines(int maxSnippetLines) fluent setter
ListStyle	withObjectSimpleExtension(List<Object> objectSimpleExtension) fluent setter
ListStyle	withSubStyleObjectExtension(List<AbstractObject> subStyleObjectExtension) fluent setter
ListStyle	withSubStyleSimpleExtension(List<Object> subStyleSimpleExtension) fluent setter
ListStyle	withTargetId(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 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 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 List<Object> listStyleSimpleExtension

listStyleObjectExtension

protected List<AbstractObject> listStyleObjectExtension