Package com.luciad.lucy.map.lightspeed

Class TLcyLspMapComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.luciad.lucy.map.lightspeed.TLcyLspMapComponent

All Implemented Interfaces:

ILcyGenericMapComponent<ILspView,ILspLayer>, ILcyLspMapComponent, ILcdDisposable, ILcdPropertyChangeSource, ImageObserver, MenuContainer, Serializable, AutoCloseable, Accessible

public class TLcyLspMapComponent
extends JPanel
implements ILcyLspMapComponent

Default implementation of ILcyLspMapComponent.

It provides support for an ILspView (often in the center), and support for an optional toolbar, optional menubar, optional status bar and optional layer control. Note however that the TLcyLspMapComponent 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 setNorthContentPane, it is not added to the user interface.

TLcyLspMapComponents are typically created using a TLcyLspMapComponentFactory.

Since:

2012.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested 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_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.luciad.lucy.map.lightspeed.ILcyLspMapComponent

DEFAULT_MAP_TYPE, TOUCH_MAP_TYPE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
TLcyLspMapComponent(ILcyLucyEnv aLucyEnv)	Constructs a new TLcyLspMapComponent.
TLcyLspMapComponent(ILspView aMainView, ILcyLucyEnv aLucyEnv)	Constructs a new TLspMapComponent for the given view.

Method Summary

