public class Folder extends Container implements Cloneable
A Folder is used to arrange other Features hierarchically (Folders, Placemarks, NetworkLinks, or Overlays). A Feature is visible only if it and all its ancestors are visible.
A Folder is used to arrange other Features hierarchically (Folders, Placemarks, NetworkLinks, or Overlays). A Feature is visible only if it and all its ancestors are visible.
Syntax:<Folder id="ID"> <!-- 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 -->Extends:
<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 Folder --> <!-- 0 or more Feature elements --> </Folder>
| Modifier and Type | Field and Description |
|---|---|
protected List<Feature> |
feature
|
protected List<AbstractObject> |
folderObjectExtension
|
protected List<Object> |
folderSimpleExtension |
containerObjectExtension, containerSimpleExtensionabstractView, address, atomAuthor, atomLink, description, extendedData, featureObjectExtension, featureSimpleExtension, metadata, name, open, phoneNumber, region, snippet, snippetd, styleSelector, styleUrl, timePrimitive, visibility, xalAddressDetailsid, objectSimpleExtension, targetId| Constructor and Description |
|---|
Folder() |
| Modifier and Type | Method and Description |
|---|---|
Folder |
addToContainerObjectExtension(AbstractObject containerObjectExtension)
add a value to the containerObjectExtension property collection
|
Folder |
addToContainerSimpleExtension(Object containerSimpleExtension)
add a value to the containerSimpleExtension property collection
|
Folder |
addToFeature(Feature feature)
add a value to the feature property collection
|
Folder |
addToFeatureObjectExtension(AbstractObject featureObjectExtension)
add a value to the featureObjectExtension property collection
|
Folder |
addToFeatureSimpleExtension(Object featureSimpleExtension)
add a value to the featureSimpleExtension property collection
|
Folder |
addToFolderObjectExtension(AbstractObject folderObjectExtension)
add a value to the folderObjectExtension property collection
|
Folder |
addToFolderSimpleExtension(Object folderSimpleExtension)
add a value to the folderSimpleExtension property collection
|
Folder |
addToObjectSimpleExtension(Object objectSimpleExtension)
add a value to the objectSimpleExtension property collection
|
Folder |
addToStyleSelector(StyleSelector styleSelector)
add a value to the styleSelector property collection
|
Folder |
clone() |
Document |
createAndAddDocument()
Creates a new instance of
Document and adds it to feature. |
Folder |
createAndAddFolder()
Creates a new instance of
Folder and adds it to feature. |
GroundOverlay |
createAndAddGroundOverlay()
Creates a new instance of
GroundOverlay and adds it to feature. |
NetworkLink |
createAndAddNetworkLink()
Creates a new instance of
NetworkLink and adds it to feature. |
PhotoOverlay |
createAndAddPhotoOverlay()
Creates a new instance of
PhotoOverlay and adds it to feature. |
Placemark |
createAndAddPlacemark()
Creates a new instance of
Placemark and adds it to feature. |
ScreenOverlay |
createAndAddScreenOverlay()
Creates a new instance of
ScreenOverlay and adds it to feature. |
Tour |
createAndAddTour()
Creates a new instance of
Tour and adds it to feature. |
boolean |
equals(Object obj) |
List<Feature> |
getFeature() |
List<AbstractObject> |
getFolderObjectExtension() |
List<Object> |
getFolderSimpleExtension() |
int |
hashCode() |
void |
setContainerObjectExtension(List<AbstractObject> containerObjectExtension) |
void |
setContainerSimpleExtension(List<Object> containerSimpleExtension) |
void |
setFeature(List<Feature> feature) |
void |
setFeatureObjectExtension(List<AbstractObject> featureObjectExtension) |
void |
setFeatureSimpleExtension(List<Object> featureSimpleExtension) |
void |
setFolderObjectExtension(List<AbstractObject> folderObjectExtension) |
void |
setFolderSimpleExtension(List<Object> folderSimpleExtension) |
void |
setObjectSimpleExtension(List<Object> objectSimpleExtension) |
void |
setStyleSelector(List<StyleSelector> styleSelector) |
Folder |
withAbstractView(AbstractView abstractView)
fluent setter
|
Folder |
withAddress(String address)
fluent setter
|
Folder |
withAtomAuthor(Author atomAuthor)
fluent setter
|
Folder |
withAtomLink(Link atomLink)
fluent setter
|
Folder |
withContainerObjectExtension(List<AbstractObject> containerObjectExtension)
fluent setter
|
Folder |
withContainerSimpleExtension(List<Object> containerSimpleExtension)
fluent setter
|
Folder |
withDescription(String description)
fluent setter
|
Folder |
withExtendedData(ExtendedData extendedData)
fluent setter
|
Folder |
withFeature(List<Feature> feature)
fluent setter
|
Folder |
withFeatureObjectExtension(List<AbstractObject> featureObjectExtension)
fluent setter
|
Folder |
withFeatureSimpleExtension(List<Object> featureSimpleExtension)
fluent setter
|
Folder |
withFolderObjectExtension(List<AbstractObject> folderObjectExtension)
fluent setter
|
Folder |
withFolderSimpleExtension(List<Object> folderSimpleExtension)
fluent setter
|
Folder |
withId(String id)
fluent setter
|
Folder |
withMetadata(Metadata metadata)
fluent setter
|
Folder |
withName(String name)
fluent setter
|
Folder |
withObjectSimpleExtension(List<Object> objectSimpleExtension)
fluent setter
|
Folder |
withOpen(Boolean open)
fluent setter
|
Folder |
withPhoneNumber(String phoneNumber)
fluent setter
|
Folder |
withRegion(Region region)
fluent setter
|
Folder |
withSnippet(Snippet snippet)
fluent setter
|
Folder |
withSnippetd(String snippetd)
fluent setter
|
Folder |
withStyleSelector(List<StyleSelector> styleSelector)
fluent setter
|
Folder |
withStyleUrl(String styleUrl)
fluent setter
|
Folder |
withTargetId(String targetId)
fluent setter
|
Folder |
withTimePrimitive(TimePrimitive timePrimitive)
fluent setter
|
Folder |
withVisibility(Boolean visibility)
fluent setter
|
Folder |
withXalAddressDetails(AddressDetails xalAddressDetails)
fluent setter
|
getContainerObjectExtension, getContainerSimpleExtensioncreateAndAddStyle, 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, setXalAddressDetailsgetId, getObjectSimpleExtension, getTargetId, setId, setTargetIdprotected List<Feature> feature
This is an abstract element and cannot be used directly in a KML file. The following diagram shows how some of a Feature's elements appear in Google Earth.
Syntax:<!-- abstract element; do not create -->
<!-- Feature id="ID" --> <!-- Document,Folder,
NetworkLink,Placemark,
GroundOverlay,PhotoOverlay,ScreenOverlay -->
<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> <!-- TimeStamp or TimeSpan -->
<styleUrl>...</styleUrl> <!-- anyURI -->
<StyleSelector>...</StyleSelector>
<Region>...</Region>
<Metadata>...</Metadata> <!-- deprecated in KML 2.2 -->
<ExtendedData>...</ExtendedData> <!-- new in KML 2.2 -->
<-- /Feature -->
Extends:protected List<AbstractObject> folderObjectExtension
public List<Object> getFolderSimpleExtension()
folderSimpleExtensionpublic List<AbstractObject> getFolderObjectExtension()
folderObjectExtensionpublic Tour createAndAddTour()
Tour and adds it to feature.
This method is a short version for:
Tour tour = new Tour();
this.getFeature().add(tour); public ScreenOverlay createAndAddScreenOverlay()
ScreenOverlay and adds it to feature.
This method is a short version for:
ScreenOverlay screenOverlay = new ScreenOverlay();
this.getFeature().add(screenOverlay); public PhotoOverlay createAndAddPhotoOverlay()
PhotoOverlay and adds it to feature.
This method is a short version for:
PhotoOverlay photoOverlay = new PhotoOverlay();
this.getFeature().add(photoOverlay); public GroundOverlay createAndAddGroundOverlay()
GroundOverlay and adds it to feature.
This method is a short version for:
GroundOverlay groundOverlay = new GroundOverlay();
this.getFeature().add(groundOverlay); public NetworkLink createAndAddNetworkLink()
NetworkLink and adds it to feature.
This method is a short version for:
NetworkLink networkLink = new NetworkLink();
this.getFeature().add(networkLink); public Folder createAndAddFolder()
Folder and adds it to feature.
This method is a short version for:
Folder folder = new Folder();
this.getFeature().add(folder); public Document createAndAddDocument()
Document and adds it to feature.
This method is a short version for:
Document document = new Document();
this.getFeature().add(document); public Placemark createAndAddPlacemark()
Placemark and adds it to feature.
This method is a short version for:
Placemark placemark = new Placemark();
this.getFeature().add(placemark); public Folder addToFeature(Feature feature)
feature - Objects of the following type are allowed in the list: <ContainerJAXBElement<GroundOverlayJAXBElement<NetworkLinkJAXBElement<FolderJAXBElement<PhotoOverlayJAXBElement<DocumentJAXBElement<TourJAXBElement<ScreenOverlayJAXBElement<FeatureJAXBElement<PlacemarkJAXBElement<Overlaypublic void setFolderSimpleExtension(List<Object> folderSimpleExtension)
folderSimpleExtension - folderSimpleExtensionpublic Folder addToFolderSimpleExtension(Object folderSimpleExtension)
folderSimpleExtension - Objects of the following type are allowed in the list: Objectpublic void setFolderObjectExtension(List<AbstractObject> folderObjectExtension)
folderObjectExtension - folderObjectExtensionpublic Folder addToFolderObjectExtension(AbstractObject folderObjectExtension)
folderObjectExtension - Objects of the following type are allowed in the list: AbstractObjectpublic void setObjectSimpleExtension(List<Object> objectSimpleExtension)
setObjectSimpleExtension in class ContainerobjectSimpleExtensionpublic Folder addToObjectSimpleExtension(Object objectSimpleExtension)
AbstractObjectaddToObjectSimpleExtension in class ContainerobjectSimpleExtension - Objects of the following type are allowed in the list: Objectpublic void setStyleSelector(List<StyleSelector> styleSelector)
setStyleSelector in class ContainerstyleSelectorpublic Folder addToStyleSelector(StyleSelector styleSelector)
FeatureaddToStyleSelector in class ContainerstyleSelector - Objects of the following type are allowed in the list: <StyleJAXBElement<StyleSelectorJAXBElement<StyleMappublic void setFeatureSimpleExtension(List<Object> featureSimpleExtension)
setFeatureSimpleExtension in class ContainerfeatureSimpleExtensionpublic Folder addToFeatureSimpleExtension(Object featureSimpleExtension)
FeatureaddToFeatureSimpleExtension in class ContainerfeatureSimpleExtension - Objects of the following type are allowed in the list: <DoubleJAXBElement<ObjectJAXBElement<Booleanpublic void setFeatureObjectExtension(List<AbstractObject> featureObjectExtension)
setFeatureObjectExtension in class ContainerfeatureObjectExtensionpublic Folder addToFeatureObjectExtension(AbstractObject featureObjectExtension)
FeatureaddToFeatureObjectExtension in class ContainerfeatureObjectExtension - Objects of the following type are allowed in the list: AbstractObjectpublic void setContainerSimpleExtension(List<Object> containerSimpleExtension)
setContainerSimpleExtension in class ContainercontainerSimpleExtensionpublic Folder addToContainerSimpleExtension(Object containerSimpleExtension)
ContaineraddToContainerSimpleExtension in class ContainercontainerSimpleExtension - Objects of the following type are allowed in the list: Objectpublic void setContainerObjectExtension(List<AbstractObject> containerObjectExtension)
setContainerObjectExtension in class ContainercontainerObjectExtensionpublic Folder addToContainerObjectExtension(AbstractObject containerObjectExtension)
ContaineraddToContainerObjectExtension in class ContainercontainerObjectExtension - Objects of the following type are allowed in the list: AbstractObjectpublic Folder withFeature(List<Feature> feature)
feature - required parameter#setFeature(List) public Folder withFolderSimpleExtension(List<Object> folderSimpleExtension)
folderSimpleExtension - required parameter#setFolderSimpleExtension(Listpublic Folder withFolderObjectExtension(List<AbstractObject> folderObjectExtension)
folderObjectExtension - required parameter#setFolderObjectExtension(List) public Folder withObjectSimpleExtension(List<Object> objectSimpleExtension)
AbstractObjectwithObjectSimpleExtension in class ContainerobjectSimpleExtension - required parameter#setObjectSimpleExtension(Listpublic Folder withId(String id)
AbstractObjectwithId in class Containerid - required parameterAbstractObject.setId(String)public Folder withTargetId(String targetId)
AbstractObjectwithTargetId in class ContainertargetId - required parameterAbstractObject.setTargetId(String)public Folder withName(String name)
FeaturewithName in class Containername - required parameterFeature.setName(String)public Folder withVisibility(Boolean visibility)
FeaturewithVisibility in class Containervisibility - required parameterFeature.setVisibility(Boolean)public Folder withOpen(Boolean open)
FeaturewithOpen in class Containeropen - required parameterFeature.setOpen(Boolean)public Folder withAtomAuthor(Author atomAuthor)
FeaturewithAtomAuthor in class ContaineratomAuthor - required parameterFeature.setAtomAuthor(Author)public Folder withAtomLink(Link atomLink)
FeaturewithAtomLink in class ContaineratomLink - required parameterFeature.setAtomLink(Link)public Folder withAddress(String address)
FeaturewithAddress in class Containeraddress - required parameterFeature.setAddress(String)public Folder withXalAddressDetails(AddressDetails xalAddressDetails)
FeaturewithXalAddressDetails in class ContainerxalAddressDetails - required parameterFeature.setXalAddressDetails(AddressDetails)public Folder withPhoneNumber(String phoneNumber)
FeaturewithPhoneNumber in class ContainerphoneNumber - required parameterFeature.setPhoneNumber(String)public Folder withSnippet(Snippet snippet)
FeaturewithSnippet in class Containersnippet - required parameterFeature.setSnippet(Snippet)public Folder withSnippetd(String snippetd)
FeaturewithSnippetd in class Containersnippetd - required parameterFeature.setSnippetd(String)public Folder withDescription(String description)
FeaturewithDescription in class Containerdescription - required parameterFeature.setDescription(String)public Folder withAbstractView(AbstractView abstractView)
FeaturewithAbstractView in class ContainerabstractView - required parameterFeature.setAbstractView(AbstractView)public Folder withTimePrimitive(TimePrimitive timePrimitive)
FeaturewithTimePrimitive in class ContainertimePrimitive - required parameterFeature.setTimePrimitive(TimePrimitive)public Folder withStyleUrl(String styleUrl)
FeaturewithStyleUrl in class ContainerstyleUrl - required parameterFeature.setStyleUrl(String)public Folder withStyleSelector(List<StyleSelector> styleSelector)
FeaturewithStyleSelector in class ContainerstyleSelector - required parameter#setStyleSelector(List) public Folder withRegion(Region region)
FeaturewithRegion in class Containerregion - required parameterFeature.setRegion(Region)public Folder withMetadata(Metadata metadata)
FeaturewithMetadata in class Containermetadata - required parameterFeature.setMetadata(Metadata)public Folder withExtendedData(ExtendedData extendedData)
FeaturewithExtendedData in class ContainerextendedData - required parameterFeature.setExtendedData(ExtendedData)public Folder withFeatureSimpleExtension(List<Object> featureSimpleExtension)
FeaturewithFeatureSimpleExtension in class ContainerfeatureSimpleExtension - required parameter#setFeatureSimpleExtension(Listpublic Folder withFeatureObjectExtension(List<AbstractObject> featureObjectExtension)
FeaturewithFeatureObjectExtension in class ContainerfeatureObjectExtension - required parameter#setFeatureObjectExtension(List) public Folder withContainerSimpleExtension(List<Object> containerSimpleExtension)
ContainerwithContainerSimpleExtension in class ContainercontainerSimpleExtension - required parameter#setContainerSimpleExtension(Listpublic Folder withContainerObjectExtension(List<AbstractObject> containerObjectExtension)
ContainerwithContainerObjectExtension in class ContainercontainerObjectExtension - required parameter#setContainerObjectExtension(List) Copyright © 2014 Micromata GmbH. All rights reserved.