GeoMapGuiIfc

All Known Implementing Classes:

GeographicalMap
```
public interface GeoMapGuiIfc
```
This interface extends the GeoMapIfc to add a few methods that require knowledge of the underlying GUI map implementation.

Since:

PROVIDER_API_VERSION == 22

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`GeoMapGuiIfc.GlassMapPane` Parent abstract class to allow a glass pane to be told about the MapBean in the overlain Window.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`HOME` Action string for homing to own station.
`static java.lang.String`	`INCH_EAST` Action string for panning east a small fraction of the map.
`static java.lang.String`	`INCH_NORTH` Action string for panning north a small fraction of the map.
`static java.lang.String`	`INCH_SOUTH` Action string for panning south a small fraction of the map.
`static java.lang.String`	`INCH_WEST` Action string for panning west a small fraction of the map.
`static java.lang.String`	`PAN_EAST` Action string for panning east a large fraction of the map.
`static java.lang.String`	`PAN_NORTH` Action string for panning north a large fraction of the map.
`static java.lang.String`	`PAN_SOUTH` Action string for panning south a large fraction of the map.
`static java.lang.String`	`PAN_WEST` Action string for panning west a large fraction of the map.
`static java.lang.String`	`ZOOM_IN` Action string for zooming in from the main keyboard.
`static java.lang.String`	`ZOOM_IN_NP` Action string for zooming in from the numeric keypad.
`static java.lang.String`	`ZOOM_OUT` Action string for zooming out from the main keyboard.
`static java.lang.String`	`ZOOM_OUT_NP` Action string for zooming out from the numeric keypad.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.awt.Image`	`getIconImage()` Get the Image used in the title bar of this map widget.
`java.awt.Point`	`getLocationOnScreen()` Get the screen coordinates of the (0,0) point of this map widget.
`com.bbn.openmap.MapBean`	`getMapBean()` Get the OpenMap MapBean for this map widget.
`com.bbn.openmap.MouseDelegator`	`getMouseDelegator()` Get the OpenMap MouseDelegator for this map widget.
`OSMLayer`	`getOSMLayer()` Get the OSMLayer of this map widget.
`java.awt.Dimension`	`getSize()` Get the dimensions of this map widget.
`TopoLayer`	`getTopoLayer()` Get the TopoLayer of this map widget.
`java.awt.Window`	`getWindow()` Get the java.awt.Window containing this map widget.
`boolean`	`isMapAutoCentered()` Report whether the map should automatically pan to keep the local station centered on the map.
`boolean`	`isNightMode()` Report if the displays are in night mode.
`void`	`registerGlassPaneOverMap(GeoMapGuiIfc.GlassMapPane glassPane)` Put a glass pane over a MapBean.
`void`	`registerMapKeystrokeActions(int modifiers, javax.swing.InputMap inputMap, javax.swing.ActionMap actionMap)` Register the keystrokes that can be used to move this object's map around.
`void`	`setCenter(double lat, double lon)` Set the current center position of the map.
`void`	`setMapAutoCentering(boolean isAutoCentered)` Specify whether the map should automatically pan to keep the local station centered on the map.

- Field Detail
  - ZOOM_IN
```
static final java.lang.String ZOOM_IN
```
    Action string for zooming in from the main keyboard.
    
    See Also:
    
    Constant Field Values
  - ZOOM_OUT
```
static final java.lang.String ZOOM_OUT
```
    Action string for zooming out from the main keyboard.
    
    See Also:
    
    Constant Field Values
  - ZOOM_OUT_NP
```
static final java.lang.String ZOOM_OUT_NP
```
    Action string for zooming out from the numeric keypad.
    
    See Also:
    
    Constant Field Values
  - ZOOM_IN_NP
```
static final java.lang.String ZOOM_IN_NP
```
    Action string for zooming in from the numeric keypad.
    
    See Also:
    
    Constant Field Values
  - HOME
```
static final java.lang.String HOME
```
    Action string for homing to own station.
    
    See Also:
    
    Constant Field Values
  - PAN_SOUTH
```
static final java.lang.String PAN_SOUTH
```
    Action string for panning south a large fraction of the map.
    
    See Also:
    
    Constant Field Values
  - PAN_NORTH
```
static final java.lang.String PAN_NORTH
```
    Action string for panning north a large fraction of the map.
    
    See Also:
    
    Constant Field Values
  - PAN_EAST
```
static final java.lang.String PAN_EAST
```
    Action string for panning east a large fraction of the map.
    
    See Also:
    
    Constant Field Values
  - PAN_WEST
```
static final java.lang.String PAN_WEST
```
    Action string for panning west a large fraction of the map.
    
    See Also:
    
    Constant Field Values
  - INCH_SOUTH
```
static final java.lang.String INCH_SOUTH
```
    Action string for panning south a small fraction of the map.
    
    See Also:
    
    Constant Field Values
  - INCH_NORTH
```
static final java.lang.String INCH_NORTH
```
    Action string for panning north a small fraction of the map.
    
    See Also:
    
    Constant Field Values
  - INCH_EAST
```
static final java.lang.String INCH_EAST
```
    Action string for panning east a small fraction of the map.
    
    See Also:
    
    Constant Field Values
  - INCH_WEST
```
static final java.lang.String INCH_WEST
```
    Action string for panning west a small fraction of the map.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getMapBean
```
com.bbn.openmap.MapBean getMapBean()
```
    Get the OpenMap MapBean for this map widget.
    
    Returns:
    
    MapBean
  - getOSMLayer
```
OSMLayer getOSMLayer()
```
    Get the OSMLayer of this map widget.
    
    Returns:
    
    OSMLayer
  - getIconImage
```
java.awt.Image getIconImage()
```
    Get the Image used in the title bar of this map widget.
    
    Returns:
    
    Image
  - getSize
```
java.awt.Dimension getSize()
```
    Get the dimensions of this map widget.
    
    Returns:
    
    Dimension
  - getLocationOnScreen
```
java.awt.Point getLocationOnScreen()
```
    Get the screen coordinates of the (0,0) point of this map widget.
    
    Returns:
    
    Point
  - getTopoLayer
```
TopoLayer getTopoLayer()
```
    Get the TopoLayer of this map widget.
    
    Returns:
    
    TopoLayer
  - getWindow
```
java.awt.Window getWindow()
```
    Get the java.awt.Window containing this map widget.
    
    Returns:
    
    Window
  - getMouseDelegator
```
com.bbn.openmap.MouseDelegator getMouseDelegator()
```
    Get the OpenMap MouseDelegator for this map widget.
    
    Returns:
    
    MouseDelegator
  - isMapAutoCentered
```
boolean isMapAutoCentered()
```
    Report whether the map should automatically pan to keep the local station centered on the map.
    
    Returns:
    
    boolean true if map should auto-center, false otherwise
  - setMapAutoCentering
```
void setMapAutoCentering(boolean isAutoCentered)
```
    Specify whether the map should automatically pan to keep the local station centered on the map.
    
    Parameters:
    
    isAutoCentered - boolean true if map should auto-center, false otherwise
  - isNightMode
```
boolean isNightMode()
```
    Report if the displays are in night mode.
    
    Returns:
    
    boolean true if in night mode
  - setCenter
```
void setCenter(double lat,
               double lon)