Modifier and Type	Method	Description
void	addAvailableController(ILspController aController)	Adds the given controller to the list of available controllers associated with this map.
void	addAvailableController(ILspController aController, int aID)	Adds the given controller, together with its ID, to the list of available controllers associated with this map.
void	dispose()	Disposes of this object and allows it to release any system resources that it is holding.
ILspController	getAvailableController(int aIndex)	Returns the Controller at the given index.
int	getAvailableControllerCount()	Returns the number of controllers associated with this map.
int	getAvailableControllerID(int aIndex)	Returns the ID of the Controller at the given index, or -1 if no ID was ever associated with the controller at the given index.
ALcdBalloonManager	getBalloonManager()	Returns the balloon manager of this map component.
Container	getCenterPanel()	Returns the container in the center, typically containing the main view.
Component	getComponent()	Returns the Component representing this map, e.g., this.
Container	getEastPanel()	Returns the container at the east of the main view.
ILcyMapLayerControl	getLayerControl()	Returns the layer control of this map.
Component	getLayerControlComponent()	Returns the layer control component.
ILspView	getMainView()	Returns the main component of a lucy map: the view.
String	getMapName()	Returns the name of the map.
Container	getMapOverlayPanel()	Returns the Map Overlay Panel.
ILcyMenuBar	getMenuBar()	Returns the menu bar of the map.
Component	getMenuBarComponent()	Returns the menu bar component.
Container	getNorthPanel()	Returns the container at the north of the main view.
ILcyPopupMenu	getPopupMenu()	Returns the popup menu of this map component.
TLcyStringProperties	getProperties()	Returns a TLcyStringProperties instance associated with the map component.
List<ILspLayer>	getSelectedLayersAsList()	Returns the selected layers.
Container	getSouthPanel()	Returns the container at the south of the main view.
ILcyToolBar	getStatusBar()	Returns the statusbar of this map.
Component	getStatusBarComponent()	Returns the status bar component.
ILcyToolBar	getToolBar()	Returns the toolbar of this map.
Component	getToolBarComponent()	Returns the tool bar component.
String	getType()	Returns a String representing the type of the map component.
Container	getWestPanel()	Returns the container at the west of the main view.
boolean	isLayerControlCapable()	Returns true if this map has its own layer control, false otherwise.
boolean	isLayerControlVisible()	Returns true if the layer control is visible, false otherwise.
boolean	isMenuBarCapable()	Returns true if the map has its own menu bar, false otherwise.
boolean	isMenuBarVisible()	Returns true if the menu bar is visible, false otherwise.
boolean	isPopupMenuCapable()	Returns true if this map component has a popup menu (getPopupMenu() != null)
boolean	isStatusBarCapable()	Returns true if this map has its own statusbar, false otherwise
boolean	isStatusBarVisible()	Returns true if the status bar is visible, false otherwise.
boolean	isToolBarCapable()	Returns true if this map has its own toolbar, false otherwise.
boolean	isToolBarVisible()	Returns true if the tool bar is visible, false otherwise.
void	removeAvailableController(ILspController aController)	Removes the given controller from the list of available controllers.
ILspController	retrieveAvailableController(int aID)	Returns the controller with the given ID, or null if there is no such controller.
void	setBalloonManager(ALcdBalloonManager aBalloonManager)	Set the balloon manager of this map component.
void	setCenterContentPane(Container aCenterContentPane)	Sets the center panel of this map component.
void	setEastContentPane(Container aEastContentPane)	Sets the east panel of this map component.
void	setLayerControl(ILcyMapLayerControl aLayerControl)	Sets the layer control of this map.
void	setLayerControlComponent(Component aMapLayerControlComponent)	Sets the layer control component.
void	setLayerControlVisible(boolean aLayerControlVisible)	Sets the layer control visible or not.
void	setMainview(ILspView aView)	Sets the main component of a Lucy map: the view.
void	setMapName(String aMapName)	Sets the name of the map.
void	setMapOverlayPanel(Container aMapOverlayPanel)	Sets the map overlay panel of this map component.
void	setMenuBar(ILcyMenuBar aMenuBar)	Sets the menu bar of this map component.
void	setMenuBarComponent(Component aMenuBarComponent)	Sets the menu bar component.
void	setMenuBarVisible(boolean aMenuBarVisible)	Sets the menu bar visible or not.
void	setNorthContentPane(Container aNorthContentPane)	Sets the north panel of this map component.
void	setPopupMenu(ILcyPopupMenu aPopupMenu)	Sets the popup menu of this map component.
void	setSelectedLayersAsList(List<? extends ILspLayer> aSelectedLayers)	Sets the selected layers to the layers contained in aSelectedLayers.
void	setSouthContentPane(Container aSouthContentPane)	Sets the south panel of this map component.
void	setStatusBar(ILcyToolBar aStatusBar)	Sets the statusbar of this map component.
void	setStatusBarComponent(Component aStatusBarComponent)	Sets the status bar component.
void	setStatusBarVisible(boolean aStatusBarVisible)	Sets the status bar visible or not.
void	setToolBar(ILcyToolBar aToolBar)	Sets the tool bar of this map component.
void	setToolBarComponent(Component aToolBarComponent)	Sets the tool bar component.
void	setToolBarVisible(boolean aToolBarVisible)	Sets the tool bar visible or not.
void	setType(String aType)	Sets the type of this map component
void	setWestContentPane(Container aWestContentPane)	Sets the west panel of this map component.
String	toString()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods 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, update

Methods 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, validateTree

Methods 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.util.ILcdDisposable

close

Methods inherited from interface com.luciad.util.ILcdPropertyChangeSource

addPropertyChangeListener, removePropertyChangeListener

Constructor Details

TLcyLspMapComponent

public TLcyLspMapComponent(ILcyLucyEnv aLucyEnv)

Constructs a new TLcyLspMapComponent.

It is necessary to set at least a view on this map component before using it.

Parameters:

aLucyEnv - The Lucy back-end

See Also:

• setMainview(com.luciad.view.lightspeed.ILspView)

TLcyLspMapComponent

public TLcyLspMapComponent(ILspView aMainView,
 ILcyLucyEnv aLucyEnv)

Constructs a new TLspMapComponent for the given view.

After calling this constructor with a non-null view, it is not allowed to call setMainview(com.luciad.view.lightspeed.ILspView).

Parameters:

aMainView - the view of this map component. Note that the view is not added to the Swing component

