public interface ILcyMapComponent extends ILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer>
ILcyMapComponent
is an ILcyGenericMapComponent
for ILcdGXYView
(a flat map).
Whenever an instance is created, the map needs to be added to the ILcyMapManager
of the ILcyLucyEnv
to integrate it in the back-end of the application.
This interface is subject to change, please use the available factories
(TLcyMapComponentFactory
) and
TLcyMapOverviewComponentFactory
) to create instances that
implement this interface and do not use delegation.
ILcyMapManager
,
ILcyGenericMapComponent
Modifier and Type | Field and Description |
---|---|
static TLcyGroupDescriptor |
CONTROLLER_GROUP
Deprecated.
Group descriptors are defined in configuration files. Please refer to the
developer guide for more information.
The group descriptor used to insert controllers into menu bars and toolbars.
|
Modifier and Type | Method and Description |
---|---|
void |
addAvailableGXYController(ILcdGXYController aGXYController)
Adds the given controller to the list of available controllers associated
with this map.
|
void |
addAvailableGXYController(ILcdGXYController aGXYController,
int aID)
Adds the given controller, together with its ID, to the list of available controllers associated
with this map.
|
TLcyAreaOfInterestLayer |
getAreaOfInterestLayer()
Returns the associated area of interest layer.
|
ILcdGXYController |
getAvailableGXYController(int aIndex)
Returns the GXY Controller at the given index.
|
int |
getAvailableGXYControllerCount()
Returns the number of controllers associated with this map.
|
int |
getAvailableGXYControllerID(int aIndex)
Returns the ID of the GXY Controller at the given index, or -1 if no ID was ever associated with
the controller at the given index.
|
Container |
getEastContentPane()
Deprecated.
Use
ILcyGenericMapComponent.getEastPanel() instead |
ILcdGXYView |
getMainGXYView()
Returns the main component of a lucy map: the view.
|
ALcyMapComponentFactory |
getMapComponentFactory()
Returns the
ALcyMapComponentFactory that was used to create
this ILcyMapComponent . |
Container |
getNorthContentPane()
Deprecated.
Use
ILcyGenericMapComponent.getNorthPanel() instead |
ILcdGXYLayer[] |
getSelectedLayers()
Returns the selected layers.
|
List<ILcdGXYLayer> |
getSelectedLayersAsList()
Returns the selected layers.
|
ILcdGXYLayerSubsetList |
getSnapList()
Use this method to get the list of snappables for this map component.
|
Container |
getSouthContentPane()
Deprecated.
Use
ILcyGenericMapComponent.getSouthPanel() instead |
Container |
getWestContentPane()
Deprecated.
Use
ILcyGenericMapComponent.getWestPanel() instead |
void |
insertGXYLayer(ILcdGXYLayer aGXYLayer)
|
void |
insertGXYLayer(ILcdGXYLayer aGXYLayer,
int aGXYLayerType,
int aModelType)
|
void |
removeAvailableGXYController(ILcdGXYController aGXYController)
Removes the given controller from the list of available controllers.
|
ILcdGXYController |
retrieveAvailableGXYController(int aID)
Returns the controller with the given ID, or
null if there is no such controller. |
void |
setSelectedLayers(ILcdGXYLayer[] aSelectedLayers)
Sets the selected layers to the layers contained in
aSelectedLayers . |
void |
setSelectedLayersAsList(List<? extends ILcdGXYLayer> aSelectedLayers)
Sets the selected layers to the layers contained in
aSelectedLayers . |
dispose, getBalloonManager, getCenterPanel, getComponent, getEastPanel, getLayerControl, getLayerControlComponent, getMainView, getMapName, getMapOverlayPanel, getMenuBar, getMenuBarComponent, getNorthPanel, getPopupMenu, getSouthPanel, getStatusBar, getStatusBarComponent, getToolBar, getToolBarComponent, getWestPanel, isLayerControlCapable, isLayerControlVisible, isMenuBarCapable, isMenuBarVisible, isPopupMenuCapable, isStatusBarCapable, isStatusBarVisible, isToolBarCapable, isToolBarVisible, setBalloonManager, setMapName
close
addPropertyChangeListener, removePropertyChangeListener
@Deprecated static final TLcyGroupDescriptor CONTROLLER_GROUP
ILcdGXYView getMainGXYView()
void insertGXYLayer(ILcdGXYLayer aGXYLayer, int aGXYLayerType, int aModelType)
ILcdGXYLayer
into the main view of this
ILcyMapComponent
. The difference between this method and ILcdGXYView.addGXYLayer
is that
this method behaves differently for ILcdGXYLayerList
s (see
insertGXYLayer(com.luciad.view.gxy.ILcdGXYLayer)
).
Using this method is discouraged as the given layer and model types can get lost after re-loading a workspace,
dragging the layer to a new map, etc. These layer and model types should better be provided using
ILcyGXYLayerTypeProvider
s and ILcyModelContentTypeProvider
s.aGXYLayer
- The ILcdGXYLayer to be added.aGXYLayerType
- The layer type of the given layeraModelType
- The model type of the given layer.insertGXYLayer(com.luciad.view.gxy.ILcdGXYLayer)
void insertGXYLayer(ILcdGXYLayer aGXYLayer)
ILcdGXYLayer
into the main view of this
ILcyMapComponent
. The difference between this method and ILcdGXYView.addGXYLayer
is that
this method behaves differently for ILcdGXYLayerList
s.
As described in ILcdGXYLayerList
, there are some limitations when adding
ILcdGXYLayerList
s to an ILcdGXYView
using addGXYLayer
. This method solves
these problems by not adding the ILcdGXYLayerList
itself to the ILcdGXYView
, but instead
it creates an ILcdLayerTreeNode
representing the layer list. The
layer list and the layer node will automatically kept in sync. Should the layer list become empty, the
corresponding layer node will automatically be removed from the view.
Suppose we have this layer structure:
ILcdGXYLayerList_1
as an argument will add a node to the view
with the following structure:
aGXYLayer
- The ILcdGXYLayer
or ILcdGXYLayerList
to be added.TLcyAreaOfInterestLayer getAreaOfInterestLayer()
int getAvailableGXYControllerCount()
getAvailableGXYController(int)
ILcdGXYController getAvailableGXYController(int aIndex)
aIndex
- The index of the controller to retrieve. 0 <= aIndex < getAvailableGXYControllerCount()getAvailableGXYControllerCount()
int getAvailableGXYControllerID(int aIndex)
aIndex
- The index of the controller to retrieve the ID for. 0 <= aIndex < getAvailableGXYControllerCount()addAvailableGXYController
).getAvailableGXYControllerCount()
,
addAvailableGXYController(com.luciad.view.gxy.ILcdGXYController, int)
ILcdGXYController retrieveAvailableGXYController(int aID)
null
if there is no such controller.aID
- The ID of the controller to retrieve. This is the ID that was used when adding
the controller. Typical ID's are the ID's specified in
TLcyMapComponentFactory
ending in CONTROLLER
, e.g.
SELECT_CONTROLLER
.null
if there is no such controller.getAvailableGXYControllerCount()
,
addAvailableGXYController(com.luciad.view.gxy.ILcdGXYController, int)
void addAvailableGXYController(ILcdGXYController aGXYController)
getAvailableGXYControllerID
for the
index of this controller will return -1.aGXYController
- The controller to add.removeAvailableGXYController(com.luciad.view.gxy.ILcdGXYController)
,
getAvailableGXYControllerCount()
,
getAvailableGXYController(int)
void addAvailableGXYController(ILcdGXYController aGXYController, int aID)
aGXYController
- The controller to add.aID
- The ID for the controller. The ID can be useful to retrieve a controller for a given ID.
ID's are positive integers, and must be unique. Customers should use ID's greater than or equal to 100000.
Controllers provided by Lucy will use ID's less than 100000. Typical ID's are the ID's specified in
TLcyMapComponentFactory
ending in CONTROLLER
, e.g.
SELECT_CONTROLLER
.removeAvailableGXYController(com.luciad.view.gxy.ILcdGXYController)
,
getAvailableGXYControllerCount()
,
getAvailableGXYController(int)
,
getAvailableGXYControllerID(int)
,
retrieveAvailableGXYController(int)
void removeAvailableGXYController(ILcdGXYController aGXYController)
aGXYController
- The controller to remove.addAvailableGXYController(com.luciad.view.gxy.ILcdGXYController)
ILcdGXYLayerSubsetList getSnapList()
ILcySnappable
and that return true
for their method isSnappingOn
.
Please refer to the developer guide for more information about snapping.ALcyMapComponentFactory getMapComponentFactory()
ALcyMapComponentFactory
that was used to create
this ILcyMapComponent
.ALcyMapComponentFactory
that was used to create
this ILcyMapComponent
.void setSelectedLayers(ILcdGXYLayer[] aSelectedLayers)
Sets the selected layers to the layers contained in aSelectedLayers
. Note that
all these layers must be part of the view. A property change event will be fired when the selection
has changed
If none of the layers should be selected, this method should be called with an empty array.
This method is identical to setSelectedLayersAsList(java.util.List)
. Setting the
selected layers with this method will fire a property change event for both the selectedLayers
property and the selectedLayersAsList
property.
aSelectedLayers
- the layers to be selected. Must not be null
void setSelectedLayersAsList(List<? extends ILcdGXYLayer> aSelectedLayers)
Sets the selected layers to the layers contained in aSelectedLayers
. Note that
all these layers must be part of the view. A property change event will be fired when the
selection has changed
If none of the layers should be selected, this method should be called with an empty list.
This method is identical to setSelectedLayers(com.luciad.view.gxy.ILcdGXYLayer[])
. Setting the
selected layers with this method will fire a property change event for both the selectedLayers
property and the selectedLayersAsList
property.
setSelectedLayersAsList
in interface ILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer>
aSelectedLayers
- the layers to be selected. Must not be null
ILcyGenericMapComponent.getSelectedLayersAsList()
ILcdGXYLayer[] getSelectedLayers()
Returns the selected layers. These are the layers that the user has selected in the user
interface, or the layers that has been set by calling setSelectedLayers
. All these layers are part of the view.
The returned layers are the same as when calling getSelectedLayersAsList()
.
A property change event will be fired when the selection has changed.
setSelectedLayers(com.luciad.view.gxy.ILcdGXYLayer[])
,
getSelectedLayersAsList()
List<ILcdGXYLayer> getSelectedLayersAsList()
Returns the selected layers. These are the layers that the user has selected in the user
interface, or the layers that has been set by calling setSelectedLayersAsList
. All these layers are part of the view.
A property change event will be fired when the selection has changed.
The returned layers are the same as when calling getSelectedLayers()
.
getSelectedLayersAsList
in interface ILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer>
ILcyGenericMapComponent.setSelectedLayersAsList(java.util.List)
@Deprecated Container getNorthContentPane()
ILcyGenericMapComponent.getNorthPanel()
instead@Deprecated Container getSouthContentPane()
ILcyGenericMapComponent.getSouthPanel()
instead@Deprecated Container getWestContentPane()
ILcyGenericMapComponent.getWestPanel()
instead@Deprecated Container getEastContentPane()
ILcyGenericMapComponent.getEastPanel()
instead