LayerGroup (iObjects Java Help)

java.lang.Object
- com.supermap.data.InternalHandle
- - com.supermap.mapping.Layer
  - - com.supermap.mapping.LayerGroup

直接已知子类:

LayerMosaicGroup, LayerSnapshot
```
public class LayerGroup
extends Layer
```
分组图层类。分组图层用来对图层进行分组管理，并可以实现同组图层的统一控制，如可见性控制。分组图层也是图层的一种，只是他的主要功能是管理图层，包括管理分组图层，即分组图层可以嵌套（分组中还可以包含分组）。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`add(Layer layer)` 向当前分组图层中添加新的图层。
`LayerGroup`	`addGroup(String groupName)` 向当前分组图层中添加一个新的分组图层，即嵌套一个分组图层。
`void`	`addLayerAddedListener(LayerAddedListener l)` 添加一个用于接收向分组图层添加图层结束事件（`LayerAddedEvent`）的监听器。
`void`	`addLayerRemovedListener(LayerRemovedListener l)` 添加一个用于接收从分组图层移除图层结束事件（`LayerRemovedEvent`）的监听器。
`Layer`	`findLayer(String layerName)` 返回指定图层名称的图层对象。
`Layer`	`get(int index)` 根据指定的索引值返回对应的图层。
`String`	`getAvailableCaption(String layerCaption)` 获取可用的别名，如果别名已被占用，则在别名尾部增加数值
`int`	`getCount()` 返回当前分组图层中所管理的图层个数。
`int`	`indexOf(Layer layer)` 返回指定图层在当前分组图层下的索引值。
`void`	`insert(int index, Layer layer)` 向当前分组图层中的指定位置插入新的图层。
`LayerGroup`	`insertGroup(int index, String groupName)` 向当前分组图层中的指定索引位置添加一个新的分组图层，即嵌套一个分组图层。
`Layer`	`insertLayer(int index, String layerXml)` 插入图层到对应位置
`boolean`	`remove(Layer layer)` 从分组图层中移除指定的图层。
`boolean`	`removeGroup(LayerGroup group)` 从当前分组图层中移除指定的分组图层。
`void`	`removeLayerAddedListener(LayerAddedListener l)` 移除一个用于接收向分组图层添加图层结束事件（`LayerAddedEvent`）的监听器。
`void`	`removeLayerRemovedListener(LayerRemovedListener l)` 移除一个用于接收从分组图层移除图层结束事件（`LayerRemovedEvent`）的监听器。
`boolean`	`ungroup()` 取消当前分组图层的分组管理，取消后，当前分组图层下的所有内容将移到当前分组图层的上一级进行管理。

从类继承的方法 com.supermap.mapping.Layer
addCaptionChangedListener, addEditableChangedListener, addElementDrawingListener, addGridFunction, addSelectableChangedListener, addSnapableChangedListener, addVisibleChangedListener, checkLayerSubType, clearThemeElementPositions, fromXML, getAdditionalSetting, getBlendMode, getBounds, getCaption, getClipRegion, getDataset, getDeduplicateThreshold, getDeduplicateTolerance, getDescription, getDisplayControledLayer, getDisplayFilter, getDisplayFilterStr, getExtensionPlugin, getExtensionUserInfo, getExternalInfo, getFieldValuesDisplayFilter, getFillMarkerOrder, getGridFunctionArgs, getGridFunctionType, getGridFunctonCount, getLayerWeight, getMap, getMaxVisibleScale, getMinVisibleGeometrySize, getMinVisibleScale, getName, getOpaqueRate, getOverlapGeometryPixel, getOverlapGeometryThreshold, getParentGroup, getParentSnapshot, getRepresentationField, getSelection, getSource, getSubLayerType, getSubType, getSymbolScale, getTheme, getThemeElementPosition, getTimeEndField, getTimeFilterEnding, getTimeFilterStarting, getTimeStartField, getTimeStepInterval, getValueExpressions, hitTest, hitTest, hitTest, hitTestGeoCompound, isAntialias, isClipRegionEnabled, isCompleteLineSymbolDisplayed, isCrossroadOptimized, isDeduplicateEnabled, isDiposed, isDisposed, isEditable, isFullLabelEnabled, isInteroperable, isLayerCacheEnabled, isModified, isOverlapDisplayed, isOverlapGeometryEnabled, isRepresentationEnabled, isSelectable, isSnapable, isSuperAndSubScript, isSwipeEnabled, isSymbolScalable, IsTimeFilterEnable, isVisible, isVisibleScale, removeCaptionChangedListener, removeEditableChangedListener, removeElementDrawingListener, removeGridFunction, removeSelectableChangedListener, removeSnapableChangedListener, removeThemeElementPosition, removeVisibleChangedListener, setAdditionalSetting, setAntialias, setBlendMode, setCaption, setClipRegion, setClipRegionEnabled, setCompleteLineSymbolDisplayed, setCrossroadOptimized, setDataset, setDeduplicateEnabled, setDeduplicateThreshold, setDeduplicateTolerance, setDescription, setDisplayControledLayer, setDisplayFilter, setDisplayFilterStr, setEditable, setExtensionUserInfo, setExternalInfo, setFillMarkerOrder, setFullLabelEnabled, setInteroperable, SetLayerCacheEnabled, SetLayerCacheRefresh, setLayerWeight, setMaxVisibleScale, setMinVisibleGeometrySize, setMinVisibleScale, setModified, setOpaqueRate, setOverlapDisplayed, setOverlapGeometryEnabled, setOverlapGeometryPixel, setOverlapGeometryThreshold, setRepresentationEnabled, setRepresentationField, setSelectable, setSelection, setSnapable, setSource, setSource, setSuperAndSubScript, setSwipeEnabled, setSymbolScalable, setSymbolScale, setThemeElementPosition, setTimeEndField, setTimeFilterEnable, setTimeFilterEnding, setTimeFilterStarting, setTimeStartField, setTimeStepInterval, setValueExpressions, setVisible, themeSymbolsToGeometries, themeSymbolsToGeometrys, themeToDatasetVector, toXML

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - getCount
```
public int getCount()
```
    返回当前分组图层中所管理的图层个数。
    
    返回:
    
    返回当前分组图层中所管理的图层个数。
  - get