aLucyEnv - The Lucy back-end

Method Details

getComponent

public Component getComponent()

Description copied from interface: ILcyGenericMapComponent

Returns the Component representing this map, e.g., this.

Specified by:

getComponent in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the Component representing this map.

dispose

public void dispose()

Description copied from interface: ILcyGenericMapComponent

Disposes 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:

dispose in interface ILcdDisposable

Specified by:

dispose in interface ILcyGenericMapComponent<ILspView,ILspLayer>

getAvailableControllerCount

public int getAvailableControllerCount()

Returns the number of controllers associated with this map.

Returns:

the number of controllers associated with this map.

See Also:

• getAvailableController(int)

getAvailableController

public ILspController getAvailableController(int aIndex)

Returns the Controller at the given index.

Parameters:

aIndex - the index of the controller to retrieve. 0 <= aIndex < getAvailableControllerCount().

Returns:

the controller at the given index.

See Also:

• getAvailableControllerCount()

getAvailableControllerID

public int getAvailableControllerID(int aIndex)

Returns the ID of the Controller at the given index, or -1 if no ID was ever associated with the controller at the given index.

Parameters:

aIndex - the index of the controller to retrieve the ID for. 0 <= aIndex < getAvailableControllerCount().

Returns:

the ID of the controller at the given index, or -1 if no ID was ever registered (see addAvailableController).

See Also:

• getAvailableControllerCount()

addAvailableController

public void addAvailableController(ILspController aController)

Adds 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 means getAvailableControllerID for the index of this controller will return -1.

Parameters:

aController - the controller to add.

See Also:

• removeAvailableController(com.luciad.view.lightspeed.controller.ILspController)
• getAvailableControllerCount()
• getAvailableController(int)

addAvailableController

public void addAvailableController(ILspController aController,
 int aID)

Adds 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.

Parameters:

aController - 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 TLcyLspMapComponentFactory ending in CONTROLLER, e.g. SELECTION_PAN_CONTROLLER.

See Also:

• removeAvailableController(com.luciad.view.lightspeed.controller.ILspController)
• getAvailableControllerCount()
• getAvailableController(int)
• getAvailableControllerID(int)
• retrieveAvailableController(int)

removeAvailableController

public void removeAvailableController(ILspController aController)

Removes the given controller from the list of available controllers.

Parameters:

aController - the controller to remove.

See Also:

• addAvailableController(com.luciad.view.lightspeed.controller.ILspController)

retrieveAvailableController

public ILspController retrieveAvailableController(int aID)

Returns the controller with the given ID, or null if there is no such controller.

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 in TLcyLspMapComponentFactory ending in CONTROLLER, e.g. SELECTION_PAN_CONTROLLER.

Returns:

the controller for the given ID, or null if there is no such controller.

See Also:

• getAvailableControllerCount()
• addAvailableController(ILspController, int)

toString

public String toString()

Overrides:

toString in class Component

setMainview

public void setMainview(ILspView aView)

Sets the main component of a Lucy map: the view.

This method may only be called once with a non-null view.

Parameters:

aView - The main view

getMapName

public String getMapName()

Description copied from interface: ILcyGenericMapComponent

Returns the name of the map. This name can be presented to the user.

Specified by:

getMapName in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the name of the map.

setMapName

public void setMapName(String aMapName)

Description copied from interface: ILcyGenericMapComponent

Sets the name of the map.

Specified by:

setMapName in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Parameters:

aMapName - the new name of the map.

See Also:

• ILcyGenericMapComponent.getMapName()

setSelectedLayersAsList

public void setSelectedLayersAsList(List<? extends ILspLayer> aSelectedLayers)

Description copied from interface: ILcyGenericMapComponent

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.

Specified by:

setSelectedLayersAsList in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Parameters:

aSelectedLayers - the layers to be selected. Must not be null

See Also:

• ILcyGenericMapComponent.getSelectedLayersAsList()

