Package com.luciad.view
Interface 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
,TLfnGXYVectorLayer
,TLspGXYLayerAdapter
,TLspGXYLayerTreeNodeAdapter
,TLspLayer
,TLspLayerTreeNode
,TLspRasterLayer
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
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:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
clearSelection
(int aDispatchEventMode) Deselect all the Objects in thisILcdLayer
, i.e., the selection of thisILcdLayer
is empty afterward.void
Fires aTLcdSelectionChangedEvent
that contains all the selection changes appended by successively callingselectObject(Object, boolean, ILcdFireEventMode.FIRE_LATER)
.getIcon()
Returns a visual indication of the contents of this layer.getLabel()
A short textual representation of thisILcdLayer
.getModel()
boolean
Returns whether the layer allows editing the content that it visualizes.boolean
Returnstrue
if the layer supports editing its objects.boolean
Returns whether the layer's objects can be selected, for example, by clicking on them.boolean
Returnstrue
if this layer supports selecting objects,false
otherwise.boolean
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 theILcdModel
thisILcdLayer
refers to.void
setEditable
(boolean aEditable) Sets whether the layer should allow editing the content that it visualizes.void
Sets a visual indication of the contents of this layer.void
Sets the textual representation of thisILcdLayer
.void
setSelectable
(boolean aSelectable) Sets the Selectable property of thisILcdLayer
.void
setVisible
(boolean aVisible) Sets whether or not the layer's content is painted.Methods inherited from interface com.luciad.util.ILcdPropertyChangeSource
addPropertyChangeListener, removePropertyChangeListener
Methods inherited from interface com.luciad.util.ILcdSelection
addSelectionListener, getSelectedObjects, getSelectionCount, isSelected, removeSelectionListener, selectedObjects
-
Method Details
-
getModel
ILcdModel getModel()- Returns:
- the
ILcdModel
associated to thisILcdLayer
-
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
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:
-
isSelectableSupported
boolean isSelectableSupported()Returnstrue
if this layer supports selecting objects,false
otherwise.- Returns:
true
if thisILcdLayer
supports the selectable property,false
otherwise. I.e. if thisILcdLayer
can be put or not in a selectable mode.- See Also:
-
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:
-
setSelectable
void setSelectable(boolean aSelectable) Sets the Selectable property of thisILcdLayer
. CheckisSelectableSupported
to see if the layer supports selection.- Parameters:
aSelectable
-true
if the layer allows selection,false
otherwise.- See Also:
-
isEditableSupported
boolean isEditableSupported()Returnstrue
if the layer supports editing its objects.- Returns:
true
if the layer supports editing,false
otherwise.- See Also:
-
isEditable
boolean isEditable()Returns whether the layer allows editing the content that it visualizes.- Returns:
true
if thisILcdLayer
is editable,false
otherwise- See Also:
-
setEditable
void setEditable(boolean aEditable) Sets whether the layer should allow editing the content that it visualizes. CheckisEditableSupported
to see if the layer supports editing.- Parameters:
aEditable
- true if the layer content can be edited- See Also:
-
selectObject
Changes the selection state of any element contained in theILcdModel
thisILcdLayer
refers to. This method shall have an effect only if isSelectableSupported and isSelectable return true.- Parameters:
aObject
- theObject
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 amongILcdFireEventMode.FIRE_NOW
,ILcdFireEventMode.FIRE_LATER
,ILcdFireEventMode.NO_EVENT
- See Also:
-
fireCollectedSelectionChanges
void fireCollectedSelectionChanges()Fires aTLcdSelectionChangedEvent
that contains all the selection changes appended by successively callingselectObject(Object, boolean, ILcdFireEventMode.FIRE_LATER)
. -
clearSelection
void clearSelection(int aDispatchEventMode) Deselect all the Objects in thisILcdLayer
, i.e., the selection of thisILcdLayer
is empty afterward.- Parameters:
aDispatchEventMode
- shall be one amongILcdFireEventMode.FIRE_NOW
,ILcdFireEventMode.FIRE_LATER
,ILcdFireEventMode.NO_EVENT
- See Also:
-
getLabel
String getLabel()A short textual representation of thisILcdLayer
.- Returns:
- a short textual representation of this
ILcdLayer
-
setLabel
Sets the textual representation of thisILcdLayer
.- Parameters:
aLabel
- the the textual representation to use for thisILcdLayer
.
-
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
Sets a visual indication of the contents of this layer.- Parameters:
aIcon
- a visual indication of the contents of this layer.- See Also:
-