```
    Set the current center position of the map.
    
    Parameters:
    
    lat - latitude in degrees North
    
    lon - longitude in degrees East
  - registerMapKeystrokeActions
```
void registerMapKeystrokeActions(int modifiers,
                                 javax.swing.InputMap inputMap,
                                 javax.swing.ActionMap actionMap)
```
    Register the keystrokes that can be used to move this object's map around. Presumably, this will be called on the map itself, but may also be called on other widgets (such as the LineOfSightPane) that will take over keyboard focus from the map but still affect the map.
    
    Parameters:
    
    modifiers - int KeyEvent modifiers (in case we have a conflict with mouse and key strokes)
    
    inputMap - InputMap of component(s) to add hot-keys to
    
    actionMap - ActionMap of component(s) to add hot-keys to
  - registerGlassPaneOverMap
```
void registerGlassPaneOverMap(GeoMapGuiIfc.GlassMapPane glassPane)
```
    Put a glass pane over a MapBean.
    
    Parameters:
    
    glassPane - GlassMapPane subclass to overlay the map window
    
    Since:
    
    PROVIDER_API_VERSION == 45

Interface GeoMapGuiIfc

Nested Class Summary

Field Summary

Method Summary

Field Detail

ZOOM_IN

ZOOM_OUT

ZOOM_OUT_NP

ZOOM_IN_NP

HOME

PAN_SOUTH

PAN_NORTH

PAN_EAST

PAN_WEST

INCH_SOUTH

INCH_NORTH

INCH_EAST

INCH_WEST

Method Detail

getMapBean

getOSMLayer

getIconImage

getSize

getLocationOnScreen

getTopoLayer

getWindow

getMouseDelegator

isMapAutoCentered

setMapAutoCentering

isNightMode

setCenter

registerMapKeystrokeActions

registerGlassPaneOverMap