net.sf.gridarta.gui.map.mapview

Class MapViewsManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

java.lang.Object

net.sf.gridarta.gui.map.mapview.MapViewsManager<G,A,R>

public class MapViewsManager<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object

Stores all existing MapViews.

Constructor Summary

Constructors

Constructor and Description
MapViewsManager(MapViewSettings mapViewSettings, MapViewFactory<G,A,R> mapViewFactory, MapManager<G,A,R> mapManager, MapManager<G,A,R> pickmapManager, PathManager pathManager) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addEditType(int newType) Calculate a new type for all opened maps.
void	addMapViewsListener(MapControl<G,A,R> mapControl, MapViewsListener<G,A,R> listener) Adds a MapViewsListener to be notified of events.
void	closeMapView(MapView<G,A,R> mapView) Invoked when the user wants to close a map view.
void	closeView(MapView<G,A,R> mapView) Closes a view of a MapControl.
MapView<G,A,R>	getMapViewFrame(MapControl<G,A,R> mapControl) Returns the last used view of a MapControl.
java.util.Iterator<MapView<G,A,R>>	getMapViewIterator(MapControl<G,A,R> mapControl) Returns an Iterator returning all MapViews of a MapControl.
int	getMapViews(MapControl<G,A,R> mapControl) Returns the number of views of a MapControl.
MapView<G,A,R>	newMapView(MapControl<G,A,R> mapControl, java.awt.Point viewPosition, java.awt.Point centerSquare) Creates a new map view.
void	newMapWithView(java.util.List<G> objects, A mapArchObject, java.awt.Point viewPosition, MapFile mapFile) Create a new map control and an initial map view.
void	openMapFileWithView(java.io.File file, java.awt.Point viewPosition, java.awt.Point centerSquare) Load a map file and create a map view.
MapView<G,A,R>	openMapFileWithView(MapFile mapFile, java.awt.Point viewPosition, java.awt.Point centerSquare) Load a map file and create a map view.
void	refreshAllMaps() Refreshes all map views.
void	removeMapViewsListener(MapControl<G,A,R> mapControl, MapViewsListener<G,A,R> listener) Removes a MapViewsListener to be notified of events.
void	repaintAllViews(MapControl<G,A,R> mapControl) Repaints all MapViews of a MapControl.
void	setFileControl(FileControl<G,A,R> fileControl) Deprecated.
void	setFocus(MapView<G,A,R> mapView) Sets a MapView as the main view.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapViewsManager

public MapViewsManager(@NotNull
                       MapViewSettings mapViewSettings,
                       @NotNull
                       MapViewFactory<G,A,R> mapViewFactory,
                       @NotNull
                       MapManager<G,A,R> mapManager,
                       @NotNull
                       MapManager<G,A,R> pickmapManager,
                       @NotNull
                       PathManager pathManager)

Creates a new instance.

Parameters:

mapViewSettings - the map view settings instance

mapViewFactory - the map view factory to use

mapManager - the map manager to use

pickmapManager - the pickmap manager to use

pathManager - the path manager for converting file instance

Method Detail

setFileControl

@Deprecated
public void setFileControl(@NotNull
                                       FileControl<G,A,R> fileControl)

Deprecated.

addMapViewsListener

public void addMapViewsListener(@NotNull
                                MapControl<G,A,R> mapControl,
                                @NotNull
                                MapViewsListener<G,A,R> listener)

Adds a MapViewsListener to be notified of events.

Parameters:

mapControl - the map control to attach to

listener - the listener

removeMapViewsListener

public void removeMapViewsListener(@NotNull
                                   MapControl<G,A,R> mapControl,
                                   @NotNull
                                   MapViewsListener<G,A,R> listener)

Removes a MapViewsListener to be notified of events.

Parameters:

mapControl - the map control to attach to

listener - the listener

getMapViewFrame

@Nullable
public MapView<G,A,R> getMapViewFrame(@NotNull
                                                MapControl<G,A,R> mapControl)

Returns the last used view of a MapControl.

Parameters:

mapControl - the map control

Returns:

the last used view

getMapViews

public int getMapViews(@NotNull
                       MapControl<G,A,R> mapControl)

Returns the number of views of a MapControl.

Parameters:

mapControl - the map control

Returns:

the number of views

newMapView

@NotNull
public MapView<G,A,R> newMapView(@NotNull
                                          MapControl<G,A,R> mapControl,
                                          @Nullable
                                          java.awt.Point viewPosition,
                                          @Nullable
                                          java.awt.Point centerSquare)

Creates a new map view.

Parameters:

mapControl - the map control

viewPosition - the view position to show initially; may be null to show the top left corner

centerSquare - the map square that should be in the center of the view; ignored if viewPosition is set

Returns:

the map view

closeView

public void closeView(@NotNull
                      MapView<G,A,R> mapView)

Closes a view of a MapControl.

Parameters:

mapView - the view to be closed

setFocus

public void setFocus(@NotNull
                     MapView<G,A,R> mapView)

Sets a MapView as the main view.

Parameters:

mapView - the map view

getMapViewIterator

public java.util.Iterator<MapView<G,A,R>> getMapViewIterator(@NotNull
                                                             MapControl<G,A,R> mapControl)

Returns an Iterator returning all MapViews of a MapControl. The map views are returns top to bottom.

Parameters:

mapControl - the map control

Returns:

the iterator

repaintAllViews

public void repaintAllViews(@NotNull
                            MapControl<G,A,R> mapControl)

Repaints all MapViews of a MapControl.

Parameters:

mapControl - the map control

newMapWithView

public void newMapWithView(@Nullable
                           java.util.List<G> objects,
                           @NotNull
                           A mapArchObject,
                           @Nullable
                           java.awt.Point viewPosition,
                           @Nullable
                           MapFile mapFile)

Create a new map control and an initial map view.

Parameters:

objects - the game objects to insert; may be null

mapArchObject - the map arch object for the new map

viewPosition - the view position to show initially; may be null to show the top left corner

mapFile - the map file, or null if the map was not yet saved

closeMapView

public void closeMapView(@NotNull
                         MapView<G,A,R> mapView)

Invoked when the user wants to close a map view. If there is only 1 view left the map will be closed.

Parameters:

mapView - the map view to close

openMapFileWithView

@NotNull
public MapView<G,A,R> openMapFileWithView(@NotNull
                                                   MapFile mapFile,
                                                   @Nullable
                                                   java.awt.Point viewPosition,
                                                   @Nullable
                                                   java.awt.Point centerSquare)
                                            throws java.io.IOException

Load a map file and create a map view.

Parameters:

mapFile - the map file to load

viewPosition - the view position to show initially; may be null to show the top left corner

centerSquare - the map square that should be in the center of the view; ignored if viewPosition is set

Returns:

the map view

Throws:

java.io.IOException - if an I/O error occurs

openMapFileWithView

public void openMapFileWithView(@NotNull
                                java.io.File file,
                                @Nullable
                                java.awt.Point viewPosition,
                                @Nullable
                                java.awt.Point centerSquare)
                         throws java.io.IOException

Load a map file and create a map view.

Parameters:

file - the map file to load

viewPosition - the view position to show initially; may be null to show the top left corner

centerSquare - the map square that should be in the center of the view; ignored if viewPosition is set

Throws:

java.io.IOException - if an I/O error occurs

refreshAllMaps

public void refreshAllMaps()

Refreshes all map views. Does nothing if no maps are opened.

addEditType

public void addEditType(int newType)

Calculate a new type for all opened maps.

Parameters:

newType - the new type to add