com.luciad.view

LuciadLightspeedInterface ILcdLayer

All Superinterfaces:

ILcdPropertyChangeSource, ILcdSelection<Object>, Serializable

All Known Subinterfaces:

ILcdGXYAsynchronousLayerWrapper, ILcdGXYEditableLabelsLayer, ILcdGXYLayer, ILcdGXYLayerList , ILcdLayerTreeNode, ILspEditableStyledLayer, ILspImageProjectionLayer, ILspInteractivePaintableLayer, ILspLayer, ILspPaintableLayer, ILspStyledLayer

All Known Implementing Classes:

ALspLayer, TLcdGXYAsynchronousEditableLabelsLayerTreeNodeWrapper, TLcdGXYAsynchronousEditableLabelsLayerWrapper, TLcdGXYAsynchronousLayerTreeNodeWrapper, TLcdGXYAsynchronousLayerWrapper, TLcdGXYDensityLayer, TLcdGXYLayer, TLcdGXYLayerList , TLcdGXYLayerTreeNode, TLcdGXYLspAsynchronousLayerTreeNodeWrapper , TLcdGXYLspAsynchronousLayerWrapper , TLcdKML22GXYLayer, TLcdLayer, TLcdMapGeorefGridLayer, TLcdMapLonLatGridLayer, TLcdMGRSGridLayer, TLcdMultilevelGridLayer, TLcdPOLLayer, TLcdS52GXYCatalogueLayer, TLcdS52GXYCatalogueLayerList , TLcdS52GXYLayer, TLcdS52GXYLevelLayerList , TLcdUPSGridLayer, TLcdUTMGridLayer, TLcdVPFLayer , TLcdWMSProxyGXYLayer, TLcdXYGridLayer, TLcyAreaOfInterestLayer, TLcyDynamicLonLatGridLayer, TLcyPIMGXYLayer, TLcySnappableGXYLayer, com.luciad.internal.lucy.map.TLcyStyledSnappableGXYLayer, TLfnGXYVectorLayer , TLspGXYLayerAdapter , TLspGXYLayerTreeNodeAdapter , TLspLayer, TLspLayerTreeNode, TLspRasterLayer

public interface ILcdLayer
extends ILcdSelection<Object>, Serializable, ILcdPropertyChangeSource

Provides the combined representation in an ILcdView of the objects in an ILcdModel. Extensions of this interface will contain additional information how to represent (render) or edit elements of an ILcdModel in "specialized" ILcdView interfaces (for example, in a 2D or 3D view).

A layer has the following properties that can be changed:

• whether it will be visible in the view
• whether its elements can be selected
• whether its elements can be edited

Making these properties part of the layer allows, for example, to have the domain object selected in one ILcdView, and unselected in another. The layer allows to subscribe for changes in these properties.

A layer can also be queried for selected elements. The selection can be changed by calling selectObject(java.lang.Object, boolean, int), provided that the layer supports it.

See Also:

ILcdView, ILcdModel

Method Summary

Modifier and Type	Method and Description
void	clearSelection(int aDispatchEventMode) Deselect all the Objects in this ILcdLayer, i.e., the selection of this ILcdLayer is empty afterward.
void	fireCollectedSelectionChanges() Fires a TLcdSelectionChangedEvent that contains all the selection changes appended by successively calling selectObject(Object, boolean, ILcdFireEventMode.FIRE_LATER).
ILcdIcon	getIcon() Returns a visual indication of the contents of this layer.
String	getLabel() A short textual representation of this ILcdLayer.
ILcdModel	getModel()
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	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	isVisible() Returns whether or not the layer's content is painted.
void	selectObject(Object aObject, boolean aSelection, int aDispatchEventMode) Changes the selection state of any element contained in the ILcdModel this ILcdLayer refers to.
void	setEditable(boolean aEditable) Sets whether the layer should allow editing the content that it visualizes.
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	setSelectable(boolean aSelectable) Sets the Selectable property of this ILcdLayer.
void	setVisible(boolean aVisible) Sets whether or not the layer's content is painted.

Methods inherited from interface com.luciad.util.ILcdSelection

addSelectionListener, getSelectedObjects, getSelectionCount, isSelected, removeSelectionListener, selectedObjects

Methods inherited from interface com.luciad.util.ILcdPropertyChangeSource

addPropertyChangeListener, removePropertyChangeListener

Method Detail

getModel

ILcdModel getModel()

Returns:

the ILcdModel associated to this ILcdLayer

isVisible

boolean isVisible()

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

Returns:

true if the layer is visible, false otherwise.

See Also:

setVisible(boolean)

setVisible

void setVisible(boolean aVisible)

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

Parameters:

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

See Also:

isVisible()

isSelectableSupported

boolean isSelectableSupported()

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

Returns:

true if this ILcdLayer supports the selectable property, false otherwise. I.e. if this ILcdLayer can be put or not in a selectable mode.

See Also:

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

isSelectable

boolean isSelectable()

Returns whether the layer's objects can be selected, for example, by clicking on them.

Returns:

true if the layer allows selection, false otherwise.

See Also:

ILcdSelection, setSelectable(boolean)

setSelectable

void setSelectable(boolean aSelectable)

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

Parameters:

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

See Also:

isSelectable(), isSelectableSupported()

isEditableSupported

boolean isEditableSupported()

Returns true if the layer supports editing its objects.

Returns:

true if the layer supports editing, false otherwise.

See Also:

setEditable(boolean)

isEditable

boolean isEditable()

Returns whether the layer allows editing the content that it visualizes.

Returns:

true if this ILcdLayer is editable, false otherwise

See Also:

setEditable(boolean)

setEditable

void setEditable(boolean aEditable)

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

Parameters:

aEditable - true if the layer content can be edited

See Also:

isEditableSupported(), isEditable()

selectObject

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

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.

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

fireCollectedSelectionChanges

void fireCollectedSelectionChanges()

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

clearSelection

void clearSelection(int aDispatchEventMode)

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

Parameters:

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

See Also:

ILcdFireEventMode

getLabel

String getLabel()

A short textual representation of this ILcdLayer.

Returns:

a short textual representation of this ILcdLayer

setLabel

void setLabel(String aLabel)

Sets the textual representation of this ILcdLayer.

Parameters:

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

getIcon

ILcdIcon getIcon()

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

Returns:

a visual indication of the contents of this layer.

setIcon

void setIcon(ILcdIcon aIcon)

Sets a visual indication of the contents of this layer.

Parameters:

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

See Also:

getIcon()