TLspLayerTreeNode (LuciadFusion API documentation)

java.lang.Object
- com.luciad.view.lightspeed.layer.ALspLayer
- - com.luciad.view.lightspeed.layer.TLspLayer
  - - com.luciad.view.lightspeed.layer.TLspLayerTreeNode

All Implemented Interfaces:

ILcdPropertyChangeSource, ILcdSelection<Object>, ILcdLayer, ILcdLayered, ILcdLayerTreeNode, ILspSnappable, ILspEditableStyledLayer, ILspInteractivePaintableLayer, ILspLayer, ILspPaintableLayer, ILspStyledLayer, Serializable
```
public class TLspLayerTreeNode
extends TLspLayer
implements ILcdLayerTreeNode
```
Extension of TLspLayer that implements ILcdLayerTreeNode and hence can also have child layers.

Since:

2012.0

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.luciad.view.lightspeed.layer.ILspLayer
  ILspLayer.LayerType

Constructor Summary

Constructors
Constructor and Description
`TLspLayerTreeNode(ILcdModel aModel)` Constructs a new layer tree node for the specified model.
`TLspLayerTreeNode(ILcdModel aModel, String aLabel, ILspLayer.LayerType aLayerType)` Initializes a new `ILcdLayerTreeNode` object with given model, label and layer type.
`TLspLayerTreeNode(String aLabel)` Constructs a new instance of `ILcdLayerTreeNode` with label `aLabel`.
`TLspLayerTreeNode(String aLabel, ILcdIcon aIcon)` Constructs a new instance of `ILcdLayerTreeNode` with label `aLabel` and icon `aIcon`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHierarchyLayeredListener(ILcdLayeredListener aListener)` Registers the given `ILcdLayeredListener` to receive `TLcdLayeredEvent`s from all the `ILcdLayerTreeNode`s contained in the tree with this node as root node.
`void`	`addHierarchyPropertyChangeListener(PropertyChangeListener aListener)` Registers the given `PropertyChangeListener` to receive `PropertyChangeEvent`s from all the `ILcdLayer`s contained in the tree with this node as root node.
`void`	`addHierarchySelectionListener(ILcdSelectionListener aListener)` Registers the given `ILcdSelectionListener` to receive `TLcdSelectionChangedEvent`s from all the `ILcdLayer`s contained in the tree with this node as root node.
`boolean`	`addLayer(ILcdLayer aNewChildNode)` Adds a new node to the tree as a child of this node.
`boolean`	`addLayer(ILcdLayer aNewChildNode, int aIndex)` Adds a new node to the tree as a child of this node.
`void`	`addLayeredListener(ILcdLayeredListener aListener)` Registers the given `ILcdLayeredListener` to be notified when layers are added, removed or moved.
`boolean`	`addLayers(Collection<ILspLayer> aLayers)` Adds multiple child layers to this tree node.
`boolean`	`containsLayer(ILcdLayer aLayer)` Returns whether this `ILcdLayered` contains the given layer.
`ILcdInitialLayerIndexProvider`	`getInitialLayerIndexProvider()` Returns the initial layer index provider, which can be used to determine the best index when a layer is added without specifying an index.
`ILcdLayer`	`getLayer(int aIndex)` Returns the `ILcdLayer` in this `ILcdLayered` with index `aIndex`.
`List<ILspLayer>`	`getLayers()` Returns a `List` of the layers.
`ILspLayer.LayerType`	`getLayerType()` Returns the layer type of the first layer in this layer tree node.
`int`	`indexOf(ILcdLayer aLayer)` Returns the index if the given layer is in the list.
`boolean`	`isEditable()` Returns whether the layer allows editing the content that it visualizes.
`boolean`	`isEditableSupported()` Returns `true` if the layer supports editing its objects.
`boolean`	`isPaintOnTopOfChildrenHint()` Returns whether a node should be painted on top of its children when the node is added to a view, or beneath its child layers.
`boolean`	`isSelectable()` Returns whether the layer's objects can be selected, for example, by clicking on them.
`boolean`	`isSelectableSupported()` Returns `true` if this layer supports selecting objects, `false` otherwise.
`boolean`	`isSelected(Object aObject)` Checks whether the given `Object` is currently in the set of selected objects.
`int`	`layerCount()` Returns the number of `ILcdLayer` objects in this `ILcdLayered`.
`ILcdLayer`	`layerOf(ILcdModel aModel)` Returns the `ILcdLayer` of this `ILcdLayered` that contains the given `ILcdModel`.
`Enumeration`	`layers()` Returns an `Enumeration` of all `ILcdLayer` objects currently in this `ILcdLayered`, starting from the bottom layer to the top layer.
`Enumeration`	`layersBackwards()` Returns an `Enumeration` of all `ILcdLayer` objects currently in this `ILcdLayered`, starting from the top layer to the bottom layer.
`void`	`moveLayerAt(int aIndex, ILcdLayer aLayer)` Moves the given layer (which is already in `ILcdLayered`) to the existing index aIndex.
`void`	`removeAllLayers()` Removes all the `ILcdLayer` objects from this `ILcdLayered`.
`void`	`removeHierarchyLayeredListener(ILcdLayeredListener aListener)` Unregisters the given `ILcdLayeredListener` from receiving `TLcdLayeredEvent`s for the tree with this node as root node.
`void`	`removeHierarchyPropertyChangeListener(PropertyChangeListener aListener)` Unregisters the given `PropertyChangeListener` from receiving `PropertyChangeEvent`s for the tree with this node as root node.
`void`	`removeHierarchySelectionListener(ILcdSelectionListener aListener)` Unregisters the given `ILcdSelectionListener` from receiving `TLcdSelectionChangedEvent`s for the tree with this node as root node.
`void`	`removeLayer(ILcdLayer aLayer)` Removes aLayer from this `ILcdLayered`.
`void`	`removeLayer(int aIndex)` Removes the node at index `aIndex` from this node and sends the appropriate `TLcdLayeredEvent`.
`void`	`removeLayeredListener(ILcdLayeredListener aListener)` Unregisters the given `ILcdLayeredListener` from receiving layered events for the `ILcdLayered`.
`void`	`setInitialLayerIndexProvider(ILcdInitialLayerIndexProvider aInitialLayerIndexProvider)` Sets an initial layer index provider, which can be used to determine the best index when a layer is added without specifying an index.
`void`	`setPaintOnTopOfChildrenHint(boolean aPaintOnTopOfChildrenHint)` Sets whether a node should be painted on top of its children when the node is added to a view, or beneath its child layers.

Methods inherited from class com.luciad.view.lightspeed.layer.TLspLayer
addEditingStateListener, addPaintRepresentation, configureForSLDStyling, createScaleRange, createScaleRange, editedObjectChanged, editedObjectsChanged, getBounds, getEditor, getEditors, getMapScaleProvider, getMapScaleRange, getMinimumObjectSizeForPainting, getModelQueryConfiguration, getObjectsWithPaintState, getObjectViewMargin, getObjectWorldMargin, getPainter, getPainters, getPaintRepresentations, getRequiredOpenGLProfile, getScaleRange, getStyler, isCulling, isSnapTarget, isSynchronizePainters, paint, query, registerView, removeEditingStateListener, removePaintRepresentation, setCulling, setEditor, setFilter, setMapScaleProvider, setMapScaleRange, setMinimumObjectSizeForPainting, setModel, setModelQueryConfiguration, setObjectViewMargin, setObjectWorldMargin, setPainter, setScaleRange, setSelectableSupported, setSnapTarget, setStyler, setSynchronizePainters, setVisible, setVisible, setVisible, toString, unregisterView

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.luciad.view.ILcdLayerTreeNode
addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface com.luciad.view.ILcdLayer
clearSelection, fireCollectedSelectionChanges, getIcon, getLabel, getModel, isVisible, selectObject, setEditable, setIcon, setLabel, setSelectable, setVisible

Methods inherited from interface com.luciad.util.ILcdSelection
addSelectionListener, getSelectedObjects, getSelectionCount, removeSelectionListener, selectedObjects

Methods inherited from interface com.luciad.view.ILcdLayered
addLayeredListener, removeLayeredListener

Methods inherited from interface com.luciad.view.lightspeed.editor.snapping.ILspSnappable
addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface com.luciad.view.lightspeed.layer.ILspLayer
addLayerStateListener, addStatusListener, getCurrentViews, getLayerStyle, getModelXYZWorldTransformation, invalidate, isEditable, isVisible, isVisible, removeLayerStateListener, removeStatusListener, setEditable, setEditable, setLayerStyle

- Constructor Detail
  - TLspLayerTreeNode
```
public TLspLayerTreeNode(ILcdModel aModel)
```
    Constructs a new layer tree node for the specified model. The layer label will be the display name of the model descriptor, if available.
    
    The typical use-case for this method is an ILspLayerFactory which is creating a layer structure which matches the structure of an incoming ILcdModelTreeNode.
```
   @Override
   public Collection<ILspLayer> createLayers(ILcdModel aModel){
     if (aModel instanceof ILcdModelTreeNode){
       ILcdModelTreeNode modelNode = (ILcdModelTreeNode)aModel;
       TLspLayerTreeNode result = new TLspLayerTreeNode(aModel);
       for(int i = 0; i < modelNode.modelCount(); i++){
         result.addLayers(createLayers(modelNode.getModel(i)));
       }
       return result;
     } else {
       ILspLayer layer = TLspShapeLayerBuilder.newBuilder().model(aModel).build();
       return layer;
     }
   }
 
