Class TLcyMapComponent
- All Implemented Interfaces:
ILcyGenericMapComponent<ILcdGXYView,,ILcdGXYLayer> ILcyMapComponent,ILcdDisposable,ILcdPropertyChangeSource,ImageObserver,MenuContainer,Serializable,AutoCloseable,Accessible
ILcyMapComponent. It provides support for an
ILcdGXYView (often in the center), and support for an optional toolbar,
optional menubar, optional status bar and optional layer control. Note however that the
TLcyMapComponent does not contain anything after it is constructed, it is up to
the user of this class to add these components. Also note that no component is ever added
to the Swing component hierarchy, this is the responsibility of the user of this class. When
for example the north pane is set using setNorthPanel, it is not
added to the user interface.
TLcyMapComponents are typically created using a TLcyMapComponentFactory.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanelNested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
Fields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface com.luciad.lucy.map.ILcyMapComponent
CONTROLLER_GROUPFields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a newTLcyMapComponent.TLcyMapComponent(ILcdGXYView aMainGXYView) Constructs a newTLcyMapComponentfor the given gxy view. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddAvailableGXYController(ILcdGXYController aGXYController) Adds the given controller to the list of available controllers associated with this map.voidaddAvailableGXYController(ILcdGXYController aGXYController, int aID) Adds the given controller, together with its ID, to the list of available controllers associated with this map.voiddispose()Disposes of this object and allows it to release any system resources that it is holding.Returns the associated area of interest layer.getAvailableGXYController(int aIndex) Returns the GXY Controller at the given index.intReturns the number of controllers associated with this map.intgetAvailableGXYControllerID(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.Returns the balloon manager of this map component.Returns the container in the center, typically containing the main view.Returns the Component representing this map, e.g.,this.Returns the container at the east of the main gxy view.Returns the container at the east of the main view.Returns the layer order manager this map uses to order its layers.Returns the layer control of this map.Returns the layer control component.Returns the main component of a lucy map: the view.Returns the main component of a lucy map: the view.Returns theALcyMapComponentFactorythat was used to create thisILcyMapComponent.Returns the name of the map.Returns the Map Overlay Panel.Deprecated.Returns the menu bar of the map.Returns the menu bar component.Returns the container at the north of the main gxy view.Returns the container at the north of the main view.Returns the popup menu of this map component.Returns the selected layers.Returns the selected layers.Returns the list of snappables.Returns the container at the south of the main gxy view.Returns the container at the south of the main view.Returns the statusbar of this map.Returns the status bar component.Returns the toolbar of this map.Returns the tool bar component.Returns the container at the west of the main gxy view.Returns the container at the west of the main view.voidinsertGXYLayer(ILcdGXYLayer aGXYLayer) voidinsertGXYLayer(ILcdGXYLayer aGXYLayer, int aGXYLayerType, int aModelType) booleanReturns true if this map has its own layer control, false otherwise.booleanReturns true if the layer control is visible, false otherwise.booleanReturns true if the map has its own menu bar, false otherwise.booleanReturns true if the menu bar is visible, false otherwise.booleanReturns true if this map component has a popup menu (getPopupMenu() != null)booleanReturns true if snapping is active.booleanReturns true if this map has its own statusbar, false otherwisebooleanReturns true if the status bar is visible, false otherwise.booleanReturns true if this map has its own toolbar, false otherwise.booleanReturns true if the tool bar is visible, false otherwise.booleanDeprecated.This method has been deprecated.voidremoveAvailableGXYController(ILcdGXYController aGXYController) Removes the given controller from the list of available controllers.retrieveAvailableGXYController(int aID) Returns the controller with the given ID, ornullif there is no such controller.voidsetAreaOfInterestLayer(TLcyAreaOfInterestLayer aAreaOfInterestLayer) Sets the area of interest layer of this map component.voidsetBalloonManager(ALcdBalloonManager aBalloonManager) Set the balloon manager of this map component.voidsetCenterPanel(Container aCenterPanel) Sets the center panel of this map component.static voidsetClassTraceOn(boolean aClassTraceOn) Deprecated.This method has been deprecated.voidsetEastPanel(Container aEastPanel) Sets the east panel of this map component.voidsetGXYLayerOrderManager(ILcyGXYLayerOrderManager aGXYLayerOrderManager) Sets the layer order manager this map uses to order its layers.voidsetLayerControl(ILcyMapLayerControl aLayerControl) Sets the layer control of this map.voidsetLayerControlComponent(Component aMapLayerControlComponent) Sets the layer control component.voidsetLayerControlVisible(boolean aLayerControlVisible) Sets the layer control visible or not.voidsetMapComponentFactory(ALcyMapComponentFactory aMapComponentFactory) Sets the map component factory that was used to create thisTLcyMapComponent.voidsetMapName(String aMapName) Sets the name of the map.voidsetMapOverlayPanel(Container aMapOverlayPanel) Sets the map overlay panel of this map component.voidsetMapPopupMenu(ILcyPopupMenu aMapPopupMenu) Deprecated.UsesetPopupMenu(com.luciad.lucy.gui.ILcyPopupMenu)insteadvoidsetMenuBar(ILcyMenuBar aMenuBar) Sets the menu bar of this map component.voidsetMenuBarComponent(Component aMenuBarComponent) Sets the menu bar component.voidsetMenuBarVisible(boolean aMenuBarVisible) Sets the menu bar visible or not.voidsetNorthPanel(Container aNorthPanel) Sets the north panel of this map component.voidsetPopupMenu(ILcyPopupMenu aPopupMenu) Sets the popup menu of this map component.voidsetSelectedLayers(ILcdGXYLayer[] aSelectedLayers) Sets the selected layers to the layers contained inaSelectedLayers.voidsetSelectedLayersAsList(List<? extends ILcdGXYLayer> aSelectedLayers) Sets the selected layers to the layers contained inaSelectedLayers.voidsetSnappingActive(boolean aSnappingActive) Set true to active snapping.voidsetSouthPanel(Container aSouthPanel) Sets the south panel of this map component.voidsetStatusBar(ILcyToolBar aStatusBar) Sets the statusbar of this map compoennt.voidsetStatusBarComponent(Component aStatusBarComponent) Sets the status bar compoment.voidsetStatusBarVisible(boolean aStatusBarVisible) Sets the status bar visible or not.voidsetToolBar(ILcyToolBar aToolBar) Sets the tool bar of this map component.voidsetToolBarComponent(Component aToolBarComponent) Sets the tool bar component.voidsetToolBarVisible(boolean aToolBarVisible) Sets the tool bar visible or not.voidsetTraceOn(boolean aTraceOn) Deprecated.This method has been deprecated.voidsetWestPanel(Container aWestPanel) Sets the west panel of this map component.toString()Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUIMethods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, updateMethods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTreeMethods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.luciad.util.ILcdDisposable
closeMethods inherited from interface com.luciad.util.ILcdPropertyChangeSource
addPropertyChangeListener, removePropertyChangeListener
-
Constructor Details
-
TLcyMapComponent
public TLcyMapComponent()Constructs a newTLcyMapComponent. -
TLcyMapComponent
Constructs a newTLcyMapComponentfor the given gxy view.- Parameters:
aMainGXYView- The gxy view of this map component. Note that the view is not added to the Swing component hierarchy, this is the responsibility of the user of this method.
-
-
Method Details
-
setClassTraceOn
Deprecated.This method has been deprecated. It is recommended to use the standard Java logging framework directly.Enables tracing for all instances of this class. If the argument istruethen all log messages are recorded, otherwise only the informative, warning and error messages are recorded.- Parameters:
aClassTraceOn- if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.
-
setTraceOn
Deprecated.This method has been deprecated. It is recommended to use the standard Java logging framework directly.Enables tracing for this class instance. Calling this method with eithertrueorfalseas argument automatically turns off tracing for all other class instances for whichsetTraceOnhas not been called. If the argument isfalsethen only the informative, warning and error log messages are recorded.- Parameters:
aTraceOn- if true then all log messages are recorded for this instance. If false, then only the informative, warning and error log messages are recorded.
-
isTraceOn
Deprecated.This method has been deprecated. It is recommended to use the standard Java logging framework directly.Returnstrueif tracing is enabled for this class.- Returns:
- true if tracing is enabled for this class, false otherwise.
-
isSnappingActive
public boolean isSnappingActive()Returns true if snapping is active.- Returns:
- true if snapping is active, false otherwise.
- See Also:
-
setSnappingActive
public void setSnappingActive(boolean aSnappingActive) Set true to active snapping. If true, the snap list is kept up to date with the current extents of the view.- Parameters:
aSnappingActive- True if snapping should be active, false otherwise.- See Also:
-
getComponent
Description copied from interface:ILcyGenericMapComponentReturns the Component representing this map, e.g.,
this.- Specified by:
getComponentin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the Component representing this map.
-
dispose
public void dispose()Description copied from interface:ILcyGenericMapComponentDisposes of this object and allows it to release any system resources that it is holding.
The result of calling any other method (other than
finalize) on this object subsequent to a call to this method is undefined.Allows this map component to perform clean up tasks. The map component cannot be used after this method has been invoked.
- Specified by:
disposein interfaceILcdDisposable- Specified by:
disposein interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer>
-
getMapComponentFactory
Description copied from interface:ILcyMapComponentReturns theALcyMapComponentFactorythat was used to create thisILcyMapComponent.- Specified by:
getMapComponentFactoryin interfaceILcyMapComponent- Returns:
- the
ALcyMapComponentFactorythat was used to create thisILcyMapComponent.
-
setMapComponentFactory
Sets the map component factory that was used to create thisTLcyMapComponent.- Parameters:
aMapComponentFactory- The map component factory- See Also:
-
getSnapList
Returns the list of snappables. If isSnappingActive() return true, the snap list is automatically updated if the map extents change.- Specified by:
getSnapListin interfaceILcyMapComponent- Returns:
- The snap list.
- See Also:
-
getAreaOfInterestLayer
Description copied from interface:ILcyMapComponentReturns the associated area of interest layer.- Specified by:
getAreaOfInterestLayerin interfaceILcyMapComponent- Returns:
- the associated area of interest layer.
-
setAreaOfInterestLayer
Sets the area of interest layer of this map component.- Parameters:
aAreaOfInterestLayer- The area of interest layer.- See Also:
-
getGXYLayerOrderManager
Returns the layer order manager this map uses to order its layers.- Returns:
- the layer order manager this map uses to order its layers.
-
setGXYLayerOrderManager
Sets the layer order manager this map uses to order its layers.- Parameters:
aGXYLayerOrderManager- The layer order manager.
-
getAvailableGXYControllerCount
public int getAvailableGXYControllerCount()Description copied from interface:ILcyMapComponentReturns the number of controllers associated with this map.- Specified by:
getAvailableGXYControllerCountin interfaceILcyMapComponent- Returns:
- the number of controllers associated with this map.
- See Also:
-
getAvailableGXYController
Description copied from interface:ILcyMapComponentReturns the GXY Controller at the given index.- Specified by:
getAvailableGXYControllerin interfaceILcyMapComponent- Parameters:
aIndex- The index of the controller to retrieve. 0 <= aIndex < getAvailableGXYControllerCount()- Returns:
- The controller at the given index.
- See Also:
-
getAvailableGXYControllerID
public int getAvailableGXYControllerID(int aIndex) Description copied from interface:ILcyMapComponentReturns 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.- Specified by:
getAvailableGXYControllerIDin interfaceILcyMapComponent- Parameters:
aIndex- The index of the controller to retrieve the ID for. 0 <= aIndex < getAvailableGXYControllerCount()- Returns:
- The ID of the controller at the given index, or -1 if no ID was ever registered (see
addAvailableGXYController). - See Also:
-
addAvailableGXYController
Description copied from interface:ILcyMapComponentAdds the given controller to the list of available controllers associated with this map. Available means they can be set to the map. No ID is registered for this controller. That meansgetAvailableGXYControllerIDfor the index of this controller will return -1.- Specified by:
addAvailableGXYControllerin interfaceILcyMapComponent- Parameters:
aGXYController- The controller to add.- See Also:
-
addAvailableGXYController
Description copied from interface:ILcyMapComponentAdds the given controller, together with its ID, to the list of available controllers associated with this map. Available means they can be set to the map.- Specified by:
addAvailableGXYControllerin interfaceILcyMapComponent- Parameters:
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 inTLcyMapComponentFactoryending inCONTROLLER, e.g.SELECT_CONTROLLER.- See Also:
-
removeAvailableGXYController
Description copied from interface:ILcyMapComponentRemoves the given controller from the list of available controllers.- Specified by:
removeAvailableGXYControllerin interfaceILcyMapComponent- Parameters:
aGXYController- The controller to remove.- See Also:
-
retrieveAvailableGXYController
Description copied from interface:ILcyMapComponentReturns the controller with the given ID, ornullif there is no such controller.- Specified by:
retrieveAvailableGXYControllerin interfaceILcyMapComponent- Parameters:
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 inTLcyMapComponentFactoryending inCONTROLLER, e.g.SELECT_CONTROLLER.- Returns:
- The controller for the given ID, or
nullif there is no such controller. - See Also:
-
toString
-
getMainGXYView
Description copied from interface:ILcyMapComponentReturns the main component of a lucy map: the view.- Specified by:
getMainGXYViewin interfaceILcyMapComponent- Returns:
- the main view.
-
insertGXYLayer
Description copied from interface:ILcyMapComponentInserts the givenILcdGXYLayerinto the main view of thisILcyMapComponent. The difference between this method andILcdGXYView.addGXYLayeris that this method behaves differently forILcdGXYLayerLists (seeILcyMapComponent.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 usingILcyGXYLayerTypeProviders andILcyModelContentTypeProviders.- Specified by:
insertGXYLayerin interfaceILcyMapComponent- Parameters:
aGXYLayer- The ILcdGXYLayer to be added.aGXYLayerType- The layer type of the given layeraModelType- The model type of the given layer.- See Also:
-
insertGXYLayer
Description copied from interface:ILcyMapComponentInserts the givenILcdGXYLayerinto the main view of thisILcyMapComponent. The difference between this method andILcdGXYView.addGXYLayeris that this method behaves differently forILcdGXYLayerLists. As described inILcdGXYLayerList, there are some limitations when addingILcdGXYLayerLists to anILcdGXYViewusingaddGXYLayer. This method solves these problems by not adding theILcdGXYLayerListitself to theILcdGXYView, but instead it creates anILcdLayerTreeNoderepresenting 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
- ILcdGXYLayerList_2
- ILcdGXYLayer_A
- ILcdGXYLayer_B
- ILcdGXYLayerList_2
ILcdGXYLayerList_1as an argument will add a node to the view with the following structure:- ILcdLayerTreeNode_1
- ILcdLayerTreeNode_2
- ILcdGXYLayer_A
- ILcdGXYLayer_B
- ILcdLayerTreeNode_2
- Specified by:
insertGXYLayerin interfaceILcyMapComponent- Parameters:
aGXYLayer- TheILcdGXYLayerorILcdGXYLayerListto be added.
- ILcdGXYLayerList_1
-
setSelectedLayers
Description copied from interface:ILcyMapComponentSets 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 changedIf none of the layers should be selected, this method should be called with an empty array.
This method is identical to
ILcyMapComponent.setSelectedLayersAsList(java.util.List). Setting the selected layers with this method will fire a property change event for both theselectedLayersproperty and theselectedLayersAsListproperty.- Specified by:
setSelectedLayersin interfaceILcyMapComponent- Parameters:
aSelectedLayers- the layers to be selected. Must not benull
-
getSelectedLayers
Description copied from interface:ILcyMapComponentReturns 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
ILcyMapComponent.getSelectedLayersAsList().A property change event will be fired when the selection has changed.
- Specified by:
getSelectedLayersin interfaceILcyMapComponent- Returns:
- an array containing the selected layers, or an empty array when no layers were selected.
- See Also:
-
setPopupMenu
Sets the popup menu of this map component. It is not added to the GUI, nor registered to be shown on mouse click or similar actions.
The '
aPopupMenu' must be mediated by theTLcyActionBarUtilwith action bar ID "popupMenu" and this map as the context, e.g.:TLcyActionBarUtil.mediate( aPopupMenu, "popupMenu", this, lucyEnv.getUserInterfaceManager().getActionBarManager() );- Parameters:
aPopupMenu- The popup menu.- See Also:
-
getMapName
Description copied from interface:ILcyGenericMapComponentReturns the name of the map. This name can be presented to the user.- Specified by:
getMapNamein interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the name of the map.
-
setMapName
Description copied from interface:ILcyGenericMapComponentSets the name of the map.- Specified by:
setMapNamein interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Parameters:
aMapName- the new name of the map.- See Also:
-
setSelectedLayersAsList
Description copied from interface:ILcyMapComponentSets 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 changedIf none of the layers should be selected, this method should be called with an empty list.
This method is identical to
ILcyMapComponent.setSelectedLayers(com.luciad.view.gxy.ILcdGXYLayer[]). Setting the selected layers with this method will fire a property change event for both theselectedLayersproperty and theselectedLayersAsListproperty.- Specified by:
setSelectedLayersAsListin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Specified by:
setSelectedLayersAsListin interfaceILcyMapComponent- Parameters:
aSelectedLayers- the layers to be selected. Must not benull- See Also:
-
getSelectedLayersAsList
Description copied from interface:ILcyMapComponentReturns 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
ILcyMapComponent.getSelectedLayers().- Specified by:
getSelectedLayersAsListin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Specified by:
getSelectedLayersAsListin interfaceILcyMapComponent- Returns:
- a list containing the selected layers, or an empty list when no layers were selected.
- See Also:
-
getToolBarComponent
Description copied from interface:ILcyGenericMapComponentReturns the tool bar component. Note that it can be different from getToolBar(), possibly to add some decoration. This component is used to toggle the visibility of the toolbar.
- Specified by:
getToolBarComponentin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the tool bar component.
- See Also:
-
setToolBarComponent
Sets the tool bar component.
- Parameters:
aToolBarComponent- the tool bar component- See Also:
-
getMenuBarComponent
Description copied from interface:ILcyGenericMapComponentReturns the menu bar component. Note that it can be different from getMenuBar(), possibly to add some decoration. This component is used to toggle the visibility of the menu bar.
- Specified by:
getMenuBarComponentin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the menu bar component.
- See Also:
-
setMenuBarComponent
Sets the menu bar component.
- Parameters:
aMenuBarComponent- the menu bar component- See Also:
-
getLayerControlComponent
Description copied from interface:ILcyGenericMapComponentReturns the layer control component. Note that it can be different from getLayerControl(), possibly to add some decoration. This component is used to toggle the visibility of the layercontrol.
- Specified by:
getLayerControlComponentin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the layer control component.
- See Also:
-
setLayerControlComponent
Sets the layer control component.
- Parameters:
aMapLayerControlComponent- The component- See Also:
-
getStatusBarComponent
Description copied from interface:ILcyGenericMapComponentReturns the status bar component. This component is used to toggle the visibility of the status bar.
- Specified by:
getStatusBarComponentin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the status bar component.
-
setStatusBarComponent
Sets the status bar compoment.
- Parameters:
aStatusBarComponent- The status bar component.
-
setToolBarVisible
public void setToolBarVisible(boolean aToolBarVisible) Sets the tool bar visible or not. Works on the tool bar component.
- Parameters:
aToolBarVisible- True if the tool bar must be visible, false otherwise.- See Also:
-
isToolBarVisible
public boolean isToolBarVisible()Description copied from interface:ILcyGenericMapComponentReturns true if the tool bar is visible, false otherwise.
- Specified by:
isToolBarVisiblein interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- true if the tool bar is visible, false otherwise.
-
setMenuBarVisible
public void setMenuBarVisible(boolean aMenuBarVisible) Sets the menu bar visible or not. Works on the menu bar component.
- Parameters:
aMenuBarVisible- True if the menu bar must be visible, false otherwise.- See Also:
-
isMenuBarVisible
public boolean isMenuBarVisible()Description copied from interface:ILcyGenericMapComponentReturns true if the menu bar is visible, false otherwise.
- Specified by:
isMenuBarVisiblein interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- true if the menu bar is visible, false otherwise.
-
setStatusBarVisible
public void setStatusBarVisible(boolean aStatusBarVisible) Sets the status bar visible or not. Works on the status bar component.
- Parameters:
aStatusBarVisible- True if the status bar must be visible, false otherwise.- See Also:
-
isStatusBarVisible
public boolean isStatusBarVisible()Description copied from interface:ILcyGenericMapComponentReturns true if the status bar is visible, false otherwise.
- Specified by:
isStatusBarVisiblein interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- true if the status bar is visible, false otherwise.
-
setLayerControlVisible
public void setLayerControlVisible(boolean aLayerControlVisible) Sets the layer control visible or not. Works on the layer control component.
- Parameters:
aLayerControlVisible- True if the layer control must be visible, false otherwise.- See Also:
-
isLayerControlVisible
public boolean isLayerControlVisible()Description copied from interface:ILcyGenericMapComponentReturns true if the layer control is visible, false otherwise.
- Specified by:
isLayerControlVisiblein interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- true if the layer control is visible, false otherwise.
-
isPopupMenuCapable
public boolean isPopupMenuCapable()Description copied from interface:ILcyGenericMapComponentReturns true if this map component has a popup menu (getPopupMenu() != null)
- Specified by:
isPopupMenuCapablein interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- true if this map component has a popup menu.
-
isMenuBarCapable
public boolean isMenuBarCapable()Description copied from interface:ILcyGenericMapComponentReturns true if the map has its own menu bar, false otherwise.
- Specified by:
isMenuBarCapablein interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- true if the map has its own menu bar, false otherwise.
- See Also:
-
isToolBarCapable
public boolean isToolBarCapable()Description copied from interface:ILcyGenericMapComponentReturns true if this map has its own toolbar, false otherwise.
- Specified by:
isToolBarCapablein interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- true if this map has its own toolbar, false otherwise.
- See Also:
-
isStatusBarCapable
public boolean isStatusBarCapable()Description copied from interface:ILcyGenericMapComponentReturns true if this map has its own statusbar, false otherwise
- Specified by:
isStatusBarCapablein interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- true if this map component has its own status bar, false otherwise.
- See Also:
-
isLayerControlCapable
public boolean isLayerControlCapable()Description copied from interface:ILcyGenericMapComponentReturns true if this map has its own layer control, false otherwise.
- Specified by:
isLayerControlCapablein interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- true if this map has its own layer control, false otherwise.
- See Also:
-
getNorthPanel
Returns the container at the north of the main view. Can be used to insert custom components to the map.
It returns the panel that was set usingsetNorthPanel(java.awt.Container).- Specified by:
getNorthPanelin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the container at the north of the main view.
-
getSouthPanel
Returns the container at the south of the main view. Can be used to insert custom components to the map.
It returns the panel that was set usingsetSouthPanel(java.awt.Container).- Specified by:
getSouthPanelin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the container at the south of the main view.
-
getWestPanel
Returns the container at the west of the main view. Can be used to insert custom components to the map.
It returns the panel that was set usingsetWestPanel(java.awt.Container).- Specified by:
getWestPanelin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the container at the west of the main view.
-
getEastPanel
Returns the container at the east of the main view. Can be used to insert custom components to the map.
It returns the panel that was set usingsetEastPanel(java.awt.Container).- Specified by:
getEastPanelin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the container at the east of the main view.
-
getCenterPanel
Description copied from interface:ILcyGenericMapComponentReturns the container in the center, typically containing the main view. Can be used to insert custom components to the map.
- Specified by:
getCenterPanelin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the container in the center, typically containing the main view.
-
getMapOverlayPanel
Description copied from interface:ILcyGenericMapComponentReturns the Map Overlay Panel.
This panel can be used to add components that have to hover over the view. It uses a custom layout manager,
TLcdOverlayLayout. For information on how to add components in specific locations, see the documentation there.- Specified by:
getMapOverlayPanelin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- A container that usually contains components that are visible over the view.
- See Also:
-
setNorthPanel
Sets the north panel of this map component. Note that the panel is not added to the Swing component hierarchy, this is the responsibility of the user of this method.- Parameters:
aNorthPanel- The north panel.
-
setSouthPanel
Sets the south panel of this map component. Note that the panel is not added to the Swing component hierarchy, this is the responsibility of the user of this method.- Parameters:
aSouthPanel- The south panel.
-
setWestPanel
Sets the west panel of this map component. Note that the panel is not added to the Swing component hierarchy, this is the responsibility of the user of this method.- Parameters:
aWestPanel- The west panel.
-
setEastPanel
Sets the east panel of this map component. Note that the panel is not added to the Swing component hierarchy, this is the responsibility of the user of this method.- Parameters:
aEastPanel- The east panel.
-
setCenterPanel
Sets the center panel of this map component. Note that the panel is not added to the Swing component hierarchy, this is the responsibility of the user of this method.- Parameters:
aCenterPanel- The center panel.
-
setMapOverlayPanel
Sets the map overlay panel of this map component. Note that the panel is not added to the Swing component hierarchy, this is the responsibility of the user of this method.- Parameters:
aMapOverlayPanel- The map overlay panel.
-
getMenuBar
Description copied from interface:ILcyGenericMapComponentReturns the menu bar of the map. Only relevant if isMenuBarCapable returns true.
- Specified by:
getMenuBarin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the menu bar of the map or null if there is no menu bar.
- See Also:
-
setMenuBar
Sets the menu bar of this map component. It is not added to the GUI.
The '
aMenuBar' must be mediated by theTLcyActionBarUtilwith action bar ID "menuBar" and this map as the context, e.g.:TLcyActionBarUtil.mediate( aMenuBar, "menuBar", this, lucyEnv.getUserInterfaceManager().getActionBarManager() );- Parameters:
aMenuBar- The menu bar.- See Also:
-
getToolBar
Description copied from interface:ILcyGenericMapComponentReturns the toolbar of this map. Only relevant if isToolBarCapable returns true.
- Specified by:
getToolBarin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the toolbar of this map, or
nullif there is no toolbar. - See Also:
-
setToolBar
Sets the tool bar of this map component. It is not added to the GUI.
The '
aToolBar' must be mediated by theTLcyActionBarUtilwith action bar ID "toolBar" and this map as the context, e.g.:TLcyActionBarUtil.mediate( aToolBar, "toolBar", this, lucyEnv.getUserInterfaceManager().getActionBarManager() );- Parameters:
aToolBar- The tool bar.- See Also:
-
getLayerControl
Description copied from interface:ILcyGenericMapComponentReturns the layer control of this map. Only relevant if isLayerControlCapable returns true.
- Specified by:
getLayerControlin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the layer control of this map.
- See Also:
-
setLayerControl
Sets the layer control of this map.
- Parameters:
aLayerControl- The layer control- See Also:
-
getPopupMenu
Description copied from interface:ILcyGenericMapComponentReturns the popup menu of this map component. Only relevant if isPopupMenuCapable() returns true.
- Specified by:
getPopupMenuin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the popup menu of this map component.
- See Also:
-
getMainView
Description copied from interface:ILcyGenericMapComponentReturns the main component of a lucy map: the view.
- Specified by:
getMainViewin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the main view.
-
getStatusBar
Description copied from interface:ILcyGenericMapComponentReturns the statusbar of this map. Only relevant if isStatusBarCapable returns true.
- Specified by:
getStatusBarin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the statusbar of this map, or
nullif there is no statusbar.
-
setStatusBar
Sets the statusbar of this map compoennt. It is not added to the GUI.
The '
aStatusBar' must be mediated by theTLcyActionBarUtilwith action bar ID "statusBar" and this map as the context, e.g.:TLcyActionBarUtil.mediate( aToolBar, "toolBar", this, lucyEnv.getUserInterfaceManager().getActionBarManager());- Parameters:
aStatusBar- the statusbar- See Also:
-
getNorthContentPane
Description copied from interface:ILcyMapComponentReturns the container at the north of the main gxy view. Can be used to insert custom components to the map.- Specified by:
getNorthContentPanein interfaceILcyMapComponent- Returns:
- the container at the north of the main gxy view.
-
getSouthContentPane
Description copied from interface:ILcyMapComponentReturns the container at the south of the main gxy view. Can be used to insert custom components to the map.- Specified by:
getSouthContentPanein interfaceILcyMapComponent- Returns:
- the container at the south of the main gxy view.
-
getWestContentPane
Description copied from interface:ILcyMapComponentReturns the container at the west of the main gxy view. Can be used to insert custom components to the map.- Specified by:
getWestContentPanein interfaceILcyMapComponent- Returns:
- the container at the west of the main gxy view.
-
getEastContentPane
Description copied from interface:ILcyMapComponentReturns the container at the east of the main gxy view. Can be used to insert custom components to the map.- Specified by:
getEastContentPanein interfaceILcyMapComponent- Returns:
- the container at the east of the main gxy view.
-
setMapPopupMenu
Deprecated.UsesetPopupMenu(com.luciad.lucy.gui.ILcyPopupMenu)insteadSets the popup menu of this map component. It is not added to the GUI, nor registered to be shown on mouse click or similar actions.
The '
aMapPopupMenu' must be mediated by theTLcyActionBarUtilwith action bar ID "popupMenu" and this map as the context, e.g.:TLcyActionBarUtil.mediate( aMapPopupMenu, "popupMenu", this, lucyEnv.getUserInterfaceManager().getActionBarManager() );- Parameters:
aMapPopupMenu- The popup menu.- See Also:
-
getMapPopupMenu
Deprecated.UsegetPopupMenu()insteadReturns the popup menu of this map component. Only relevant if isPopupMenuCapable() returns true.
- Returns:
- the popup menu of this map component.
- See Also:
-
getBalloonManager
Description copied from interface:ILcyGenericMapComponentReturns the balloon manager of this map component.
- Specified by:
getBalloonManagerin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Returns:
- the balloon manager of this map component. Can be
null - See Also:
-
setBalloonManager
Description copied from interface:ILcyGenericMapComponentSet the balloon manager of this map component.
The balloon manager allows to display balloons on the map.
- Specified by:
setBalloonManagerin interfaceILcyGenericMapComponent<ILcdGXYView,ILcdGXYLayer> - Parameters:
aBalloonManager- the balloon manager. May benull.- See Also:
-
getPopupMenu()instead