jwo.landserf.gui
Class GISFrameAdapter

java.lang.Object
  jwo.landserf.gui.GISFrameAdapter

All Implemented Interfaces:

GISFrame

Direct Known Subclasses:

SimpleGISFrame

public class GISFrameAdapter

extends Object

implements GISFrame

An abstract adapter class for creating GISFrames. The methods in this class are empty. This class exists as convenience for GISFrames. Extend this class to create a GISFrame and override the methods for the bahaviour of interest.

Version:

2.2, 12th November, 2004.

Author:

Jo Wood.

Field Summary

Fields inherited from interface jwo.landserf.gui.GISFrame

NOT_SELECTED, PRIMARY, SECONDARY

Constructor Summary

GISFrameAdapter(Frame parent)
Creats a new GISFrame with the given parent.

Method Summary

void	addRaster(RasterMap newRast, int selection) Would add a new raster to the collection stored in this GISFame, but ignored in this case.
void	addVectorMap(VectorMap newVect, int selection) Would add a new vector map to the collection stored in this GISFrame, but ignored in this case.
void	broadcastFootprint(Footprint fp) Would broadcaststhe given footprint to any footprint listeners, but does nothing in this case.
Frame	getFrame() Reports the AWT frame in which this should be embedded.
GraphicsArea	getGraphicsArea() Would return the graphics area used for display of geographic objects, but ignored in this case.
PrintUtilities	getPrintUtilities() Would passes on the printer utilites from the frame, but ignored in this case.
RasterMap	getRaster1() Would return the primary raster surface associated with this GISFrame, but does nothing in this case.
RasterMap	getRaster2() Would return the secondary raster surface associated with this GISFrame, but ignored in this case.
Vector	getRasterMaps() Would return a collection of all the stored raster maps associated with this GISFrame, but ignored in this case.
VectorMap	getVectorMap1() Would return the primary vector map associated with this GISFrame, but ignored in this case.
VectorMap	getVectorMap2() Would return the secondary vector map associated with this GISFrame, but ignored in this case.
Vector	getVectorMaps() Would return a collection of all the stored vector maps associated with this GISFrame, but ignored in this case.
boolean	isExperimental() Reports whether experimental functionality is available to the GUI.
void	redisplay(boolean doRecalc) Would redisplay the contents of this frame, but ignored in this case.
void	removeSpatialObject(SpatialObject spObj) Would remove the given spatial object from those stored by this GISFrame but does nothing in this case.
void	setBroadcastPointQuery(boolean queryMode, FootprintListener fpListener) Would turn broadcast point query mode on or off, but ignored in this case.
void	setBusy(boolean busy) Would indicate that some process has started or stopped, but ignored in this case.
void	setMaxProgress(int maxProgress) Would display the maximum progress value, but does nothing in this case.
void	setMessage(String text) Displays the given message,in this case to standard output.
void	setMinProgress(int minProgress) Would display the minimum progress value, but does nothing in this case.
void	setProgress(int progress) Would set the current progress (should be between 0 and 100 unless minimum or maximum progress values have been changed.
void	setRaster1(RasterMap raster) Would make the given raster surface the primary one to be processed, but ignored in this case.
void	setRaster2(RasterMap raster) Would make the given raster surface the secondary one to be processed, but ignored in this case.
void	setVectorMap1(VectorMap vectorMap) Would makes the given vector map the primary one associated with this GISFrame, but ignored in this case.
void	setVectorMap2(VectorMap vectorMap) Would make the given vector map the primary one associated with this GISFrame but ignored in this case.
void	updateInputGUI() Would updates this frame's menu/button items according to what is currently stored or displayed, but ignored in this case.

Methods inherited from class java.lang.Object

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

Constructor Detail

GISFrameAdapter

public GISFrameAdapter(Frame parent)

Creats a new GISFrame with the given parent.

Parameters:

parent - Parent frame.

Method Detail

updateInputGUI

public void updateInputGUI()

Would updates this frame's menu/button items according to what is currently stored or displayed, but ignored in this case.

Specified by:

updateInputGUI in interface GISFrame

redisplay

public void redisplay(boolean doRecalc)

Would redisplay the contents of this frame, but ignored in this case.

Specified by:

redisplay in interface GISFrame

Parameters:

doRecalc - If true, contents of frame can be recalculated, but ignored in this case.

addRaster

public void addRaster(RasterMap newRast,
                      int selection)

Would add a new raster to the collection stored in this GISFame, but ignored in this case.

Specified by:

addRaster in interface GISFrame

Parameters:

newRast - new Raster to add.

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

addVectorMap

public void addVectorMap(VectorMap newVect,
                         int selection)

Would add a new vector map to the collection stored in this GISFrame, but ignored in this case.

Specified by:

addVectorMap in interface GISFrame

Parameters:

newVect - new vector map to add.

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

removeSpatialObject

public void removeSpatialObject(SpatialObject spObj)

Would remove the given spatial object from those stored by this GISFrame but does nothing in this case.

Specified by:

removeSpatialObject in interface GISFrame

Parameters:

spObj - Spatial object to remove (ignored).

getRaster1

public RasterMap getRaster1()

Would return the primary raster surface associated with this GISFrame, but does nothing in this case.

Specified by:

getRaster1 in interface GISFrame

Returns:

Primary raster surface associated with this GISFrame. Always returns null in this adapter.

getRaster2

public RasterMap getRaster2()

Would return the secondary raster surface associated with this GISFrame, but ignored in this case.

Specified by:

getRaster2 in interface GISFrame

Returns:

Secondary raster surface associated with this GISFrame. Always returns null in this adapter.

getRasterMaps

public Vector getRasterMaps()

Would return a collection of all the stored raster maps associated with this GISFrame, but ignored in this case.

Specified by:

getRasterMaps in interface GISFrame

Returns:

Collection of raster maps associated with this GISFrame. Always returns null in this adapter.

getGraphicsArea

public GraphicsArea getGraphicsArea()

Would return the graphics area used for display of geographic objects, but ignored in this case.

Specified by:

getGraphicsArea in interface GISFrame

Returns:

Graphics area. Always returns null in this adapter.

getVectorMap1

public VectorMap getVectorMap1()

Would return the primary vector map associated with this GISFrame, but ignored in this case.

Specified by:

getVectorMap1 in interface GISFrame

Returns:

Primary vector map associated with this GISFrame. Always returns null in this adapter.

getVectorMap2

public VectorMap getVectorMap2()

Would return the secondary vector map associated with this GISFrame, but ignored in this case.

Specified by:

getVectorMap2 in interface GISFrame

Returns:

Secondary vector map associated with this GISFrame. Always returns null in this adapter.

getVectorMaps

public Vector getVectorMaps()

Would return a collection of all the stored vector maps associated with this GISFrame, but ignored in this case.

Specified by:

getVectorMaps in interface GISFrame

Returns:

Collection of vector maps associated with this GISFrame. Always returns null in this adapter.

getFrame

public Frame getFrame()

Reports the AWT frame in which this should be embedded.

Specified by:

getFrame in interface GISFrame

Returns:

AWT frame in which this is embedded.

getPrintUtilities

public PrintUtilities getPrintUtilities()

Would passes on the printer utilites from the frame, but ignored in this case. When implmented fully, if the utilities have not been initialised, they should be at this point. This is used since printer initialisation can be expensive so is better passed by reference rather than recreated.

Specified by:

getPrintUtilities in interface GISFrame

Returns:

Set of printer utilities for printing, previewing and storing printer settings. Always returns null in this adapter.

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. By default this returns false.

Specified by:

isExperimental in interface GISFrame

Returns:

True if experimental functionality is to be made available.

setRaster1

public void setRaster1(RasterMap raster)

Would make the given raster surface the primary one to be processed, but ignored in this case.

Specified by:

setRaster1 in interface GISFrame

Parameters:

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

setRaster2

public void setRaster2(RasterMap raster)

Would make the given raster surface the secondary one to be processed, but ignored in this case.

Specified by:

setRaster2 in interface GISFrame

Parameters:

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

setVectorMap1

public void setVectorMap1(VectorMap vectorMap)

Would makes the given vector map the primary one associated with this GISFrame, but ignored in this case.

Specified by:

setVectorMap1 in interface GISFrame

Parameters:

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

setVectorMap2

public void setVectorMap2(VectorMap vectorMap)

Would make the given vector map the primary one associated with this GISFrame but ignored in this case.

Specified by:

setVectorMap2 in interface GISFrame

Parameters:

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

setMessage

public void setMessage(String text)

Displays the given message,in this case to standard output.

Specified by:

setMessage in interface GISFrame

Parameters:

text - Message to display.

setMinProgress

public void setMinProgress(int minProgress)

Would display the minimum progress value, but does nothing in this case.

Specified by:

setMinProgress in interface GISFrame

Parameters:

minProgress - Minimum progress value.

setMaxProgress

public void setMaxProgress(int maxProgress)

Would display the maximum progress value, but does nothing in this case.

Specified by:

setMaxProgress in interface GISFrame

Parameters:

maxProgress - Maximum progress value.

setProgress

public void setProgress(int progress)

Would set the current progress (should be between 0 and 100 unless minimum or maximum progress values have been changed. Does nothing in this case.

Specified by:

setProgress in interface GISFrame

Parameters:

progress - progress value.

broadcastFootprint

public void broadcastFootprint(Footprint fp)

Would broadcaststhe given footprint to any footprint listeners, but does nothing in this case.

Specified by:

broadcastFootprint in interface GISFrame

Parameters:

fp - Footprint to broadcast.

setBusy

public void setBusy(boolean busy)

Would indicate that some process has started or stopped, but ignored in this case. This may be used by the GUI to indicate processing visually.

Specified by:

setBusy in interface GISFrame

Parameters:

busy - Busy if true.

setBroadcastPointQuery

public void setBroadcastPointQuery(boolean queryMode,
                                   FootprintListener fpListener)

Would turn broadcast point query mode on or off, but ignored in this case.

Specified by:

setBroadcastPointQuery in interface GISFrame

Parameters:

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