```
    Note that the above snippet assumes that the ILcdModelTreeNode itself does not contain any data (the most common scenario). In case the ILcdModelTreeNode contains data which should be visualized, you need to configure the layer tree node just as you do for a regular layer: for example setting a painter.
    Parameters:
    
    aModel - The model
    
    Since:
    
    2016.1
  - TLspLayerTreeNode
```
public TLspLayerTreeNode(String aLabel)
```
    Constructs a new instance of ILcdLayerTreeNode with label aLabel. The node will be initialized with a default, empty model.
    
    The main use-case for this constructor is the same as for the TLspLayerTreeNode(String, ILcdIcon) constructor. Consult the documentation of that constructor for more information.
    
    Parameters:
    
    aLabel - A short textual representation of this node
  - TLspLayerTreeNode
```
public TLspLayerTreeNode(String aLabel,
                         ILcdIcon aIcon)
```
    Constructs a new instance of ILcdLayerTreeNode with label aLabel and icon aIcon. The node will be initialized with a default, empty model.
    
    The typical use-case for this method is if you want to add a node to the view for grouping purposes. For example, if you have have several raster background layers which you want to group under a node in the view, you can use this constructor to create such a grouping node.
```
   ILspLayer[] rasterBackgroundLayers = ...;

   //create a node to group those background layers
   ILcdIcon icon = TLcdIconFactory.create(TLcdIconFactory.RASTER_LAYER_ICON);
   TLspLayerTreeNode node = new TLspLayerTreeNode("Background Data", icon);
   for(ILspLayer backgroundLayer : rasterBackgroundLayers){
     node.addLayer(backgroundLayer);
   }

   view.addLayer(node);
 
