jwo.landserf.gui
Interface GISFrame

All Known Implementing Classes:

GISFrameAdapter, GUIFrame

public interface GISFrame

Interface for windows that contol GIS raster surfaces and vector maps.

Version:

2.2, 12th November, 2004.

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.

Method Summary

void	addRaster(RasterMap newRast, int selection) Should add a new raster to the collection stored in this GISFrame.
void	addVectorMap(VectorMap newVect, int selection) Should add a new vector map to the collection stored in this GISFrame.
void	broadcastFootprint(Footprint fp) Should broadcast the given footprint to any footprint listeners.
Frame	getFrame() Should report the AWT frame in which this should be embedded.
GraphicsArea	getGraphicsArea() Should return the graphics area used for display of geographic objects.
PrintUtilities	getPrintUtilities() Should pass on the printer utilites from the frame.
RasterMap	getRaster1() Should return the primary raster surface associated with this GISFrame.
RasterMap	getRaster2() Should return the secondary raster surface associated with this GISFrame.
Vector	getRasterMaps() Should return a collection of all the stored raster maps associated with the GISFrame.
VectorMap	getVectorMap1() Should return the primary vector map associated with this GISFrame.
VectorMap	getVectorMap2() Should return the secondary vector map associated with this GISFrame.
Vector	getVectorMaps() Should return a collection of all the stored vector maps associated with this GISFrame.
boolean	isExperimental() Should report whether experimental functionality is available to the GUI.
void	redisplay(boolean doRecalc) Should redisplay the contents of this GISFrame.
void	removeSpatialObject(SpatialObject spObj) Should remove the given spatial object from those stored by this GISFrame.
void	setBroadcastPointQuery(boolean queryMode, FootprintListener fpListener) Should turn broadcast point query mode on or off.
void	setBusy(boolean busy) Should indicate that some process has started or stopped.
void	setMaxProgress(int maxProgress) Should set the maximum progress value.
void	setMessage(String text) Should display the given message in frame.
void	setMinProgress(int minProgress) Should set the minimum progress value.
void	setProgress(int progress) Should set display the current progress (should be between 0 and 100 unless minimum or maximum progress values have been changed.
void	setRaster1(RasterMap raster) Should make the given raster surface the primary one to be processed.
void	setRaster2(RasterMap raster) Should make the given raster surface the secondary one to be processed.
void	setVectorMap1(VectorMap vectorMap) Should make the given vector map the primary one to be processed.
void	setVectorMap2(VectorMap vectorMap) Should make the given vector map the secondary one to be processed.
void	updateInputGUI() Should update this GISFrame's user interface 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

Method Detail

updateInputGUI

public void updateInputGUI()

Should update this GISFrame's user interface according to what is currently stored or displayed.

redisplay

public void redisplay(boolean doRecalc)

Should redisplay the contents of this GISFrame.

Parameters:

doRecalc - If true, contents of frame are recalculated, if not, simply repainted. This allows computationally expensive image recalculation to be separated from normal window refreshing.

broadcastFootprint

public void broadcastFootprint(Footprint fp)

Should broadcast the given footprint to any footprint listeners.

Parameters:

fp - Footprint to broadcast.

addRaster

public void addRaster(RasterMap newRast,
                      int selection)

Should add a new raster to the collection stored in this GISFrame.

Parameters:

newRast - new Raster to add.

selection - Selection type (PRIMARY, SECONDARY or NOT_SELECTED).

addVectorMap

public void addVectorMap(VectorMap newVect,
                         int selection)

Should add a new vector map to the collection stored in this GISFrame.

Parameters:

newVect - new vector map to add.

selection - Selection type (PRIMARY or NOT_SELECTED).

removeSpatialObject

public void removeSpatialObject(SpatialObject spObj)

Should remove the given spatial object from those stored by this GISFrame.

Parameters:

spObj - Spatial object to remove.

getRaster1

public RasterMap getRaster1()

Should return the primary raster surface associated with this GISFrame.

Returns:

Primary raster surface associated with this GISFrame.

getRaster2

public RasterMap getRaster2()

Should return the secondary raster surface associated with this GISFrame.

Returns:

Secondary raster surface associated with this GISFrame.

getRasterMaps

public Vector getRasterMaps()

Should return a collection of all the stored raster maps associated with the GISFrame.

Returns:

Collection of raster maps associated with this GISFrame.

getGraphicsArea

public GraphicsArea getGraphicsArea()

Should return the graphics area used for display of geographic objects.

Returns:

Graphics area.

getVectorMap1

public VectorMap getVectorMap1()

Should return the primary vector map associated with this GISFrame.

Returns:

Primary vector map associated with this GISFrame.

getVectorMap2

public VectorMap getVectorMap2()

Should return the secondary vector map associated with this GISFrame.

Returns:

Secondary vector map or null if none selected.

getVectorMaps

public Vector getVectorMaps()

Should return a collection of all the stored vector maps associated with this GISFrame.

Returns:

Collection of vector maps associated with this GISFrame.

getFrame

public Frame getFrame()

Should report the AWT frame in which this should be embedded.

Returns:

AWT frame in which this is embedded.

getPrintUtilities

public PrintUtilities getPrintUtilities()

Should pass 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.

isExperimental

public boolean isExperimental()

Should report whether experimental functionality is available to the GUI. This can be useful when testing new functionality that may not be available to the general user.

Returns:

True if experimental functionality is to be made available.

setBusy

public void setBusy(boolean busy)

Should indicate that some process has started or stopped. This may be used by the GUI to indicate processing visually.

Parameters:

busy - Busy if true.

setRaster1

public void setRaster1(RasterMap raster)

Should make the given raster surface the primary one to be processed.

Parameters:

raster - New primary raster to be associated with this GISFrame.

setRaster2

public void setRaster2(RasterMap raster)

Should make the given raster surface the secondary one to be processed.

Parameters:

raster - New secondary raster to be associated with this GISFrame.

setVectorMap1

public void setVectorMap1(VectorMap vectorMap)

Should make the given vector map the primary one to be processed.

Parameters:

vectorMap - New primary vector map to be associated with this GISFrame.

setVectorMap2

public void setVectorMap2(VectorMap vectorMap)

Should make the given vector map the secondary one to be processed.

Parameters:

vectorMap - New secondary vector map to be associated with this GISFrame.

setBroadcastPointQuery

public void setBroadcastPointQuery(boolean queryMode,
                                   FootprintListener fpListener)

Should turn broadcast point query mode on or off.

Parameters:

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

setMessage

public void setMessage(String text)

Should display the given message in frame.

Parameters:

text - Message to display.

setMinProgress

public void setMinProgress(int minProgress)

Should set the minimum progress value.

Parameters:

minProgress - Minimum progress value.

setMaxProgress

public void setMaxProgress(int maxProgress)

Should set the maximum progress value.

Parameters:

maxProgress - Maximum progress value.

setProgress

public void setProgress(int progress)

Should set display the current progress (should be between 0 and 100 unless minimum or maximum progress values have been changed.

Parameters:

progress - progress value.