Package org.eclipse.nebula.widgets.geomap.internal

Class GeoMapHelper

java.lang.Object

org.eclipse.nebula.widgets.geomap.internal.GeoMapHelper

All Implemented Interfaces:

GeoMapHelperListener, GeoMapPositioned

public class GeoMapHelper
extends java.lang.Object
implements GeoMapPositioned, GeoMapHelperListener

License is EPL (Eclipse Public License) http://www.eclipse.org/legal/epl-v10.html. Contact at stepan.rutz@gmx.de

Version:

$Revision$

Author:

stepan.rutz, hal

Constructor Summary

Constructors

Constructor	Description
GeoMapHelper(org.eclipse.swt.widgets.Display display, org.eclipse.swt.graphics.Point mapPosition, int zoom, int cacheSize)	Initializes a new GeoMapHelper for a specific display, position, zoom level and cache size.

Method Summary

Modifier and Type	Method	Description
void	addGeoMapHelperListener(GeoMapHelperListener listener)	Adds a GeoMapHelperListener that will be notified about tile updates
void	addInternalGeoMapListener(InternalGeoMapListener listener)	Adds an InternalGeoMapListener that will be notified about painting and cache updates
void	dispose()	Dispose internal data
org.eclipse.swt.graphics.Point	getMapPosition()	Gets the position of the upper left corner of the map.
int	getMaxZoom()	Gets the maximum supported zoom level
TileServer	getTileServer()	Gets the tile server used for fetching tiles
int	getZoom()	Gets the current zoom level
void	paint(org.eclipse.swt.graphics.GC gc, org.eclipse.swt.graphics.Rectangle clip, org.eclipse.swt.graphics.Point size)	Points the map to the provided graphics context (GC), which could be the one provided in an SWT control paint request or one created for rendering an SWT Image
void	removeGeoMapHelperListener(GeoMapHelperListener listener)	Removes a GeoMapHelperListener
void	removeInternalGeoMapListener(InternalGeoMapListener listener)	Removes an InternalGeoMapListener
void	setMapPosition(int x, int y)	Sets the position of the upper left corner of the map.
void	setTileServer(TileServer tileServer)	Sets the tile server used for fetching tiles
void	setZoom(int zoom)	Sets the current zoom level
void	tileUpdated(TileRef tileRef)	Notifies listener that a tile has been updated and may need (re)painting

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoMapHelper

public GeoMapHelper(org.eclipse.swt.widgets.Display display,
                    org.eclipse.swt.graphics.Point mapPosition,
                    int zoom,
                    int cacheSize)

Initializes a new GeoMapHelper for a specific display, position, zoom level and cache size.

Parameters:

display - the Display to create images for.

mapPosition - initial mapPosition.

zoom - initial map zoom

cacheSize - initial cache size, eg number of tile-images that are kept in cache to prevent reloading from the network.

Method Detail

paint

public void paint(org.eclipse.swt.graphics.GC gc,
                  org.eclipse.swt.graphics.Rectangle clip,
                  org.eclipse.swt.graphics.Point size)

Points the map to the provided graphics context (GC), which could be the one provided in an SWT control paint request or one created for rendering an SWT Image

Parameters:

gc - the graphics context

clip - the area that needs updating, could be null

size - the size of the map area

dispose

public void dispose()

Dispose internal data

getTileServer

public TileServer getTileServer()

Gets the tile server used for fetching tiles

Returns:

the tile server

setTileServer

public void setTileServer(TileServer tileServer)

Sets the tile server used for fetching tiles

Parameters:

tileServer - the new tile server to use

getMapPosition

public org.eclipse.swt.graphics.Point getMapPosition()

Description copied from interface: GeoMapPositioned

Gets the position of the upper left corner of the map. The resolution depends on the zoom level.

Specified by:

getMapPosition in interface GeoMapPositioned

Returns:

the position of the upper left corner of the map

setMapPosition

public void setMapPosition(int x,
                           int y)

Description copied from interface: GeoMapPositioned

Sets the position of the upper left corner of the map. The resolution depends on the zoom level.

Specified by:

setMapPosition in interface GeoMapPositioned

Parameters:

x - the x coordinate

y - the y coordinate

getMaxZoom

public int getMaxZoom()

Description copied from interface: GeoMapPositioned

Gets the maximum supported zoom level

Specified by:

getMaxZoom in interface GeoMapPositioned

Returns:

the maximum zoom level

getZoom

public int getZoom()

Description copied from interface: GeoMapPositioned

Gets the current zoom level

Specified by:

getZoom in interface GeoMapPositioned

Returns:

the current zoom level

setZoom

public void setZoom(int zoom)

Description copied from interface: GeoMapPositioned

Sets the current zoom level

Specified by:

setZoom in interface GeoMapPositioned

Parameters:

zoom - the new zoom level

tileUpdated

public void tileUpdated(TileRef tileRef)

Description copied from interface: GeoMapHelperListener

Notifies listener that a tile has been updated and may need (re)painting

Specified by:

tileUpdated in interface GeoMapHelperListener

Parameters:

tileRef - the reference to the updated tile

addGeoMapHelperListener

public void addGeoMapHelperListener(GeoMapHelperListener listener)

Adds a GeoMapHelperListener that will be notified about tile updates

Parameters:

listener - the GeoMapHelperListener

removeGeoMapHelperListener

public void removeGeoMapHelperListener(GeoMapHelperListener listener)

Removes a GeoMapHelperListener

Parameters:

listener - the GeoMapHelperListener

addInternalGeoMapListener

public void addInternalGeoMapListener(InternalGeoMapListener listener)

Adds an InternalGeoMapListener that will be notified about painting and cache updates

Parameters:

listener - the InternalGeoMapListener

removeInternalGeoMapListener

public void removeInternalGeoMapListener(InternalGeoMapListener listener)

Removes an InternalGeoMapListener

Parameters:

listener - the InternalGeoMapListener