```
    Parameters:
    
    aLabel - A short textual representation of this node
    
    aIcon - A small visual representation of this node
  - TLspLayerTreeNode
```
public TLspLayerTreeNode(ILcdModel aModel,
                         String aLabel,
                         ILspLayer.LayerType aLayerType)
```
    Initializes a new ILcdLayerTreeNode object with given model, label and layer type.
    
    The main use-case for this constructor is the same as for the TLspLayerTreeNode(ILcdModel) constructor. Consult the documentation of that constructor for more information.
    
    Parameters:
    
    aModel - the model that is to be added to the new layer
    
    aLabel - the label of the new layer
    
    aLayerType - the LayerType of the new layer
- Method Detail
  - addLayers
```
public boolean addLayers(Collection<ILspLayer> aLayers)
```
    Adds multiple child layers to this tree node.
    
    Parameters:
    
    aLayers - the layers to add
    
    Returns:
    
    true if all layers have been added, false if the node already contained one of the layers
  - addLayer
```
public boolean addLayer(ILcdLayer aNewChildNode)
                 throws IllegalArgumentException
```
    Description copied from interface: ILcdLayerTreeNode
    
    Adds a new node to the tree as a child of this node. This newly added node will normally be the last child node, but that can be implementation specific. Implementations could for example decide to use the initial layer index provider to determine the best index to add the layer. Notice that in order to avoid loops in the tree aNewChildNode must not already be an element of the tree. This method should also generate a TLcdLayeredEvent to warn its listeners that a node has been added.
    
    Specified by:
    
    addLayer in interface ILcdLayerTreeNode
    
    Parameters:
    
    aNewChildNode - the node which must be added as a child
    
    Returns:
    
    true when the layer was successfully added to this node, false if the node already contained layer aNewChildNode
    
    Throws:
    
    IllegalArgumentException - when the node is already an element of the tree
  - addLayer
```
public boolean addLayer(ILcdLayer aNewChildNode,
                        int aIndex)
                 throws IndexOutOfBoundsException,
                        IllegalArgumentException
