Package com.luciad.view.lightspeed.layer

Class ALspLayer

java.lang.Object

com.luciad.view.lightspeed.layer.ALspLayer

All Implemented Interfaces:

ILcdPropertyChangeSource, ILcdSelection<Object>, ILcdLayer, ILspLayer, Serializable

Direct Known Subclasses:

TLspGXYLayerAdapter, TLspLayer, TLspRasterLayer

public abstract class ALspLayer
extends Object
implements ILspLayer

Base class for implementations of ILspLayer. This class implements most functionality in ILspLayer and additionally allows:

• setting a filter
• firing property changes
• firing layer state changes
• firing status changes

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	Description
ALspLayer()	Constructs an empty layer.
ALspLayer(ILcdModel aModel)	Constructs a layer with the specified model and a default label.
ALspLayer(ILcdModel aModel, String aLabel)	Constructs a layer with the specified model and label.
ALspLayer(String aLabel)	Constructs an empty layer with the specified label.

Method Summary

Modifier and Type	Method	Description
void	addLayerStateListener(ILspLayerStateListener aListener)	Adds a state change listener to this layer.
protected void	addPaintRepresentation(TLspPaintRepresentation aPaintRepresentation)	Adds a supported paint representation.
void	addPropertyChangeListener(PropertyChangeListener listener)	Registers the given PropertyChangeListener to be notified when this object's properties change.
void	addSelectionListener(ILcdSelectionListener<Object> aSelectionListener)	Adds a listener to this selection.
void	addStatusListener(ILcdStatusListener<ILspLayer> aStatusListener)	Adds a status listener to this layer that is notified when the layer starts work asynchronously, when it is in progress, and when it is finished.
void	clearSelection(int aDispatchEventMode)	Deselect all the Objects in this ILcdLayer, i.e., the selection of this ILcdLayer is empty afterward.
protected ILcdModelXYZWorldTransformation	createModelXYZWorldTransformation(ILcdModelReference aModelReference, ILcdXYZWorldReference aWorldReference, ILspView aView)	Creates a new model world transformation for the given model and world reference.
void	fireCollectedSelectionChanges()	Fires a TLcdSelectionChangedEvent that contains all the selection changes appended by successively calling selectObject(Object, boolean, ILcdFireEventMode.FIRE_LATER).
protected void	fireLayerStateChange(TLspLayerPaintStateEvent aEvent)	Fires a layer state change event.
void	fireLayerStateChange(TLspLayerPaintStateEvent.Type aType, TLspPaintRepresentationState aPaintRepresentationState, Object aOldValue, Object aNewValue)	Fires a layer state change event with the specified properties.
protected void	fireLayerStateChange(TLspLayerStateEvent aEvent)	Fires a layer state change event.
void	fireLayerStateChange(TLspLayerStateEvent.Type aType, TLspPaintRepresentation aPaintRepresentation, Object aOldValue, Object aNewValue)	Fires a layer state change event with the specified properties.
protected void	firePropertyChange(PropertyChangeEvent aEvent)	Fires a property change event for this layer.
protected void	fireStatusEvent(TLcdStatusEvent<ILspLayer> aStatusEvent)	Fires a status event.
ILcdBounds	getBounds(TLspContext aContext)	Returns the bounds of the layer in world coordinates.
Collection<ILspView>	getCurrentViews()	Returns a collection of all the views in which this layer is currently present.
ILcdDynamicFilter	getFilter()	Returns the current ILcdDynamicFilter that filters the objects on this layer.
ILcdIcon	getIcon()	Returns a visual indication of the contents of this layer.
String	getLabel()	A short textual representation of this ILcdLayer.
TLspLayerStyle	getLayerStyle()	Gets the current layer style.
ILspLayer.LayerType	getLayerType()	Returns ILspLayer.LayerType.EDITABLE.
TLcdDimensionInterval<TLcdMapScale>	getMapScaleRange(TLspPaintRepresentation aPaintRepresentation)	Returns the scale range of a TLspPaintRepresentation of this layer in unitless map scale ratios.
ILcdModel	getModel()	Gets the ILcdModel currently associated to this layer.
ILcdModelXYZWorldTransformation	getModelXYZWorldTransformation(ILspView aView)	Returns the transformation that will be used to transform coordinates of the objects in the model to world coordinates of the given view.
Collection<TLspPaintRepresentation>	getPaintRepresentations()	No paint representations are supported by default.
int	getSelectionCount()	Returns the number of objects in this selection.
void	invalidate()	Convenience method to indicate that the representation of the model is no longer valid.
boolean	isEditable()	Returns whether the layer allows editing the content that it visualizes.
boolean	isEditable(TLspPaintRepresentation aPaintRepresentation)	Returns whether the specified PaintRepresentation is editable or not.
boolean	isEditableSupported()	Returns true if the layer supports editing its objects.
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.
boolean	isSynchronous()	Returns if this layer paints synchronously.
boolean	isVisible()	Returns whether or not the layer's content is painted.
boolean	isVisible(TLspPaintRepresentation aPaintRepresentation)	Returns whether one of the TLspPaintRepresentationStates of the the specified TLspPaintRepresentation is enabled.
boolean	isVisible(TLspPaintRepresentationState aPaintRepresentationState)	Returns whether the specified PaintRepresentationState is enabled or not.
void	registerView(ILspView aView)	Registers a view with this layer.
void	removeLayerStateListener(ILspLayerStateListener aListener)	Removes the specified state listener from this layer.
protected void	removePaintRepresentation(TLspPaintRepresentation aPaintRepresentation)	Removes a supported paint representation.
void	removePropertyChangeListener(PropertyChangeListener listener)	De-registers the given PropertyChangeListener from receiving property change events for this object.
void	removeSelectionListener(ILcdSelectionListener<Object> aSelectionListener)	Removes an ILcdSelectionListener from this ILcdSelection.
void	removeStatusListener(ILcdStatusListener<ILspLayer> aStatusListener)	Removes a previously added status listener from this layer.
Enumeration<Object>	selectedObjects()	Returns the objects in this selection.
void	selectObject(Object aObject, boolean aSelection, int aDispatchEventMode)	Changes the selection state of any element contained in the ILcdModel this ILcdLayer refers to.
void	selectObjects(Collection<Object> aObjects, boolean aSelection, int aDispatchEventMode)	Changes the selection state for the given collection of objects contained in the ILcdModel this layer refers to.
void	setEditable(boolean aEditable)	Sets whether the layer should allow editing the content that it visualizes.
void	setEditable(TLspPaintRepresentation aPaintRepresentation, boolean aEditable)	Enables or disables the editable property of a paint representation.
void	setFilter(ILcdDynamicFilter aFilter)	Sets the ILcdDynamicFilter to filter the objects on this layer.
void	setIcon(ILcdIcon aIcon)	Sets a visual indication of the contents of this layer.
void	setLabel(String aLabel)	Sets the textual representation of this ILcdLayer.
void	setLayerStyle(TLspLayerStyle aLayerStyle)	Sets a layer style to this layer.
void	setMapScaleRange(TLspPaintRepresentation aPaintRepresentation, TLcdDimensionInterval<TLcdMapScale> aMapScaleRange)	Sets the scale range of this layer to the given unitless map scale ratio range.
void	setModel(ILcdModel aModel)	Sets the ILcdModel to this layer.
void	setSelectable(boolean aSelectable)	Sets the Selectable property of this ILcdLayer.
void	setSynchronous(boolean aSynchronous)	Specifies whether this layer should paint synchronously.
void	setVisible(boolean aVisible)	Sets whether or not the layer's content is painted.
void	setVisible(TLspPaintRepresentation aPaintRepresentation, boolean aVisible)	Enables or disables all TLspPaintRepresentationStates of the specified TLspPaintRepresentation.
void	setVisible(TLspPaintRepresentationState aPaintRepresentationState, boolean aVisible)	Enables or disables the a paint representation state.
void	unregisterView(ILspView aView)	Unregisters a view from this layer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.luciad.util.ILcdSelection

