com.luciad.view.gxy.asynchronous

LuciadLightspeedClass TLcdGXYAsynchronousLayerTreeNodeWrapper

java.lang.Object

com.luciad.view.gxy.asynchronous.TLcdGXYAsynchronousLayerWrapper

com.luciad.view.gxy.asynchronous.TLcdGXYAsynchronousLayerTreeNodeWrapper

All Implemented Interfaces:

ILcdPropertyChangeSource, ILcdSelection<Object>, ILcdGXYAsynchronousLayerWrapper, ILcdGXYLayer, ILcdLayer, ILcdLayered, ILcdLayerTreeNode, Serializable

public class TLcdGXYAsynchronousLayerTreeNodeWrapper
extends TLcdGXYAsynchronousLayerWrapper
implements ILcdLayerTreeNode

TLcdGXYAsynchronousLayerWrapper extension for layer nodes. It only protects the functionality offered by the ILcdGXYLayer interface. The node functionality is not protected from asynchronous painting, and should therefore not be accessed in paint-specific methods.

Since:

9.0

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.luciad.view.gxy.ILcdGXYLayer

ALL, BODIES, HANDLES, LABELS, SELECTION

Constructor Summary

Constructors

Constructor and Description
TLcdGXYAsynchronousLayerTreeNodeWrapper(ILcdGXYLayer aDecoratedLayer) Creates a layer node decorator that delegates painting to an asynchronous paint queue.
TLcdGXYAsynchronousLayerTreeNodeWrapper(ILcdGXYLayer aDecoratedLayer, ILcdGXYAsynchronousPaintQueue aPaintQueue) Creates a layer node decorator that delegates painting to an asynchronous paint queue.

Method Summary

Modifier and Type	Method and Description
void	addHierarchyLayeredListener(ILcdLayeredListener aListener) Registers the given ILcdLayeredListener to receive TLcdLayeredEvents from all the ILcdLayerTreeNodes contained in the tree with this node as root node.
void	addHierarchyPropertyChangeListener(PropertyChangeListener aListener) Registers the given PropertyChangeListener to receive PropertyChangeEvents from all the ILcdLayers contained in the tree with this node as root node.
void	addHierarchySelectionListener(ILcdSelectionListener aListener) Registers the given ILcdSelectionListener to receive TLcdSelectionChangedEvents from all the ILcdLayers 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 aLayeredListener) Registers the given ILcdLayeredListener to be notified when layers are added, removed or moved.
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.
int	indexOf(ILcdLayer aLayer) Returns the index if the given layer is in the list.
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.
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 TLcdLayeredEvents for the tree with this node as root node.
void	removeHierarchyPropertyChangeListener(PropertyChangeListener aListener) Unregisters the given PropertyChangeListener from receiving PropertyChangeEvents for the tree with this node as root node.
void	removeHierarchySelectionListener(ILcdSelectionListener aListener) Unregisters the given ILcdSelectionListener from receiving TLcdSelectionChangedEvents 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 aLayeredListener) 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.gxy.asynchronous.TLcdGXYAsynchronousLayerWrapper

addPropertyChangeListener, addSelectionListener, applyOnInteract, clearSelection, fireCollectedSelectionChanges, firePropertyChangeEvent, getAsynchronousGXYLayerChangeTracker, getBounds, getGXYAsynchronousPaintQueue, getGXYEditor, getGXYLabelPainter, getGXYLayer, getGXYPainter, getGXYPen, getIcon, getLabel, getLabelMapScaleRange, getLabelScaleRange, getMapScaleRange, getModel, getModelXYWorldTransfoClass, getScaleRange, getSelectionCount, getSynchronousGXYLayerChangeTracker, invokeAndWaitOnGXYLayer, invokeLaterOnGXYLayer, invokeLaterOnGXYLayerInEDT, invokeNowOnGXYLayer, isAsynchronous, isEditable, isEditableSupported, isLabeled, isLabeledSupported, isSelectable, isSelectableSupported, isSelected, isTraceOn, isVisible, paint, removePropertyChangeListener, removeSelectionListener, selectedObjects, selectObject, setAsynchronous, setEditable, setGXYAsynchronousPaintQueue, setIcon, setLabel, setLabeled, setSelectable, setTraceOn, setVisible, stopPainting

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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, isEditable, isEditableSupported, isSelectable, isSelectableSupported, isVisible, selectObject, setEditable, setIcon, setLabel, setSelectable, setVisible

Methods inherited from interface com.luciad.util.ILcdSelection

addSelectionListener, getSelectedObjects, getSelectionCount, isSelected, removeSelectionListener, selectedObjects

Methods inherited from interface com.luciad.view.ILcdLayered

addLayeredListener, getLayers, removeLayeredListener

Methods inherited from interface com.luciad.view.gxy.asynchronous.ILcdGXYAsynchronousLayerWrapper

create

Constructor Detail

TLcdGXYAsynchronousLayerTreeNodeWrapper

public TLcdGXYAsynchronousLayerTreeNodeWrapper(ILcdGXYLayer aDecoratedLayer)

Creates a layer node decorator that delegates painting to an asynchronous paint queue. After construction, a paint queue must be set using TLcdGXYAsynchronousLayerWrapper.setGXYAsynchronousPaintQueue(ILcdGXYAsynchronousPaintQueue)

Parameters:

aDecoratedLayer - the layer node to decorate. The node must implement ILcdLayerTreeNode.

TLcdGXYAsynchronousLayerTreeNodeWrapper

public TLcdGXYAsynchronousLayerTreeNodeWrapper(ILcdGXYLayer aDecoratedLayer,
                                               ILcdGXYAsynchronousPaintQueue aPaintQueue)

Creates a layer node decorator that delegates painting to an asynchronous paint queue.

Parameters:

aDecoratedLayer - the layer node to decorate. The node must implement ILcdLayerTreeNode. Paint-sensitive state changes are propagated to and from the wrapper.

aPaintQueue - the paint queue that handles the asynchronous paint calls

Method Detail

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

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

addLayeredListener

public void addLayeredListener(ILcdLayeredListener aLayeredListener)

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:

aLayeredListener - 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 aLayeredListener)

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:

aLayeredListener - the listener that will no longer be notified of changes to the ILcdLayered

See Also:

ILcdLayered.addLayeredListener(ILcdLayeredListener)

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

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.

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.

getLayer

public ILcdLayer getLayer(int aIndex)
                   throws ArrayIndexOutOfBoundsException

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

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

indexOf

public int indexOf(ILcdLayer aLayer)
            throws NoSuchElementException

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

Throws:

NoSuchElementException - if aLayer is not in the list

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.

removeLayer

public void removeLayer(ILcdLayer aLayer)
                 throws NoSuchElementException

Description copied from interface: ILcdLayered

Removes aLayer from this ILcdLayered.

Specified by:

removeLayer in interface ILcdLayered

Parameters:

aLayer - the layer to remove.

Throws:

NoSuchElementException

moveLayerAt

public void moveLayerAt(int aIndex,
                        ILcdLayer aLayer)
                 throws NoSuchElementException,
                        ArrayIndexOutOfBoundsException

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.

Throws:

NoSuchElementException - if aLayer is not in this ILcdLayered.

ArrayIndexOutOfBoundsException - if aIndex is not an index of one of the layers of this ILcdLayered.

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(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

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)

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()

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()