```
    Description copied from interface: ILcdLayerTreeNode
    
    Adds a new node to the tree as a child of this node. The child will be inserted at index aIndex in the child list of this node. Notice that in order to avoid loops in the tree aNewChildNode must not already be an element of the tree. This method should also generate a TLcdLayeredEvent to warn its listeners that a node has been added.
    
    Specified by:
    
    addLayer in interface ILcdLayerTreeNode
    
    Parameters:
    
    aNewChildNode - the new child
    
    aIndex - the index in the child list of this node for the new child
    
    Returns:
    
    true when the layer was successfully added to this node, false if the node already contained layer aNewChildNode
    
    Throws:
    
    IndexOutOfBoundsException - when index > ILcdLayerTreeNode.layerCount()
    
    IllegalArgumentException - when the node is already an element of the tree
  - removeLayer
```
public void removeLayer(ILcdLayer aLayer)
```
    Description copied from interface: ILcdLayered
    
    Removes aLayer from this ILcdLayered.
    
    Specified by:
    
    removeLayer in interface ILcdLayered
    
    Parameters:
    
    aLayer - the layer to remove.
  - removeLayer
```
public void removeLayer(int aIndex)
```
    Description copied from interface: ILcdLayerTreeNode
    
    Removes the node at index aIndex from this node and sends the appropriate TLcdLayeredEvent.
    
    Specified by:
    
    removeLayer in interface ILcdLayerTreeNode
    
    Parameters:
    
    aIndex - the index of the child node which has to be removed
  - getLayer
```
public ILcdLayer getLayer(int aIndex)
                   throws IndexOutOfBoundsException
```
    Description copied from interface: ILcdLayered
    
    Returns the ILcdLayer in this ILcdLayered with index aIndex.
    
    Specified by:
    
    getLayer in interface ILcdLayered
    
    Parameters:
    
    aIndex - the position of the layer to retrieve in the ILcdLayered.
    
    Returns:
    
    the ILcdLayer in this ILcdLayered with index aIndex.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if the given index is invalid
    
    IndexOutOfBoundsException
  - getLayers
```
public List<ILspLayer> getLayers()
```
    Description copied from interface: ILcdLayered
    
    Returns a List of the layers.
    
    Specified by:
    
    getLayers in interface ILcdLayered
    
    Returns:
    
    an unmodifiable List of the layers in this ILcdLayered
  - layerCount
```
public int layerCount()
```
    Description copied from interface: ILcdLayerTreeNode
    
    Returns the number of ILcdLayer objects in this ILcdLayered.
    This number does not include this layer node. It is the number of child layers of this node that is returned.
    
    Specified by:
    
    layerCount in interface ILcdLayered
    
    Specified by:
    
    layerCount in interface ILcdLayerTreeNode
    
    Returns:
    
    the number of ILcdLayer objects in this ILcdLayered.
  - layers
```
public Enumeration layers()
```
    Description copied from interface: ILcdLayerTreeNode
    
    Returns an Enumeration of all ILcdLayer objects currently in this ILcdLayered, starting from the bottom layer to the top layer.
    This enumeration does not include this layer node, but only the child layers.
    
    Specified by:
    
    layers in interface ILcdLayered
    
    Specified by:
    
    layers in interface ILcdLayerTreeNode
    
    Returns:
    
    an Enumeration of all ILcdLayer objects currently in this ILcdLayered, starting from the bottom layer to the top layer.
  - moveLayerAt
```
public void moveLayerAt(int aIndex,
                        ILcdLayer aLayer)