getSelectedObjects

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

getMapScaleProvider

Constructor Details

ALspLayer

public ALspLayer()

Constructs an empty layer.

ALspLayer

public ALspLayer(String aLabel)

Constructs an empty layer with the specified label.

Parameters:

aLabel - the label

ALspLayer

public ALspLayer(ILcdModel aModel)

Constructs a layer with the specified model and a default label.

Parameters:

aModel - the model

ALspLayer

public ALspLayer(ILcdModel aModel,
 String aLabel)

Constructs a layer with the specified model and label.

Parameters:

aModel - the model

aLabel - the label

Method Details

isSynchronous

public boolean isSynchronous()

Returns if this layer paints synchronously.

Returns:

if this layer paints synchronously.

See Also:

• setSynchronous(boolean)

setSynchronous

public void setSynchronous(boolean aSynchronous)

Specifies whether this layer should paint synchronously. The default is false and allows layers to perform shape discretization and other expensive processing using the view's ILspTaskExecutor. When synchronous mode is on, all such tasks are performed on the EDT.

It is strongly recommended to leave this setting off, to ensure that the application remains responsive. Applications that need to change the view's world reference on a regular basis, however, may want to consider synchronous mode to avoid flickering.

Parameters:

aSynchronous - true if the layer should paint synchronously

