jwo.landserf.gui
Interface GISFrame

All Known Implementing Classes:
GISFrameAdapter, GUIFrame

public interface GISFrame

Interface for windows that contol GIS raster surfaces and vectors.

Version:
2.0, 1st August, 2003.
Author:
Jo Wood

Field Summary
static int NOT_SELECTED
          Indicates spatial object is not selected for processing.
static int PRIMARY
          Indicates spatial object is the primary one for processing.
static int SECONDARY
          Indicates spatial object is the secondary one for processing.
static int SELECTED
          Indicates spatial object (usually a vector map) is selected for processing.
 
Method Summary
 void addRaster(RasterMap newRast, int selection)
          Adds a new raster to the collection stored in the GIS frame.
 void addVectorMap(VectorMap newVect, int selection)
          Adds a new vector map to the collection stored in the GIS frame..
 void broadcastFootprint(Footprint fp)
          Broadcasts the given footprint to any footprint listeners.
 Frame getFrame()
          Reports the AWT frame in which this should be embedded.
 GraphicsArea getGraphicsArea()
          Returns the graphics area used for display of geographic objects.
 PrintUtilities getPrintUtilities()
          Passes on the printer utilites from the frame.
 RasterMap getRaster1()
          Returns the primary raster surface associated with the window.
 RasterMap getRaster2()
          Returns the secondary raster surface associated with the window.
 VectorMap getVectorMap()
          Returns the vector map associated with the window.
 void redisplay()
          Redisplays the contents of the frame.
 void removeSpatialObject(SpatialObject spObj)
          Removes the given spatial object from those stored by the GISFrame
 void setBroadcastPointQuery(boolean queryMode, FootprintListener fpListener)
          Turns broadcast point query mode on or off.
 void setBusy(boolean busy)
          Indicates that some process has started or stopped.
 void setMaxProgress(int maxProgress)
          Displays the maximum progress value.
 void setMessage(String text)
          Displays the given message in frame.
 void setMinProgress(int minProgress)
          Displays the minimum progress value.
 void setProgress(int progress)
          Sets the current progress (should be between 0 and 100 unless minimum or maximum progress values have been changed.
 void setRaster1(RasterMap raster)
          Makes the given raster surface the primary one to be processed.
 void setRaster2(RasterMap raster)
          Makes the given raster surface the secondary one to be processed.
 void setVectorMap(VectorMap vectorMap)
          Associates the given vector map with the window.
 void updateInputGUI()
          Updates the window's menu/button items according to what is currently stored or displayed.
 

Field Detail

NOT_SELECTED

public static final int NOT_SELECTED
Indicates spatial object is not selected for processing.

See Also:
Constant Field Values

PRIMARY

public static final int PRIMARY
Indicates spatial object is the primary one for processing.

See Also:
Constant Field Values

SECONDARY

public static final int SECONDARY
Indicates spatial object is the secondary one for processing.

See Also:
Constant Field Values

SELECTED

public static final int SELECTED
Indicates spatial object (usually a vector map) is selected for processing.

See Also:
Constant Field Values
Method Detail

updateInputGUI

public void updateInputGUI()
Updates the window's menu/button items according to what is currently stored or displayed.


redisplay

public void redisplay()
Redisplays the contents of the frame.


setBusy

public void setBusy(boolean busy)
Indicates that some process has started or stopped. This may be used by the GUI to indicate processing visually.

Parameters:
busy - Busy if true.

broadcastFootprint

public void broadcastFootprint(Footprint fp)
Broadcasts the given footprint to any footprint listeners.

Parameters:
fp - Footprint to broadcast.

setBroadcastPointQuery

public void setBroadcastPointQuery(boolean queryMode,
                                   FootprintListener fpListener)
Turns broadcast point query mode on or off.

Parameters:
queryMode - Point query mode is on if true, otherwise off.

addRaster

public void addRaster(RasterMap newRast,
                      int selection)
Adds a new raster to the collection stored in the GIS frame.

Parameters:
newRast - new Raster to add.
selection - Selection type (PRIMARY, SECONDARY or NOT_SELECTED).

addVectorMap

public void addVectorMap(VectorMap newVect,
                         int selection)
Adds a new vector map to the collection stored in the GIS frame..

Parameters:
newVect - new vector map to add.
selection - Selection type (PRIMARY or NOT_SELECTED).

removeSpatialObject

public void removeSpatialObject(SpatialObject spObj)
Removes the given spatial object from those stored by the GISFrame

Parameters:
spObj - Spatial object to remove.

getRaster1

public RasterMap getRaster1()
Returns the primary raster surface associated with the window.

Returns:
Primary raster surface associated with this window.

getRaster2

public RasterMap getRaster2()
Returns the secondary raster surface associated with the window.

Returns:
Secondary raster surface associated with this window.

getGraphicsArea

public GraphicsArea getGraphicsArea()
Returns the graphics area used for display of geographic objects.

Returns:
Graphics area.

getVectorMap

public VectorMap getVectorMap()
Returns the vector map associated with the window.

Returns:
Vector map associated with this window.

getFrame

public Frame getFrame()
Reports the AWT frame in which this should be embedded.

Returns:
AWT frame in which this is embedded.

getPrintUtilities

public PrintUtilities getPrintUtilities()
Passes on the printer utilites from the frame. This is used since printer initialisation can be expensive so is better passed by reference rather than recreated.

Returns:
Set of printer utilities for printing, previewing and storing printer settings.

setRaster1

public void setRaster1(RasterMap raster)
Makes the given raster surface the primary one to be processed.

Parameters:
raster - New primary raster to be associated with this window.

setRaster2

public void setRaster2(RasterMap raster)
Makes the given raster surface the secondary one to be processed.

Parameters:
raster - New secondary raster to be associated with this window.

setVectorMap

public void setVectorMap(VectorMap vectorMap)
Associates the given vector map with the window.

Parameters:
vectorMap - New vector map to be associated with this window.

setMessage

public void setMessage(String text)
Displays the given message in frame.

Parameters:
text - Message to display.

setMinProgress

public void setMinProgress(int minProgress)
Displays the minimum progress value.

Parameters:
minProgress - Minimum progress value.

setMaxProgress

public void setMaxProgress(int maxProgress)
Displays the maximum progress value.

Parameters:
maxProgress - Maximum progress value.

setProgress

public void setProgress(int progress)
Sets the current progress (should be between 0 and 100 unless minimum or maximum progress values have been changed.

Parameters:
progress - progress value.


Copyright Jo Wood, 1996-2004, last modified, 19th March, 2004