```
    Description copied from interface: ILcdLayered
    
    Moves the given layer (which is already in ILcdLayered) to the existing index aIndex. When a layer is moved down, all layers in between the previous and future position of the given layer (including the layer at index aIndex) are moved one position up. When a layer is moved up, all layers in between the previous and future position of the given layer (including the layer at index aIndex) are moved one position down.
    More formally, let previousIndex be the index of aLayer before the move. If previousIndex < aIndex, then the index of all ILcdLayer objects in from previousIndex + 1 to aIndex is decremented with 1. If previousIndex > aIndex, then the index of all ILcdLayer objects in from aIndex to previousIndex -1 is incremented with 1.
    
    Specified by:
    
    moveLayerAt in interface ILcdLayered
    
    Parameters:
    
    aIndex - the index of the position where to move the layer.
    
    aLayer - the layer to move.
  - indexOf
```
public int indexOf(ILcdLayer aLayer)
```
    Description copied from interface: ILcdLayered
    
    Returns the index if the given layer is in the list.
    
    Specified by:
    
    indexOf in interface ILcdLayered
    
    Parameters:
    
    aLayer - the layer whose index to return
    
    Returns:
    
    the index of aLayer
  - addLayeredListener
```
public void addLayeredListener(ILcdLayeredListener aListener)
```
    Description copied from interface: ILcdLayerTreeNode
    
    Registers the given ILcdLayeredListener to be notified when layers are added, removed or moved.
    
    In case you need to register a listener which keeps a reference to an object with a shorter life-time than this layered, you can use a ALcdWeakLayeredListener instance as layered listener.
    
    This layer will only be informed when child layers are added, removed or moved in this layer node. To receive the events of the whole hierarchical structure, the listener must be added as a hierarchical listener (see ILcdLayerTreeNode.addHierarchyLayeredListener(ILcdLayeredListener)).
    
    Specified by:
    
    addLayeredListener in interface ILcdLayered
    
    Specified by:
    
    addLayeredListener in interface ILcdLayerTreeNode
    
    Parameters:
    
    aListener - the listener that from now on will be notified of all changes to the ILcdLayered
    
    See Also:
    
    ILcdLayered.removeLayeredListener(com.luciad.view.ILcdLayeredListener)
  - removeLayeredListener
```
public void removeLayeredListener(ILcdLayeredListener aListener)
```
    Description copied from interface: ILcdLayerTreeNode
    
    Unregisters the given ILcdLayeredListener from receiving layered events for the ILcdLayered.
    It is not possible to remove a hierarchy listener with this method. Use ILcdLayerTreeNode.removeHierarchyLayeredListener(ILcdLayeredListener) for this purpose.
    
    Specified by:
    
    removeLayeredListener in interface ILcdLayered
    
    Specified by:
    
    removeLayeredListener in interface ILcdLayerTreeNode
    
    Parameters:
    
    aListener - the listener that will no longer be notified of changes to the ILcdLayered
    
    See Also:
    
    ILcdLayered.addLayeredListener(ILcdLayeredListener)
  - addHierarchyLayeredListener
```
public void addHierarchyLayeredListener(ILcdLayeredListener aListener)
```
    Description copied from interface: ILcdLayerTreeNode
    
    Registers the given ILcdLayeredListener to receive TLcdLayeredEvents from all the ILcdLayerTreeNodes contained in the tree with this node as root node. If the listener should only receive events for changes occurring in this node, it should be registered as a regular listener (see ILcdLayerTreeNode.addLayeredListener(ILcdLayeredListener).
    
    The source ILcdLayered of the event can be retrieved by calling TLcdLayeredEvent.getLayered() on the received TLcdLayeredEvent.
    
    Specified by:
    
    addHierarchyLayeredListener in interface ILcdLayerTreeNode
    
    Parameters:
    
    aListener - the listener
  - removeHierarchyLayeredListener
```
public void removeHierarchyLayeredListener(ILcdLayeredListener aListener)
```
    Description copied from interface: ILcdLayerTreeNode
    
    Unregisters the given ILcdLayeredListener from receiving TLcdLayeredEvents for the tree with this node as root node.
    
    Specified by:
    
    removeHierarchyLayeredListener in interface ILcdLayerTreeNode
    
    Parameters:
    
    aListener - the listener
  - addHierarchyPropertyChangeListener
```
public void addHierarchyPropertyChangeListener(PropertyChangeListener aListener)
```
    Description copied from interface: ILcdLayerTreeNode
    
    Registers the given PropertyChangeListener to receive PropertyChangeEvents from all the ILcdLayers contained in the tree with this node as root node. If the listener should only receive events for changes occurring in this layer, it should be registered as a regular listener (see ILcdLayerTreeNode.addPropertyChangeListener(java.beans.PropertyChangeListener)).
    
    The source layer of the event can be retrieved by calling EventObject.getSource() on the received PropertyChangeEvent.
    
    Specified by:
    
    addHierarchyPropertyChangeListener in interface ILcdLayerTreeNode
    
    Parameters:
    
    aListener - the listener
  - removeHierarchyPropertyChangeListener
```
public void removeHierarchyPropertyChangeListener(PropertyChangeListener aListener)
```
    Description copied from interface: ILcdLayerTreeNode
    
    Unregisters the given PropertyChangeListener from receiving PropertyChangeEvents for the tree with this node as root node.
    
    Specified by:
    
    removeHierarchyPropertyChangeListener in interface ILcdLayerTreeNode
    
    Parameters:
    
    aListener - the listener
  - addHierarchySelectionListener
```
public void addHierarchySelectionListener(ILcdSelectionListener aListener)
```
    Description copied from interface: ILcdLayerTreeNode
    
    Registers the given ILcdSelectionListener to receive TLcdSelectionChangedEvents from all the ILcdLayers contained in the tree with this node as root node. If the listener should only receive events for selection changes occurring in this layer, it should be registered as a regular listener (see ILcdSelection.addSelectionListener(com.luciad.util.ILcdSelectionListener)).
    
    The source layer of the event can be retrieved by calling TLcdSelectionChangedEvent.getSelection() on the received TLcdSelectionChangedEvent.
    
    Specified by:
    
    addHierarchySelectionListener in interface ILcdLayerTreeNode
    
    Parameters:
    
    aListener - the listener
  - removeHierarchySelectionListener
```
public void removeHierarchySelectionListener(ILcdSelectionListener aListener)
```
    Description copied from interface: ILcdLayerTreeNode
    
    Unregisters the given ILcdSelectionListener from receiving TLcdSelectionChangedEvents for the tree with this node as root node.
    
    Specified by:
    
    removeHierarchySelectionListener in interface ILcdLayerTreeNode
    
    Parameters:
    
    aListener - the listener
  - removeAllLayers
```
public void removeAllLayers()
```
    Description copied from interface: ILcdLayerTreeNode
    
    Removes all the ILcdLayer objects from this ILcdLayered.
    This method will generate a TLcdLayeredEvent indicating a layer was removed for every child layer.
    
    Specified by:
    
    removeAllLayers in interface ILcdLayered
    
    Specified by:
    
    removeAllLayers in interface ILcdLayerTreeNode
  - layersBackwards
```
public Enumeration layersBackwards()
```
    Description copied from interface: ILcdLayerTreeNode
    
    Returns an Enumeration of all ILcdLayer objects currently in this ILcdLayered, starting from the top layer to the bottom layer.
    This enumeration does not include this layer node, but only the child layers.
    
    Specified by:
    
    layersBackwards in interface ILcdLayered
    
    Specified by:
    
    layersBackwards in interface ILcdLayerTreeNode
    
    Returns:
    
    an Enumeration of all ILcdLayer objects currently in this ILcdLayered, starting from the top layer to the bottom layer.
  - layerOf
```
public ILcdLayer layerOf(ILcdModel aModel)
                  throws NoSuchElementException
