com.luciad.lucy.map

LuciadLightspeedClass TLcyMapLayerControl

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.luciad.lucy.map.TLcyMapLayerControl

All Implemented Interfaces:

ILcyMapLayerControl, ImageObserver, MenuContainer, Serializable, Accessible

public class TLcyMapLayerControl
extends JPanel
implements ILcyMapLayerControl

This is an implementation of ILcyMapLayerControl that does not contain any user interface elements. It just keeps track of layer selection and it can contain an ILcyActionBar. It is up to the user of this class however to set such an ILcyActionBar and to add user interface components to this TLcyMapLayerControl. The accelerator keys registered to the actions of that ILcyActionBar are automatically respected.

TLcyMapLayerControl instances are typically created by a TLcyMapLayerControlFactory. The creation process can be modified by extending this factory.

See Also:

TLcyMapLayerControlFactory, 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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
TLcyMapLayerControl(TLcyMapComponent aMapComponent) Creates a new TLcyMapLayerControl according to the given construction options.

Method Summary

Modifier and Type	Method and Description
ILcyActionBar	getActionBar() Returns the action bar containing the layer actions.
Component	getComponent() Returns the visual representation of the map layer control.
TLcyMapComponent	getMapComponent() Returns the map component this layer control operates on.
ILcyActionBar	getOrderActionBar()
ILcyPopupMenu	getPopupMenu()
ILcdGXYLayer	getSelectedLayer() Deprecated. Please use the methods getSelectedLayers and setSelectedLayers. These have the ability to work with multiple selection.
ILcdGXYLayer[]	getSelectedLayers() Returns the selected layers.
boolean	isTraceOn() Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
void	setActionBar(ILcyActionBar aActionBar) Sets the action bar that is associated with this layer control.
static void	setClassTraceOn(boolean aClassTraceOn) Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
void	setMapComponent(TLcyMapComponent aMapComponent) Sets the map component this layer control operates on.
void	setOrderActionBar(ILcyActionBar aOrderActionBar)
void	setPopupMenu(ILcyPopupMenu aPopupMenu)
void	setSelectedLayer(ILcdGXYLayer aLayer) Deprecated. Please use the methods getSelectedLayers and setSelectedLayers. These have the ability to work with multiple selection.
void	setSelectedLayers(ILcdGXYLayer[] aSelectedLayers) Sets the selected layers to the layers contained in aSelectedLayers.
void	setTraceOn(boolean aTraceOn) Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcyMapLayerControl

public TLcyMapLayerControl(TLcyMapComponent aMapComponent)

Creates a new TLcyMapLayerControl according to the given construction options.

Parameters:

aMapComponent - The TLcyMapComponent this layer control works with.

Method Detail

setClassTraceOn

@Deprecated
public static void setClassTraceOn(boolean aClassTraceOn)

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 is true then 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
public void setTraceOn(boolean aTraceOn)

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 either true or false as argument automatically turns off tracing for all other class instances for which setTraceOn has not been called. If the argument is false then 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
public boolean isTraceOn()

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Returns true if tracing is enabled for this class.

Returns:

true if tracing is enabled for this class, false otherwise.

getComponent

public Component getComponent()

Description copied from interface: ILcyMapLayerControl

Returns the visual representation of the map layer control. Can never return null.

Specified by:

getComponent in interface ILcyMapLayerControl

Returns:

the visual representation of the map layer control.

getActionBar

public ILcyActionBar getActionBar()

Description copied from interface: ILcyMapLayerControl

Returns the action bar containing the layer actions.

Specified by:

getActionBar in interface ILcyMapLayerControl

Returns:

the action bar containing the layer actions.

getOrderActionBar

public ILcyActionBar getOrderActionBar()

getPopupMenu

public ILcyPopupMenu getPopupMenu()

setActionBar

public void setActionBar(ILcyActionBar aActionBar)

Sets the action bar that is associated with this layer control.

Parameters:

aActionBar - The action bar

See Also:

getActionBar()

setOrderActionBar

public void setOrderActionBar(ILcyActionBar aOrderActionBar)

setPopupMenu

public void setPopupMenu(ILcyPopupMenu aPopupMenu)

getMapComponent

public TLcyMapComponent getMapComponent()

Returns the map component this layer control operates on.

Returns:

the map component this layer control operates on.

setMapComponent

public void setMapComponent(TLcyMapComponent aMapComponent)

Sets the map component this layer control operates on.

Parameters:

aMapComponent - The map component this layer control operates on.

getSelectedLayer

@Deprecated
public ILcdGXYLayer getSelectedLayer()

Deprecated. Please use the methods getSelectedLayers and setSelectedLayers. These have the ability to work with multiple selection.

Returns the selected layer. This layer is always contained in the view, unlike the layers returned by getSelectedLayers().

Returns:

the selected layer.

See Also:

setSelectedLayer(com.luciad.view.gxy.ILcdGXYLayer)

setSelectedLayer

@Deprecated
public void setSelectedLayer(ILcdGXYLayer aLayer)

Deprecated. Please use the methods getSelectedLayers and setSelectedLayers. These have the ability to work with multiple selection.

Sets the selected layer. Note that this layer has to be contained in the view.

If you override this method, do not forget to keep the selected layer(s) in sync with those on the map component (see ILcyMapComponent.setSelectedLayers(com.luciad.view.gxy.ILcdGXYLayer[]).

Parameters:

aLayer - The selected layer.

getSelectedLayers

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

When a layerlist, which has been inserted by calling ILcyMapComponent.insertGXYLayer(com.luciad.view.gxy.ILcdGXYLayer) insertGXYLayer}, is selected by calling setSelectedLayers, calling this method afterwards will not return the layerlist but the corresponding ILcdLayerTreeNode

Returns:

The selected layers.

See Also:

ILcyMapComponent.insertGXYLayer(com.luciad.view.gxy.ILcdGXYLayer)

setSelectedLayers

public void setSelectedLayers(ILcdGXYLayer[] aSelectedLayers)

Sets the selected layers to the layers contained in aSelectedLayers. A property change event will be fired when the selection has changed.

All the layers of aSelectedLayers should be contained in the view, or should be ILcdLayerLists which were inserted in the view by calling ILcyMapComponent#insertGXYLayer. Notice that calling this method with such a layerlist and afterwards calling getSelectedLayers() will not return this layerlist, but the corresponding layer node.

If you override this method, do not forget to keep the selected layer(s) in sync with those on the map component (see ILcyMapComponent.setSelectedLayers(com.luciad.view.gxy.ILcdGXYLayer[]).

Parameters:

aSelectedLayers - The layers in this array will be selected.

See Also:

getSelectedLayers()