getSelectedLayersAsList

public List<ILspLayer> getSelectedLayersAsList()

Description copied from interface: ILcyGenericMapComponent

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.

Specified by:

getSelectedLayersAsList in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

a list containing the selected layers, or an empty list when no layers were selected.

See Also:

• ILcyGenericMapComponent.setSelectedLayersAsList(java.util.List)

getMainView

public ILspView getMainView()

Description copied from interface: ILcyGenericMapComponent

Returns the main component of a lucy map: the view.

Specified by:

getMainView in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the main view.

getNorthPanel

public Container getNorthPanel()

Description copied from interface: ILcyGenericMapComponent

Returns the container at the north of the main view. Can be used to insert custom components to the map.

Specified by:

getNorthPanel in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the container at the north of the main view.

getSouthPanel

public Container getSouthPanel()

Description copied from interface: ILcyGenericMapComponent

Returns the container at the south of the main view. Can be used to insert custom components to the map.

Specified by:

getSouthPanel in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the container at the south of the main view.

getWestPanel

public Container getWestPanel()

Description copied from interface: ILcyGenericMapComponent

Returns the container at the west of the main view. Can be used to insert custom components to the map.

Specified by:

getWestPanel in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the container at the west of the main view.

getEastPanel

public Container getEastPanel()

Description copied from interface: ILcyGenericMapComponent

Returns the container at the east of the main view. Can be used to insert custom components to the map.

Specified by:

getEastPanel in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the container at the east of the main view.

isPopupMenuCapable

public boolean isPopupMenuCapable()

Description copied from interface: ILcyGenericMapComponent

Returns true if this map component has a popup menu (getPopupMenu() != null)

Specified by:

isPopupMenuCapable in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

true if this map component has a popup menu.

isMenuBarCapable

public boolean isMenuBarCapable()

Description copied from interface: ILcyGenericMapComponent

Returns true if the map has its own menu bar, false otherwise.

Specified by:

isMenuBarCapable in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

true if the map has its own menu bar, false otherwise.

See Also:

• ILcyGenericMapComponent.getMenuBar()

isToolBarCapable

public boolean isToolBarCapable()

Description copied from interface: ILcyGenericMapComponent

Returns true if this map has its own toolbar, false otherwise.

Specified by:

isToolBarCapable in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

true if this map has its own toolbar, false otherwise.

See Also:

• ILcyGenericMapComponent.getToolBar()

getToolBar

public ILcyToolBar getToolBar()

Description copied from interface: ILcyGenericMapComponent

Returns the toolbar of this map. Only relevant if isToolBarCapable returns true.

Specified by:

getToolBar in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the toolbar of this map, or null if there is no toolbar.

See Also:

• ILcyGenericMapComponent.isToolBarCapable()

isLayerControlCapable

public boolean isLayerControlCapable()

Description copied from interface: ILcyGenericMapComponent

Returns true if this map has its own layer control, false otherwise.

Specified by:

isLayerControlCapable in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

true if this map has its own layer control, false otherwise.

See Also:

• ILcyGenericMapComponent.getLayerControl()

getLayerControlComponent

public Component getLayerControlComponent()

Description copied from interface: ILcyGenericMapComponent

Returns 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:

getLayerControlComponent in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the layer control component.

See Also:

• ILcyGenericMapComponent.getLayerControl()

getLayerControl

public ILcyMapLayerControl getLayerControl()

Description copied from interface: ILcyGenericMapComponent

Returns the layer control of this map. Only relevant if isLayerControlCapable returns true.

Specified by:

getLayerControl in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the layer control of this map.

See Also:

• ILcyGenericMapComponent.isLayerControlCapable()

getToolBarComponent

public Component getToolBarComponent()

Description copied from interface: ILcyGenericMapComponent

Returns 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:

getToolBarComponent in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the tool bar component.

See Also:

• ILcyGenericMapComponent.getToolBar()

setToolBarComponent