```
    Description copied from interface: ILcdLayered
    
    Returns the ILcdLayer of this ILcdLayered that contains the given ILcdModel.
    
    Specified by:
    
    layerOf in interface ILcdLayered
    
    Parameters:
    
    aModel - the model to check for in this ILcdLayered.
    
    Returns:
    
    the ILcdLayer of this ILcdLayered that contains the given ILcdModel.
    
    Throws:
    
    NoSuchElementException - if there is no layer containing the given model
  - containsLayer
```
public boolean containsLayer(ILcdLayer aLayer)
```
    Description copied from interface: ILcdLayerTreeNode
    
    Returns whether this ILcdLayered contains the given layer. More formally, returns true if and only if the ILcdLayered contains at least one layer l such that (aLayer==null ? l==null : aLayer.equals(l)).
    Calling this method with this node as parameter will return false, since this method only checks the child layers and not the layer node itself.
    
    Specified by:
    
    containsLayer in interface ILcdLayered
    
    Specified by:
    
    containsLayer in interface ILcdLayerTreeNode
    
    Parameters:
    
    aLayer - the layer to check whether it is in this layered.
    
    Returns:
    
    true if aLayer is in this ILcdLayered, false otherwise.
  - setPaintOnTopOfChildrenHint
```
public void setPaintOnTopOfChildrenHint(boolean aPaintOnTopOfChildrenHint)
```
    Description copied from interface: ILcdLayerTreeNode
    
    Sets whether a node should be painted on top of its children when the node is added to a view, or beneath its child layers. Notice that this is only a hint, hence the paint order of the node and its children is not guaranteed.
    
    This property must be set before the node is added to the view. Otherwise it will have no effect. Changing it afterwards will have no effect, unless the node is removed and re-added to the view.
    
    The default behavior is to paint nodes underneath the child layers.
    
    Specified by:
    
    setPaintOnTopOfChildrenHint in interface ILcdLayerTreeNode
    
    Parameters:
    
    aPaintOnTopOfChildrenHint - true when a node should be painted on top of its children, false when the node should be painted underneath its child layers
    
    See Also:
    
    ILcdLayerTreeNode.isPaintOnTopOfChildrenHint()
  - isPaintOnTopOfChildrenHint
```
public boolean isPaintOnTopOfChildrenHint()
```
    Description copied from interface: ILcdLayerTreeNode
    
    Returns whether a node should be painted on top of its children when the node is added to a view, or beneath its child layers.
    
    Specified by:
    
    isPaintOnTopOfChildrenHint in interface ILcdLayerTreeNode
    
    Returns:
    
    true when a node should be painted on top of its children, false when the node should be painted underneath its child layers
    
    See Also:
    
    ILcdLayerTreeNode.setPaintOnTopOfChildrenHint(boolean)
  - getInitialLayerIndexProvider
```
public ILcdInitialLayerIndexProvider getInitialLayerIndexProvider()
```
    Description copied from interface: ILcdLayerTreeNode
    
    Returns the initial layer index provider, which can be used to determine the best index when a layer is added without specifying an index.
    
    It is however up to the implementation to decide whether it uses the ILcdInitialLayerIndexProvider.
    
    Specified by:
    
    getInitialLayerIndexProvider in interface ILcdLayerTreeNode
    
    Returns:
    
    the initial layer index provider. Can be null
    
    See Also:
    
    ILcdLayerTreeNode.setInitialLayerIndexProvider(ILcdInitialLayerIndexProvider)
  - setInitialLayerIndexProvider
```
public void setInitialLayerIndexProvider(ILcdInitialLayerIndexProvider aInitialLayerIndexProvider)
```
    Description copied from interface: ILcdLayerTreeNode
    
    Sets an initial layer index provider, which can be used to determine the best index when a layer is added without specifying an index.
    
    Specified by:
    
    setInitialLayerIndexProvider in interface ILcdLayerTreeNode
    
    Parameters:
    
    aInitialLayerIndexProvider - The new initial layer index provider. May be null
    
    See Also:
    
    ILcdLayerTreeNode.getInitialLayerIndexProvider()
  - isEditableSupported
```
public boolean isEditableSupported()
```
    Description copied from class: TLspLayer
    
    Returns true if the layer supports editing its objects. This implementation returns true if the layer has an editor.
    
    Specified by:
    
    isEditableSupported in interface ILcdLayer
    
    Overrides:
    
    isEditableSupported in class TLspLayer
    
    Returns:
    
    true
    
    See Also:
    
    ILcdLayer.setEditable(boolean)
  - isSelectableSupported
```
public boolean isSelectableSupported()
```
    Description copied from class: TLspLayer
    
    Returns true if this layer supports selecting objects, false otherwise.
    
    Specified by:
    
    isSelectableSupported in interface ILcdLayer
    
    Overrides:
    
    isSelectableSupported in class TLspLayer
    
    Returns:
    
    true
    
    See Also:
    
    TLspLayer.setSelectableSupported(boolean)
  - isSelectable
```
public boolean isSelectable()
```
    Description copied from interface: ILcdLayer
    
    Returns whether the layer's objects can be selected, for example, by clicking on them.
    
    Specified by:
    
    isSelectable in interface ILcdLayer
    
    Overrides:
    
    isSelectable in class ALspLayer
    
    Returns:
    
    true if the layer allows selection, false otherwise.
    
    See Also:
    
    ILcdSelection, ILcdLayer.setSelectable(boolean)
  - isEditable
```
public boolean isEditable()
```
    Description copied from interface: ILcdLayer
    
    Returns whether the layer allows editing the content that it visualizes.
    
    Specified by:
    
    isEditable in interface ILcdLayer
    
    Overrides:
    
    isEditable in class ALspLayer
    
    Returns:
    
    true if this ILcdLayer is editable, false otherwise
    
    See Also:
    
    ILcdLayer.setEditable(boolean)
  - isSelected
```
public boolean isSelected(Object aObject)
                   throws IllegalArgumentException
