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.1, 3rd September, 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) 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	getVectorMap1() Returns the primary vector map associated with the window.
VectorMap	getVectorMap2() Returns the secondary vector map associated with the window.
boolean	isExperimental() Reports whether experimental functionality is available to the GUI.
void	redisplay(boolean doRecalc) 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	setVectorMap1(VectorMap vectorMap) Makes the given vector map the primary one to be processed.
void	setVectorMap2(VectorMap vectorMap) Makes the given vector map the secondary one to be processed.
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

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(boolean doRecalc)

Redisplays the contents of the frame.

Parameters:

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

broadcastFootprint

public void broadcastFootprint(Footprint fp)

Broadcasts the given footprint to any footprint listeners.

Parameters:

fp - Footprint to broadcast.

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.

getVectorMap1

public VectorMap getVectorMap1()

Returns the primary vector map associated with the window.

Returns:

Primary vector map associated with this window.

getVectorMap2

public VectorMap getVectorMap2()

Returns the secondary vector map associated with the window.

Returns:

Secondary vector map or null if none selected.

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.

isExperimental

public boolean isExperimental()

Reports 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)

Indicates 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)

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.

setVectorMap1

public void setVectorMap1(VectorMap vectorMap)

Makes the given vector map the primary one to be processed.

Parameters:

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

setVectorMap2

public void setVectorMap2(VectorMap vectorMap)

Makes the given vector map the secondary one to be processed.

Parameters:

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

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.

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.