public void setToolBarComponent(Component aToolBarComponent)

Sets the tool bar component.

Parameters:

aToolBarComponent - the tool bar component

See Also:

• getToolBarComponent()

getMenuBarComponent

public Component getMenuBarComponent()

Description copied from interface: ILcyGenericMapComponent

Returns 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:

getMenuBarComponent in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the menu bar component.

See Also:

• ILcyGenericMapComponent.getMenuBar()

setMenuBarComponent

public void setMenuBarComponent(Component aMenuBarComponent)

Sets the menu bar component.

Parameters:

aMenuBarComponent - the menu bar component

See Also:

• getMenuBarComponent()

setLayerControlComponent

public void setLayerControlComponent(Component aMapLayerControlComponent)

Sets the layer control component.

Parameters:

aMapLayerControlComponent - The component

See Also:

• getLayerControlComponent()

getStatusBarComponent

public Component getStatusBarComponent()

Description copied from interface: ILcyGenericMapComponent

Returns the status bar component. This component is used to toggle the visibility of the status bar.

Specified by:

getStatusBarComponent in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the status bar component.

setStatusBarComponent

public void setStatusBarComponent(Component aStatusBarComponent)

Sets the status bar component.

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()
• getToolBarComponent()

isToolBarVisible

public boolean isToolBarVisible()

Description copied from interface: ILcyGenericMapComponent

Returns true if the tool bar is visible, false otherwise.

Specified by:

isToolBarVisible in interface ILcyGenericMapComponent<ILspView,ILspLayer>

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()
• getMenuBarComponent()

isMenuBarVisible

public boolean isMenuBarVisible()

Description copied from interface: ILcyGenericMapComponent

Returns true if the menu bar is visible, false otherwise.

Specified by:

isMenuBarVisible in interface ILcyGenericMapComponent<ILspView,ILspLayer>

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()
• getStatusBarComponent()

isStatusBarVisible

public boolean isStatusBarVisible()

Description copied from interface: ILcyGenericMapComponent

Returns true if the status bar is visible, false otherwise.

Specified by:

isStatusBarVisible in interface ILcyGenericMapComponent<ILspView,ILspLayer>

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()
• getLayerControlComponent()

isLayerControlVisible

public boolean isLayerControlVisible()

Description copied from interface: ILcyGenericMapComponent

Returns true if the layer control is visible, false otherwise.

Specified by:

isLayerControlVisible in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

true if the layer control is visible, false otherwise.

isStatusBarCapable

public boolean isStatusBarCapable()

Description copied from interface: ILcyGenericMapComponent

Returns true if this map has its own statusbar, false otherwise

Specified by:

isStatusBarCapable in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

true if this map component has its own status bar, false otherwise.

See Also:

• ILcyGenericMapComponent.getStatusBar()

setNorthContentPane

public void setNorthContentPane(Container aNorthContentPane)

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:

aNorthContentPane - the north content pane.

setSouthContentPane

public void setSouthContentPane(Container aSouthContentPane)

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:

aSouthContentPane - the south content pane.

setWestContentPane

public void setWestContentPane(Container aWestContentPane)

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:

aWestContentPane - the west content pane.

setEastContentPane

public void setEastContentPane(Container aEastContentPane)

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:

aEastContentPane - the east content pane.

setCenterContentPane

public void setCenterContentPane(Container aCenterContentPane)

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:

aCenterContentPane - the center content pane.

setMapOverlayPanel

public void setMapOverlayPanel(Container aMapOverlayPanel)

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.

setMenuBar

public void setMenuBar(ILcyMenuBar aMenuBar)

Sets the menu bar of this map component. It is not added to the GUI.

The 'aMenuBar' must be mediated by the TLcyActionBarUtil with 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:

• getMenuBar()

setToolBar

public void setToolBar(ILcyToolBar aToolBar)

Sets the tool bar of this map component. It is not added to the GUI.