```
public Layer get(int index)
```
    根据指定的索引值返回对应的图层。
    
    参数:
    
    index - 指定的索引值。
    
    返回:
    
    返回指定的索引值获取对应的图层。
  - indexOf
```
public int indexOf(Layer layer)
```
    返回指定图层在当前分组图层下的索引值。
    
    参数:
    
    layer - 指定的要获取索引值的图层。
    
    返回:
    
    返回指定图层在当前分组图层下的索引值。
  - add
```
public void add(Layer layer)
```
    向当前分组图层中添加新的图层。如果指定的图层属于其他分组，则将从原分组移动到当前分组。
    
    参数:
    
    layer - 指定的要添加到当前分组图层中的图层。
  - insert
```
public void insert(int index,
                   Layer layer)
```
    向当前分组图层中的指定位置插入新的图层。如果指定的图层属于其他分组，则将从原分组移动到当前分组。
    
    参数:
    
    index - 指定的索引值，新图层将插入到该位置。
    
    layer - 指定的要插入的新图层。
  - insertLayer
```
public Layer insertLayer(int index,
                         String layerXml)
```
    插入图层到对应位置
    
    参数:
    
    index - 所要插入的位置索引
    
    layerXml - 所要插入的图层xml
    
    返回:
    
    插入后的图层
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
    
    IllegalArgumentException - 参数异常
  - remove
```
public boolean remove(Layer layer)
```
    从分组图层中移除指定的图层。如果移除的图层为一个分组图层，将会删除该分组图层内的所有成员。
    
    参数:
    
    layer - 要移除的图层。
    
    返回:
    
    指定的要移除的图层。
  - addGroup
```
public LayerGroup addGroup(String groupName)
```
    向当前分组图层中添加一个新的分组图层，即嵌套一个分组图层。
    
    参数:
    
    groupName - 新的分组图层的名称。
    
    返回:
    
    返回新添加的分组图层。
  - insertGroup
```
public LayerGroup insertGroup(int index,
                              String groupName)
```
    向当前分组图层中的指定索引位置添加一个新的分组图层，即嵌套一个分组图层。
    
    参数:
    
    index - 指定的索引值。
    
    groupName - 新的分组图层的名称。
    
    返回:
    
    返回新添加的分组图层。
  - removeGroup
```
public boolean removeGroup(LayerGroup group)
```
    从当前分组图层中移除指定的分组图层。
    
    参数:
    
    group - 指定的要移除的分组图层。
    
    返回:
    
    一个布尔值，指示移除分组图层是否成功，true表示成功；false表示失败。
  - ungroup
```
public boolean ungroup()
```
    取消当前分组图层的分组管理，取消后，当前分组图层下的所有内容将移到当前分组图层的上一级进行管理。
    
    返回:
    
    一个布尔值，指示操作是否成功，true表示成功；false表示失败。
  - addLayerAddedListener
```
public void addLayerAddedListener(LayerAddedListener l)
```
    添加一个用于接收向分组图层添加图层结束事件（LayerAddedEvent）的监听器。
    
    参数:
    
    l - 一个用于接收向分组图层添加图层结束事件的监听器。
  - removeLayerAddedListener
```
public void removeLayerAddedListener(LayerAddedListener l)
```
    移除一个用于接收向分组图层添加图层结束事件（LayerAddedEvent）的监听器。
    
    参数:
    
    l - 一个用于接收从分组图层移除图层结束事件的监听器。
  - addLayerRemovedListener
```
public void addLayerRemovedListener(LayerRemovedListener l)
```
    添加一个用于接收从分组图层移除图层结束事件（LayerRemovedEvent）的监听器。
    
    参数:
    
    l - 一个用于接收从分组图层移除图层结束事件的监听器。
  - removeLayerRemovedListener
```
public void removeLayerRemovedListener(LayerRemovedListener l)
```
    移除一个用于接收从分组图层移除图层结束事件（LayerRemovedEvent）的监听器。
    
    参数:
    
    l - 一个用于接收从分组图层移除图层结束事件的监听器。
  - getAvailableCaption
```
public String getAvailableCaption(String layerCaption)
```
    获取可用的别名，如果别名已被占用，则在别名尾部增加数值
    
    参数:
    
    layerCaption - 所要查询的别名
    
    返回:
    
    可用别名
    
    抛出:
    
    IllegalStateException - 当前对象已被释放
    
    IllegalArgumentException - 参数为空
  - findLayer
```
public Layer findLayer(String layerName)
```
    返回指定图层名称的图层对象。
    
    覆盖:
    
    findLayer 在类中 Layer
    
    参数:
    
    layerName - 指定的图层名称。
    
    返回:
    
    返回指定图层名称的图层对象。

类 LayerGroup

方法概要

从类继承的方法 com.supermap.mapping.Layer

从类继承的方法 java.lang.Object

方法详细资料

getCount

get

indexOf

add

insert

insertLayer

remove

addGroup

insertGroup

removeGroup

ungroup

addLayerAddedListener

removeLayerAddedListener

addLayerRemovedListener

removeLayerRemovedListener

getAvailableCaption

findLayer