See Also:

• isSynchronous()

getLayerType

public ILspLayer.LayerType getLayerType()

Returns ILspLayer.LayerType.EDITABLE. Implementing classes can override this method to return other values.

Specified by:

getLayerType in interface ILspLayer

Returns:

LayerType#EDITABLE

See Also:

• ILspLayer.LayerType

registerView

public void registerView(ILspView aView)

Description copied from interface: ILspLayer

Registers a view with this layer. This method is called by the view when this layer is added to it. When the layer is removed from the view, the view invokes ILspLayer.unregisterView(com.luciad.view.lightspeed.ILspView). This allows the layer to know at all times in which views it is currently present; this information may help it to manage any data that it caches.

Specified by:

registerView in interface ILspLayer

Parameters:

aView - the view to which this layer has been added

unregisterView

public void unregisterView(ILspView aView)

Description copied from interface: ILspLayer

Unregisters a view from this layer. This method is called by the view when this layer is removed from it. Along with ILspLayer.registerView(com.luciad.view.lightspeed.ILspView), this method determines the result of ILspLayer.getCurrentViews().

Specified by:

unregisterView in interface ILspLayer

Parameters:

aView - the view from which this layer has been removed

getCurrentViews

public Collection<ILspView> getCurrentViews()

Description copied from interface: ILspLayer

Returns a collection of all the views in which this layer is currently present. This list is kept up-to-date via the view's invocations of ILspLayer.registerView(com.luciad.view.lightspeed.ILspView) and ILspLayer.unregisterView(com.luciad.view.lightspeed.ILspView).

The returned collection should not be modified.

Specified by:

getCurrentViews in interface ILspLayer

Returns:

a collection of views in which this layer is currently present

See Also:

• ILspLayer.registerView(com.luciad.view.lightspeed.ILspView)
• ILspLayer.unregisterView(com.luciad.view.lightspeed.ILspView)

getModel

public ILcdModel getModel()

Gets the ILcdModel currently associated to this layer.

Specified by:

getModel in interface ILcdLayer

Returns:

the ILcdModel associated to this ILcdLayer

setModel

public void setModel(ILcdModel aModel)

Sets the ILcdModel to this layer.

This method is not thread safe, it is recommended to synchronize on the layer instance if needed.

Parameters:

aModel - the model that contains the objects that should be displayed in this layer.

invalidate

public void invalidate()

Convenience method to indicate that the representation of the model is no longer valid. Call this method after modifying settings that influence the representation of the model, but are not properties of the layer itself. This method does not have to be called when setting a property of the layer itself (for example, calling setVisible) as setting such a property will inform listeners that the representation of the model is no longer valid.

Specified by:

invalidate in interface ILspLayer

setVisible

public void setVisible(boolean aVisible)

Sets whether or not the layer's content is painted.

This method is not thread safe, it is recommended to synchronize on the layer instance if needed.

Specified by:

setVisible in interface ILcdLayer

Specified by:

setVisible in interface ILspLayer

Parameters:

aVisible - true if the layer should be visible, false otherwise.

See Also:

• ILcdLayer.isVisible()

getFilter

public ILcdDynamicFilter getFilter()