The 'aToolBar' must be mediated by the TLcyActionBarUtil with 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:

• getToolBar()

setLayerControl

public void setLayerControl(ILcyMapLayerControl aLayerControl)

Sets the layer control of this map.

Parameters:

aLayerControl - The layer control

See Also:

• getLayerControl()

getPopupMenu

public ILcyPopupMenu getPopupMenu()

Description copied from interface: ILcyGenericMapComponent

Returns the popup menu of this map component. Only relevant if isPopupMenuCapable() returns true.

Specified by:

getPopupMenu in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the popup menu of this map component.

See Also:

• ILcyGenericMapComponent.isPopupMenuCapable()

setPopupMenu

public void setPopupMenu(ILcyPopupMenu aPopupMenu)

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 the TLcyActionBarUtil with 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:

• getPopupMenu()

getCenterPanel

public Container getCenterPanel()

Description copied from interface: ILcyGenericMapComponent

Returns the container in the center, typically containing the main view. Can be used to insert custom components to the map.

Specified by:

getCenterPanel in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the container in the center, typically containing the main view.

getMapOverlayPanel

public Container getMapOverlayPanel()

Description copied from interface: ILcyGenericMapComponent

Returns 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:

getMapOverlayPanel in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

A container that usually contains components that are visible over the view.

See Also:

• TLcdOverlayLayout

getMenuBar

public ILcyMenuBar getMenuBar()

Description copied from interface: ILcyGenericMapComponent

Returns the menu bar of the map. Only relevant if isMenuBarCapable returns true.

Specified by:

getMenuBar in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the menu bar of the map or null if there is no menu bar.

See Also:

• ILcyGenericMapComponent.isMenuBarCapable()

getStatusBar

public ILcyToolBar getStatusBar()

Description copied from interface: ILcyGenericMapComponent

Returns the statusbar of this map. Only relevant if isStatusBarCapable returns true.

Specified by:

getStatusBar in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the statusbar of this map, or null if there is no statusbar.

setType

public void setType(String aType)

Sets the type of this map component

Parameters:

aType - The type

See Also:

• getType()

getType

public String getType()

Description copied from interface: ILcyLspMapComponent

Returns a String representing the type of the map component.

A possible use-case of the type of a map component is to distinguish between the regular/default map components and e.g. "mission-view" map components.

Specified by:

getType in interface ILcyLspMapComponent

Returns:

a String representing the type of the map component, never null

setStatusBar

public void setStatusBar(ILcyToolBar aStatusBar)

Sets the statusbar of this map component. It is not added to the GUI.

The 'aStatusBar' must be mediated by the TLcyActionBarUtil with 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:

• getStatusBar()

getBalloonManager

public ALcdBalloonManager getBalloonManager()

Description copied from interface: ILcyGenericMapComponent

Returns the balloon manager of this map component.

Specified by:

getBalloonManager in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Returns:

the balloon manager of this map component. Can be null

See Also:

• ILcyGenericMapComponent.setBalloonManager(com.luciad.view.swing.ALcdBalloonManager)

setBalloonManager

public void setBalloonManager(ALcdBalloonManager aBalloonManager)

Description copied from interface: ILcyGenericMapComponent

Set the balloon manager of this map component.

The balloon manager allows to display balloons on the map.

Specified by:

setBalloonManager in interface ILcyGenericMapComponent<ILspView,ILspLayer>

Parameters:

aBalloonManager - the balloon manager. May be null.

See Also:

• ILcyGenericMapComponent.getBalloonManager()

getProperties

public TLcyStringProperties getProperties()

Description copied from interface: ILcyLspMapComponent

Returns a TLcyStringProperties instance associated with the map component. This instance can be used to store extra information about a map component. The key-value pairs are automatically stored in the workspace, and can as such be used to make custom map properties persistent.

Specified by:

getProperties in interface ILcyLspMapComponent

Returns:

a TLcyStringProperties instance associated with this map component, never null