com.bbn.openmap.layer.test
Class TestLayer

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.bbn.openmap.Layer
                  com.bbn.openmap.layer.OMGraphicHandlerLayer
                      com.bbn.openmap.layer.test.TestLayer

All Implemented Interfaces:

MapMouseListener, ProjectionListener, GestureResponsePolicy, OMGraphicHandler, ProjectionPainter, PropertyConsumer, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.beancontext.BeanContextChild, java.beans.beancontext.BeanContextMembershipListener, java.io.Serializable, java.util.EventListener

public class TestLayer
extends OMGraphicHandlerLayer
implements MapMouseListener

A Layer for testing different types of graphics. The GUI code is very large and ugly. Maybe break this off into several classes.

This layer responds to the following properties:

 
  # initial visibility settings:
  test.line.visible=true
  test.circ.visible=true
  test.rect.visible=true
  test.text.visible=true
  test.poly.visible=true
  # latlon vertices of the poly
  #test.poly.vertices=80 -180 80 -90 80 0 80 90 80 180 70 180 70 90 70 0 70 -90 70 -180
  
 
 

In addition, you can get this layer to work with the OpenMap viewer by editing your openmap.properties file:

 
  # layers
  openmap.layers=test ...
  # class
  test.class=com.bbn.openmap.layer.TestLayer
  # name
  test.prettyName=Graticule
 
 

See Also:

Serialized Form

Nested Class Summary

protected class	TestLayer.Circle
protected class	TestLayer.GraphicBase
protected class	TestLayer.Line
protected class	TestLayer.Poly
protected class	TestLayer.Rect
protected class	TestLayer.Text

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected TestLayer.Circle	circle
static java.lang.String	CircVisibleProperty
protected static java.lang.String[]	colorNames
protected static java.awt.Color[]	colors
protected javax.swing.JPanel	gui
protected TestLayer.Line	line
static java.lang.String	LineVisibleProperty
protected static int	NCOLORS
protected OMCircle	omcircle
protected OMLine	omline
protected OMPoly	ompoly
protected OMRect	omrect
protected OMText	omtext
protected TestLayer.Poly	poly
static java.lang.String	PolyVertsProperty
static java.lang.String	PolyVisibleProperty
protected TestLayer.Rect	rect
static java.lang.String	RectVisibleProperty
protected TestLayer.Text	text
static java.lang.String	TextVisibleProperty

Fields inherited from class com.bbn.openmap.layer.OMGraphicHandlerLayer

consumeEvents, ConsumeEventsProperty, filter, interruptable, InterruptableProperty, layerWorker, LAYERWORKER_LOCK, layerWorkerQueue, logger, mouseEventInterpreter, mouseModeIDs, MouseModesProperty, projectionChangePolicy, ProjectionChangePolicyProperty, renderPolicy, RenderPolicyProperty, selectedList, TransparencyProperty

Fields inherited from class com.bbn.openmap.Layer

addAsBackground, AddAsBackgroundProperty, addToBeanContext, AddToBeanContextProperty, attributes, autoPalette, AutoPaletteProperty, beanContextChildSupport, coordTransform, DataPathPrefixProperty, DisplayPaletteCmd, DisplayPropertiesCmd, doHack, HidePaletteCmd, i18n, localHackList, maxScale, MaxScaleProperty, minScale, MinScaleProperty, palette, paletteListener, PrettyNameProperty, propertyPrefix, readyToPaint, RedrawCmd, removable, RemovableProperty, SWING_PACKAGE, TransformProperty, windowSupport

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.bbn.openmap.PropertyConsumer

EditorProperty, initPropertiesProperty, LabelEditorProperty, ScopedEditorProperty

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

TestLayer()
Construct the TestLayer.

Method Summary

protected OMGraphicList	generateGraphics() Create and project the graphics.
protected javax.swing.JPanel	getGraphicPalette(TestLayer.GraphicBase obj, java.lang.String title) Create the sub-palette for a particular graphic type.
java.awt.Component	getGUI() Gets the palette associated with the layer.
MapMouseListener	getMapMouseListener() Returns self as the MapMouseListener in order to receive MapMouseEvents.
java.lang.String[]	getMouseModeServiceList() Return a list of the modes that are interesting to the MapMouseListener.
boolean	mouseClicked(java.awt.event.MouseEvent e) Invoked when the mouse has been clicked on a component.
boolean	mouseDragged(java.awt.event.MouseEvent e) Invoked when a mouse button is pressed on a component and then dragged.
void	mouseEntered(java.awt.event.MouseEvent e) Invoked when the mouse enters a component.
void	mouseExited(java.awt.event.MouseEvent e) Invoked when the mouse exits a component.
void	mouseMoved() Handle a mouse cursor moving without the button being pressed.
boolean	mouseMoved(java.awt.event.MouseEvent e) Invoked when the mouse button has been moved on a component (with no buttons no down).
boolean	mousePressed(java.awt.event.MouseEvent e) Invoked when a mouse button has been pressed on a component.
boolean	mouseReleased(java.awt.event.MouseEvent e) Invoked when a mouse button has been released on a component.
OMGraphicList	prepare() This is the main method you should be concerned with when overriding this class.
void	setProperties(java.lang.String prefix, java.util.Properties properties) The properties and prefix are managed and decoded here, for the standard uses of the GraticuleLayer.