Returns the current ILcdDynamicFilter that filters the objects on this layer.

Returns:

the filter that accepts only those objects that should be taken into account or null

See Also:

• setFilter(com.luciad.util.ILcdDynamicFilter)

setFilter

public void setFilter(ILcdDynamicFilter aFilter)

Sets the ILcdDynamicFilter to filter the objects on this layer. Operations on this layer will only be applied to objects of the model that pass the filter. This includes painting, labeling, selection, editing, ...

Setting a null filter, lets all objects pass for rendering. By default the filter is null.

This method is not thread safe, it is recommended to synchronize on the layer instance if needed.

Parameters:

aFilter - the filter that accepts only those objects that should be taken into account

See Also:

• getFilter()

isVisible

public boolean isVisible()

Description copied from interface: ILcdLayer

Returns whether or not the layer's content is painted.

Specified by:

isVisible in interface ILcdLayer

Returns:

true if the layer is visible, false otherwise.

See Also:

• ILcdLayer.setVisible(boolean)

setVisible

public void setVisible(TLspPaintRepresentationState aPaintRepresentationState,
 boolean aVisible)

Description copied from interface: ILspLayer

Enables or disables the a paint representation state.

This can be used to quickly switch representations (e.g. labels) on and off without having to remove its related properties (ex. a painter).

Note that this method is independent of the layer visibility. So a paint representation state will only be visible when this method and the ILcdLayer.isVisible() method return true.

Specified by:

setVisible in interface ILspLayer

Parameters:

aPaintRepresentationState - the representations to enable or disable

aVisible - true to enable the representations or false to disable it

See Also:

• ILspLayer.setVisible(boolean)

isVisible

public boolean isVisible(TLspPaintRepresentationState aPaintRepresentationState)

Description copied from interface: ILspLayer

Returns whether the specified PaintRepresentationState is enabled or not.

Specified by:

isVisible in interface ILspLayer

Parameters:

aPaintRepresentationState - the paint representation to check

Returns:

whether the specified PaintRepresentationState is enabled or not

See Also:

• ILspLayer.setVisible(TLspPaintRepresentationState, boolean)

setVisible

public void setVisible(TLspPaintRepresentation aPaintRepresentation,
 boolean aVisible)

Description copied from interface: ILspLayer

Enables or disables all TLspPaintRepresentationStates of the specified TLspPaintRepresentation.

This can be used to quickly switch representations (e.g. labels) on and off without having to remove its related properties (ex. a painter).

Specified by:

setVisible in interface ILspLayer

Parameters:

aPaintRepresentation - the representation to enable or disable

aVisible - true to enable the representations or false to disable it

See Also:

• ILspLayer.setVisible(TLspPaintRepresentationState, boolean)

isVisible

public boolean isVisible(TLspPaintRepresentation aPaintRepresentation)

Description copied from interface: ILspLayer

Returns whether one of the TLspPaintRepresentationStates of the the specified TLspPaintRepresentation is enabled.

Specified by:

isVisible in interface ILspLayer

Parameters:

aPaintRepresentation - the paint representation to check

Returns:

whether the specified PaintRepresentation is enabled or not

See Also:

• ILspLayer.setVisible(TLspPaintRepresentation, boolean)

isEditableSupported

public boolean isEditableSupported()

Description copied from interface: ILcdLayer

Returns true if the layer supports editing its objects.

Specified by:

isEditableSupported in interface ILcdLayer

Returns:

true

See Also:

• ILcdLayer.setEditable(boolean)

setEditable

public void setEditable(boolean aEditable)

Description copied from interface: ILcdLayer

Sets whether the layer should allow editing the content that it visualizes. Check isEditableSupported to see if the layer supports editing.

Specified by:

setEditable in interface ILcdLayer

Specified by:

setEditable in interface ILspLayer

Parameters:

aEditable - true if the layer content can be edited

See Also:

• ILcdLayer.isEditableSupported()
• ILcdLayer.isEditable()

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

Returns:

true if this ILcdLayer is editable, false otherwise

See Also:

• ILcdLayer.setEditable(boolean)

setEditable

public void setEditable(TLspPaintRepresentation aPaintRepresentation,
 boolean aEditable)

Description copied from interface: ILspLayer