```
    Description copied from interface: ILcdSelection
    
    Checks whether the given Object is currently in the set of selected objects.
    
    Specified by:
    
    isSelected in interface ILcdSelection<Object>
    
    Overrides:
    
    isSelected in class ALspLayer
    
    Parameters:
    
    aObject - the Object to be checked.
    
    Returns:
    
    true if the Object is in this ILcdSelection, false otherwise.
    
    Throws:
    
    IllegalArgumentException
  - getLayerType
```
public ILspLayer.LayerType getLayerType()
```
    Returns the layer type of the first layer in this layer tree node.
    If this layer tree node is empty, returns EDITABLE.
    
    Specified by:
    
    getLayerType in interface ILspLayer
    
    Overrides:
    
    getLayerType in class TLspLayer
    
    Returns:
    
    The layer type of the first layer in this tree node, or EDITABLE if empty.
    
    See Also:
    
    ILspLayer.LayerType

LuciadFusionClass TLspLayerTreeNode

Nested Class Summary

Nested classes/interfaces inherited from interface com.luciad.view.lightspeed.layer.ILspLayer

Constructor Summary

Method Summary

Methods inherited from class com.luciad.view.lightspeed.layer.TLspLayer

Methods inherited from class com.luciad.view.lightspeed.layer.ALspLayer

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.view.ILcdLayerTreeNode

Methods inherited from interface com.luciad.view.ILcdLayer

Methods inherited from interface com.luciad.util.ILcdSelection

Methods inherited from interface com.luciad.view.ILcdLayered

Methods inherited from interface com.luciad.view.lightspeed.editor.snapping.ILspSnappable

Methods inherited from interface com.luciad.view.lightspeed.layer.ILspLayer

Constructor Detail

TLspLayerTreeNode

TLspLayerTreeNode

TLspLayerTreeNode

TLspLayerTreeNode

Method Detail

addLayers

addLayer

addLayer

removeLayer

removeLayer

getLayer

getLayers

layerCount

layers

moveLayerAt

indexOf

addLayeredListener

removeLayeredListener

addHierarchyLayeredListener

removeHierarchyLayeredListener

addHierarchyPropertyChangeListener

removeHierarchyPropertyChangeListener

addHierarchySelectionListener

removeHierarchySelectionListener

removeAllLayers

layersBackwards

layerOf

containsLayer

setPaintOnTopOfChildrenHint

isPaintOnTopOfChildrenHint

getInitialLayerIndexProvider

setInitialLayerIndexProvider

isEditableSupported

isSelectableSupported

isSelectable

isEditable

isSelected

getLayerType