Methods inherited from class com.bbn.openmap.layer.OMGraphicHandlerLayer

actionPerformed, canSetList, copy, createLayerWorker, cut, deselect, dispose, doAction, doPrepare, filter, filter, filter, getConsumeEvents, getDefaultSettingsPanel, getFilter, getInfoText, getItemsForMapMenu, getItemsForOMGraphicMenu, getLayerWorker, getList, getMouseEventInterpreter, getMouseModeIDsForEvents, getProjectionChangePolicy, getProperties, getPropertyInfo, getRedrawButton, getRenderPolicy, getSelected, getSettingsButton, getToolTipTextFor, getTransparency, getTransparencyAdjustmentPanel, highlight, isCancelled, isHighlightable, isInterruptable, isSelectable, isWorking, leftClick, mouseOver, paint, paste, projectionChanged, receivesMapEvents, renderDataForProjection, resetFiltering, select, setConsumeEvents, setFilter, setInterruptable, setLayerWorker, setList, setMouseEventInterpreter, setMouseModeIDsForEvents, setProjectionChangePolicy, setRenderPolicy, setTransparency, supportsSQL, unhighlight, workerComplete

Methods inherited from class com.bbn.openmap.Layer

addComponentListener, added, addInfoDisplayListener, addLayerStatusListener, addMouseListener, addVetoableChangeListener, childrenAdded, childrenRemoved, clearListeners, connectToBeanContext, createWindowSupport, disconnectFromBeanContext, finalize, findAndInit, findAndInit, findAndUndo, fireHideToolTip, firePaletteEvent, fireRequestBrowserContent, fireRequestBrowserContent, fireRequestCursor, fireRequestInfoLine, fireRequestInfoLine, fireRequestInfoLine, fireRequestMessage, fireRequestMessage, fireRequestToolTip, fireRequestToolTip, fireRequestURL, fireRequestURL, fireStatusUpdate, fireStatusUpdate, fireVetoableChange, getAddAsBackground, getAddToBeanContext, getAttribute, getBeanContext, getCoordTransform, getIcon, getMaxScale, getMinScale, getPackage, getPalette, getProjection, getPropertyPrefix, getWindowSupport, hasGUI, hidePalette, isAutoPalette, isProjectionOK, isReadyToPaint, isRemovable, notifyHideHack, prependDataPathPrefix, putAttribute, removeComponentListener, removeConfirmed, removed, removeInfoDisplayListener, removeLayerStatusListener, removeVetoableChangeListener, repaint, resetPalette, setAddAsBackground, setAddToBeanContext, setAutoPalette, setBeanContext, setCoordTransform, setIcon, setLayerProperties, setMaxScale, setMinScale, setName, setPaletteVisible, setProjection, setProjection, setProperties, setPropertyPrefix, setReadyToPaint, setRemovable, setVisible, setWindowSupport, showPalette

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, 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, unregisterKeyboardAction, update, updateUI

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, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, 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, hide, 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, 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, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.beans.beancontext.BeanContextChild

addPropertyChangeListener, removePropertyChangeListener

Field Detail

LineVisibleProperty

public static final transient java.lang.String LineVisibleProperty

See Also:

Constant Field Values

CircVisibleProperty

public static final transient java.lang.String CircVisibleProperty

See Also:

Constant Field Values

RectVisibleProperty

public static final transient java.lang.String RectVisibleProperty

See Also:

Constant Field Values

TextVisibleProperty

public static final transient java.lang.String TextVisibleProperty

See Also:

Constant Field Values

PolyVisibleProperty

public static final transient java.lang.String PolyVisibleProperty

See Also:

Constant Field Values

PolyVertsProperty

public static final transient java.lang.String PolyVertsProperty

See Also:

Constant Field Values

colorNames

protected static final transient java.lang.String[] colorNames

colors

protected static final transient java.awt.Color[] colors

NCOLORS

protected static final transient int NCOLORS

omcircle

protected OMCircle omcircle

circle

protected TestLayer.Circle circle

omline

protected OMLine omline

line

protected TestLayer.Line line

omrect

protected OMRect omrect

rect

protected TestLayer.Rect rect

omtext

protected OMText omtext

text

protected TestLayer.Text text

ompoly

protected OMPoly ompoly

poly

protected TestLayer.Poly poly

gui

protected javax.swing.JPanel gui

Constructor Detail

TestLayer

public TestLayer()

Construct the TestLayer.

Method Detail

setProperties

public void setProperties(java.lang.String prefix,
                          java.util.Properties properties)

The properties and prefix are managed and decoded here, for the standard uses of the GraticuleLayer.

Specified by:

setProperties in interface PropertyConsumer

Overrides:

setProperties in class OMGraphicHandlerLayer

Parameters:

prefix - string prefix used in the properties file for this layer.