Enables or disables the editable property of a paint representation.

This can be used to quickly switch editing for representations (e.g. labels) on and off without having to remove its related properties (ex. a painter).

Note that this method is independent of the layer editability. So paint representation will only be editable when both the layer and the paint representation are editable and editing is supported.

Specified by:

setEditable in interface ILspLayer

Parameters:

aPaintRepresentation - the representation to enable or disable

aEditable - true to enable the representations or false to disable it

See Also:

• ILspLayer.setEditable(boolean)
• ILcdLayer.isEditableSupported()

isEditable

public boolean isEditable(TLspPaintRepresentation aPaintRepresentation)

Description copied from interface: ILspLayer

Returns whether the specified PaintRepresentation is editable or not.

Specified by:

isEditable in interface ILspLayer

Parameters:

aPaintRepresentation - the paint representation to check

Returns:

whether the specified PaintRepresentation is editable or not

See Also:

• ILspLayer.setEditable(TLspPaintRepresentation, boolean)

getLabel

public String getLabel()

Description copied from interface: ILcdLayer

A short textual representation of this ILcdLayer.

Specified by:

getLabel in interface ILcdLayer

Returns:

a short textual representation of this ILcdLayer

setLabel

public void setLabel(String aLabel)

Sets the textual representation of this ILcdLayer.

This method is not thread safe, it is recommended to synchronize on the layer instance if needed.

Specified by:

setLabel in interface ILcdLayer

Parameters:

aLabel - the the textual representation to use for this ILcdLayer.

getIcon

public ILcdIcon getIcon()

Description copied from interface: ILcdLayer

Returns a visual indication of the contents of this layer. For example, for a grid layer, an icon containing a grid could be used.

Specified by:

getIcon in interface ILcdLayer

Returns:

a visual indication of the contents of this layer.

setIcon

public void setIcon(ILcdIcon aIcon)

Description copied from interface: ILcdLayer

Sets a visual indication of the contents of this layer.

Specified by:

setIcon in interface ILcdLayer

Parameters:

aIcon - a visual indication of the contents of this layer.

See Also:

• ILcdLayer.getIcon()

getMapScaleRange

public TLcdDimensionInterval<TLcdMapScale> getMapScaleRange(TLspPaintRepresentation aPaintRepresentation)

Returns the scale range of a TLspPaintRepresentation of this layer in unitless map scale ratios. If configured, the layer contents are only shown if and when the view's map scale is larger than the interval's minimum and smaller than the interval's maximum.

Parameters:

aPaintRepresentation - the paint representation for which to return the scale range

Returns:

the scale range

Throws:

IllegalArgumentException - if aPaintRepresentation is not supported

Since:

2021.1

See Also:

• setMapScaleRange(com.luciad.view.lightspeed.layer.TLspPaintRepresentation, com.luciad.multidimensional.TLcdDimensionInterval<com.luciad.view.TLcdMapScale>)

setMapScaleRange

public void setMapScaleRange(TLspPaintRepresentation aPaintRepresentation,
 TLcdDimensionInterval<TLcdMapScale> aMapScaleRange)

Sets the scale range of this layer to the given unitless map scale ratio range. If configured, the layer contents are only shown if and when the view's map scale is larger than the interval's minimum and smaller than the interval's maximum.

Parameters:

aPaintRepresentation - the paint representation

aMapScaleRange - the new scale range of this layer, or null to deactivate any scale restriction

Throws:

IllegalArgumentException - if aPaintRepresentation is not supported

Since:

2021.1

See Also:

• TLspLayer.setMapScaleRange(TLspPaintRepresentation, TLcdDimensionInterval)
• TLcdMapScale.createScaleRange(TLcdMapScale, TLcdMapScale)

getPaintRepresentations

public Collection<TLspPaintRepresentation> getPaintRepresentations()

No paint representations are supported by default.

Specified by:

getPaintRepresentations in interface ILspLayer

Returns:

a collection of PaintRepresentations, never null

addPaintRepresentation

protected void addPaintRepresentation(TLspPaintRepresentation aPaintRepresentation)

Adds a supported paint representation.

Parameters:

aPaintRepresentation - the paint representation

See Also:

• initializePaintRepresentation(TLspPaintRepresentation)

removePaintRepresentation

protected void removePaintRepresentation(TLspPaintRepresentation aPaintRepresentation)

Removes a supported paint representation.

Parameters:

aPaintRepresentation - the paint representation

getModelXYZWorldTransformation

public ILcdModelXYZWorldTransformation getModelXYZWorldTransformation(ILspView aView)

Returns the transformation that will be used to transform coordinates of the objects in the model to world coordinates of the given view.

In order for this method to be thread-safe, the model-world transformation should not be modified after it is returned by this method. In practice this means that this method and its callers should treat the model-world transformation as an immutable object. So it shouldn't reuse the same ILcdModelXYZWorldTransformation for different ILcdModelReferences or ILcdXYZWorldReference.

By default this method calls createModelXYZWorldTransformation to create a new transformation instance.

Specified by:

getModelXYZWorldTransformation in interface ILspLayer

Parameters:

aView - the view

Returns:

the transformation that will be used to transform coordinates of the objects in the model to world coordinates of the given view

createModelXYZWorldTransformation

protected ILcdModelXYZWorldTransformation createModelXYZWorldTransformation(ILcdModelReference aModelReference,
 ILcdXYZWorldReference aWorldReference,
 ILspView aView)

Creates a new model world transformation for the given model and world reference. This method is called by the default implementation of getModelXYZWorldTransformation.

Parameters:

aModelReference - the model reference.

aWorldReference - the world reference.

aView - the view for which a transformation is created.

Returns:

a new model world transformation for the given model and world references.

addLayerStateListener

public void addLayerStateListener(ILspLayerStateListener aListener)

Description copied from interface: ILspLayer

Adds a state change listener to this layer. The layer must notify this listener when any of its state for a specific TLspPaintRepresentation or TLspPaintRepresentationState is changed. This state change is described respectively by a TLspLayerStateEvent or a TLspLayerPaintStateEvent.

Specified by:

addLayerStateListener in interface ILspLayer

Parameters:

aListener - the state change listener to be registered on this layer

removeLayerStateListener

public void removeLayerStateListener(ILspLayerStateListener aListener)

Description copied from interface: ILspLayer

Removes the specified state listener from this layer.

Specified by:

removeLayerStateListener in interface ILspLayer

Parameters:

aListener - the listener to be removed from the layer

See Also:

• ILspLayer.addLayerStateListener(ILspLayerStateListener)

fireLayerStateChange

protected void fireLayerStateChange(TLspLayerStateEvent aEvent)

Fires a layer state change event.

Parameters:

aEvent - the event

See Also:

• TLspLayerStateSupport.fireLayerStateChange(TLspLayerStateEvent)

fireLayerStateChange

protected void fireLayerStateChange(TLspLayerPaintStateEvent aEvent)

Fires a layer state change event.

Parameters:

aEvent - the event

See Also:

• TLspLayerStateSupport.fireLayerStateChange(TLspLayerPaintStateEvent)

fireLayerStateChange

public void fireLayerStateChange(TLspLayerPaintStateEvent.Type aType,
 TLspPaintRepresentationState aPaintRepresentationState,
 Object aOldValue,
 Object aNewValue)

Fires a layer state change event with the specified properties.

Parameters:

aType - the event type

aPaintRepresentationState - the affected paint representation state

aOldValue - the old value

aNewValue - the new value

See Also:

• TLspLayerStateSupport.fireLayerStateChange(com.luciad.view.lightspeed.layer.TLspLayerPaintStateEvent.Type, TLspPaintRepresentationState, Object, Object)

fireLayerStateChange

public void fireLayerStateChange(TLspLayerStateEvent.Type aType,
 TLspPaintRepresentation aPaintRepresentation,
 Object aOldValue,
 Object aNewValue)

Fires a layer state change event with the specified properties.

Parameters:

aType - the event type

aPaintRepresentation - the affected paint representation

aOldValue - the old value

aNewValue - the new value

See Also:

• TLspLayerStateSupport.fireLayerStateChange(com.luciad.view.lightspeed.layer.TLspLayerPaintStateEvent.Type, TLspPaintRepresentationState, Object, Object)

addStatusListener

public void addStatusListener(ILcdStatusListener<ILspLayer> aStatusListener)

Description copied from interface: ILspLayer

Adds a status listener to this layer that is notified when the layer starts work asynchronously, when it is in progress, and when it is finished.

Specified by:

addStatusListener in interface ILspLayer

Parameters:

aStatusListener - a status listener

removeStatusListener

public void removeStatusListener(ILcdStatusListener<ILspLayer> aStatusListener)

Description copied from interface: ILspLayer

Removes a previously added status listener from this layer. The listener will no longer be notified of changes in layer progress

Specified by:

removeStatusListener in interface ILspLayer

Parameters:

aStatusListener - a status listener

fireStatusEvent

protected void fireStatusEvent(TLcdStatusEvent<ILspLayer> aStatusEvent)

Fires a status event.

Parameters:

aStatusEvent - the status event

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Description copied from interface: ILcdPropertyChangeSource

Registers the given PropertyChangeListener to be notified when this object's properties change.

In case you need to register a listener which keeps a reference to an object with a shorter life-time than this change source, you can use a ALcdWeakPropertyChangeListener instance as property change listener.

Specified by:

addPropertyChangeListener in interface ILcdPropertyChangeSource

Parameters:

listener - The listener to be notified

See Also:

• ALcdWeakPropertyChangeListener
• ILcdPropertyChangeSource.removePropertyChangeListener(java.beans.PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Description copied from interface: ILcdPropertyChangeSource

De-registers the given PropertyChangeListener from receiving property change events for this object.

If the listener was added more than once, it will be notified one less time after being removed. If the listener is null, or was never added, no exception is thrown and no action is taken.

Specified by:

removePropertyChangeListener in interface ILcdPropertyChangeSource

Parameters:

listener - the listener that should no longer be notified of changes of this object's properties

See Also:

• ILcdPropertyChangeSource.addPropertyChangeListener(java.beans.PropertyChangeListener)

firePropertyChange

protected void firePropertyChange(PropertyChangeEvent aEvent)

Fires a property change event for this layer.

Parameters:

aEvent - the event

selectedObjects

public Enumeration<Object> selectedObjects()

Description copied from interface: ILcdSelection

Returns the objects in this selection.

Specified by:

selectedObjects in interface ILcdSelection<Object>

Returns:

the objects currently in this ILcdSelection.

getSelectionCount

public int getSelectionCount()

Description copied from interface: ILcdSelection

Returns the number of objects in this selection.

Specified by:

getSelectionCount in interface ILcdSelection<Object>

Returns:

the number of objects in this ILcdSelection.

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>

Parameters:

aObject - the Object to be checked.

Returns:

true if the Object is in this ILcdSelection, false otherwise.

Throws:

IllegalArgumentException

selectObject

public void selectObject(Object aObject,
 boolean aSelection,
 int aDispatchEventMode)

Description copied from interface: ILcdLayer

Changes the selection state of any element contained in the ILcdModel this ILcdLayer refers to. This method shall have an effect only if isSelectableSupported and isSelectable return true.

Specified by:

selectObject in interface ILcdLayer

Parameters:

aObject - the Object to select or deselect. The object should be in the model of this layer. The implementation of this method is not responsible for checking this.

aSelection - the selection state, true to select, false to deselect.

aDispatchEventMode - shall be one among ILcdFireEventMode.FIRE_NOW, ILcdFireEventMode.FIRE_LATER, ILcdFireEventMode.NO_EVENT

See Also:

• ILcdFireEventMode

selectObjects

public void selectObjects(Collection<Object> aObjects,
 boolean aSelection,
 int aDispatchEventMode)

Changes the selection state for the given collection of objects contained in the ILcdModel this layer refers to. This method shall have an effect only if isSelectableSupported() and isSelectable() return true.

Parameters:

aObjects - the collection of objects to select or deselect

aSelection - the selection state, true to select, false to deselect

aDispatchEventMode - shall be one among ILcdFireEventMode.FIRE_NOW, ILcdFireEventMode.FIRE_LATER, ILcdFireEventMode.NO_EVENT

See Also:

• ILcdFireEventMode

fireCollectedSelectionChanges

public void fireCollectedSelectionChanges()

Description copied from interface: ILcdLayer

Fires a TLcdSelectionChangedEvent that contains all the selection changes appended by successively calling selectObject(Object, boolean, ILcdFireEventMode.FIRE_LATER).

Specified by:

fireCollectedSelectionChanges in interface ILcdLayer

clearSelection

public void clearSelection(int aDispatchEventMode)

Description copied from interface: ILcdLayer

Deselect all the Objects in this ILcdLayer, i.e., the selection of this ILcdLayer is empty afterward.

Specified by:

clearSelection in interface ILcdLayer

Parameters:

aDispatchEventMode - shall be one among ILcdFireEventMode.FIRE_NOW, ILcdFireEventMode.FIRE_LATER, ILcdFireEventMode.NO_EVENT

See Also:

• ILcdFireEventMode

addSelectionListener

public void addSelectionListener(ILcdSelectionListener<Object> aSelectionListener)

Description copied from interface: ILcdSelection

Adds a listener to this selection. In case you need to register a listener which keeps a reference to an object with a shorter life-time than this ILcdSelection, you can use a ALcdWeakSelectionListener instance as selection listener.

Specified by:

addSelectionListener in interface ILcdSelection<Object>

Parameters:

aSelectionListener - the ILcdSelectionListener to be added.

removeSelectionListener

public void removeSelectionListener(ILcdSelectionListener<Object> aSelectionListener)

Description copied from interface: ILcdSelection

Removes an ILcdSelectionListener from this ILcdSelection.

Specified by:

removeSelectionListener in interface ILcdSelection<Object>

Parameters:

aSelectionListener - the ILcdSelectionListener to be removed.

isSelectableSupported

public boolean isSelectableSupported()

Description copied from interface: ILcdLayer

Returns true if this layer supports selecting objects, false otherwise.

Specified by:

isSelectableSupported in interface ILcdLayer

Returns:

true

See Also:

• ILcdLayer.setSelectable(boolean)
• ILcdLayer.selectObject(java.lang.Object, boolean, int)

setSelectable

public void setSelectable(boolean aSelectable)

Description copied from interface: ILcdLayer

Sets the Selectable property of this ILcdLayer. Check isSelectableSupported to see if the layer supports selection.

Specified by:

setSelectable in interface ILcdLayer

Parameters:

aSelectable - true if the layer allows selection, false otherwise.

See Also:

• ILcdLayer.isSelectable()
• ILcdLayer.isSelectableSupported()

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

Returns:

true if the layer allows selection, false otherwise.

See Also:

• ILcdSelection
• ILcdLayer.setSelectable(boolean)

getBounds

public ILcdBounds getBounds(TLspContext aContext)
                     throws TLcdNoBoundsException,
TLcdOutOfBoundsException

Returns the bounds of the layer in world coordinates. The world reference system returned by TLspContext.getXYZWorldReference() is used.

ALspLayer provides a default model based implementation of this method. In some cases, this is only an approximation of the actual bounds, so more specific implementations are encouraged to provide a more precise implementation.

Specified by:

getBounds in interface ILspLayer

Parameters:

aContext - The context that defines the reference system for the bounds to be returned.

Returns:

The bounds of the layer in the reference system specified by aContext.

Throws:

TLcdNoBoundsException - If the layer has no bounds in the reference system. For instance, if the layer paints directly in the view.

TLcdOutOfBoundsException - If the bounds can not be represented in the specified reference system.

getLayerStyle

public TLspLayerStyle getLayerStyle()

Description copied from interface: ILspLayer

Gets the current layer style. You can reset the layer style like this:

   layer.setLayerStyle(TLspLayerStyle.newBuilder().build());
 

Specified by:

getLayerStyle in interface ILspLayer

Returns:

the layer style. Never null.

setLayerStyle

public void setLayerStyle(TLspLayerStyle aLayerStyle)

Description copied from interface: ILspLayer

Sets a layer style to this layer. Layer style can for example modify the transparency of a layer as a whole.

You can reset the layer style like this:

   layer.setLayerStyle(TLspLayerStyle.newBuilder().build());
 

Specified by:

setLayerStyle in interface ILspLayer

Parameters:

aLayerStyle - the layer style. must not be null.