properties - the properties set in the properties file.

prepare

public OMGraphicList prepare()

Description copied from class: OMGraphicHandlerLayer

This is the main method you should be concerned with when overriding this class. You have to make sure that this method returns an OMGraphicList that is ready to be rendered. That means they need to be generated with the current projection, which can be retrieved by calling getProjection().

This method will be called in a separate thread if doPrepare() is called on the layer. This will automatically cause repaint() to be called, which lets java know to call paint() on this class.

Note that the default action of this method is to get the OMGraphicList as it is currently set in the layer, re-projects the list with the current projection (calls generate() on them), and then returns the current list.

If your layer needs to change what is on the list based on what the current projection is, you can either clear() the list yourself and add new OMGraphics to it (remember to call generate(Projection) on them), and return the list. You also have the option of setting a ListResetPCPolicy, which will automatically set the list to null when the projection changes before calling this method. The OMGraphicHandlerList will ignore a null OMGraphicList.

NOTE: If you call prepare directly, you may need to call repaint(), too. With all invocations of this method that are cause by a projection change, repaint() will be called for you. The method is synchronized in case renderDataForProjection() gets called while in the middle of this method. For a different projection, that would be bad.

Overrides:

prepare in class OMGraphicHandlerLayer

generateGraphics

protected OMGraphicList generateGraphics()

Create and project the graphics.

getGUI

public java.awt.Component getGUI()

Gets the palette associated with the layer.

Overrides:

getGUI in class Layer

Returns:

Component or null

getGraphicPalette

protected javax.swing.JPanel getGraphicPalette(TestLayer.GraphicBase obj,
                                               java.lang.String title)

Create the sub-palette for a particular graphic type.

Parameters:

obj - GraphicObj

title - panel title

Returns:

JPanel sub-palette

getMapMouseListener

public MapMouseListener getMapMouseListener()

Returns self as the MapMouseListener in order to receive MapMouseEvents. If the implementation would prefer to delegate MapMouseEvents, it could return the delegate from this method instead.

Overrides:

getMapMouseListener in class OMGraphicHandlerLayer

Returns:

MapMouseListener this

getMouseModeServiceList

public java.lang.String[] getMouseModeServiceList()

Return a list of the modes that are interesting to the MapMouseListener. The source MouseEvents will only get sent to the MapMouseListener if the mode is set to one that the listener is interested in. Layers interested in receiving events should register for receiving events in "select" mode.

 
 return new String[1] { SelectMouseMode.modeID };
 
 

Specified by:

getMouseModeServiceList in interface MapMouseListener

Returns:

String[] of modeID's

See Also:

NavMouseMode.modeID, SelectMouseMode.modeID, NullMouseMode.modeID

mousePressed

public boolean mousePressed(java.awt.event.MouseEvent e)

Invoked when a mouse button has been pressed on a component.

Specified by:

mousePressed in interface MapMouseListener

Parameters:

e - MouseEvent

Returns:

true if the listener was able to process the event.

mouseReleased

public boolean mouseReleased(java.awt.event.MouseEvent e)

Invoked when a mouse button has been released on a component.

Specified by:

mouseReleased in interface MapMouseListener

Parameters:

e - MouseEvent

Returns:

true if the listener was able to process the event.

mouseClicked

public boolean mouseClicked(java.awt.event.MouseEvent e)

Invoked when the mouse has been clicked on a component. The listener will receive this event if it successfully processed mousePressed(), or if no other listener processes the event. If the listener successfully processes mouseClicked(), then it will receive the next mouseClicked() notifications that have a click count greater than one.

Specified by:

mouseClicked in interface MapMouseListener

Parameters:

e - MouseListener MouseEvent to handle.

Returns:

true if the listener was able to process the event.

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Invoked when the mouse enters a component.

Specified by:

mouseEntered in interface MapMouseListener

Parameters:

e - MouseListener MouseEvent to handle.

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Invoked when the mouse exits a component.

Specified by:

mouseExited in interface MapMouseListener

Parameters:

e - MouseListener MouseEvent to handle.

mouseDragged

public boolean mouseDragged(java.awt.event.MouseEvent e)

Invoked when a mouse button is pressed on a component and then dragged. The listener will receive these events if it successfully processes mousePressed(), or if no other listener processes the event.

Specified by:

mouseDragged in interface MapMouseListener

Parameters:

e - MouseMotionListener MouseEvent to handle.

Returns:

true if the listener was able to process the event.

mouseMoved

public boolean mouseMoved(java.awt.event.MouseEvent e)

Invoked when the mouse button has been moved on a component (with no buttons no down).

Specified by:

mouseMoved in interface MapMouseListener

Parameters:

e - MouseListener MouseEvent to handle.

Returns:

true if the listener was able to process the event.

mouseMoved

public void mouseMoved()

Handle a mouse cursor moving without the button being pressed. This event is intended to tell the listener that there was a mouse movement, but that the event was consumed by another layer. This will allow a mouse listener to clean up actions that might have happened because of another motion event response.

Specified by:

mouseMoved in interface MapMouseListener