net.sf.gridarta.gui.map.mapview

Class DefaultMapView<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.AbstractMapView<G,A,R>

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

All Implemented Interfaces:

MapView<G,A,R>

public class DefaultMapView<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends AbstractMapView<G,A,R>

Default MapView implementation.

Constructor Summary

Constructors

Constructor and Description
DefaultMapView(MapControl<G,A,R> mapControl, int number, PathManager pathManager, MapGrid mapGrid, MapCursor<G,A,R> mapCursor, AbstractMapRenderer<G,A,R> renderer, java.awt.Point viewPosition, int xScrollDistance, int yScrollDistance) Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	activate() Activate this map view.
void	closeNotify() This function must be called when the view is closed.
java.awt.Component	getComponent() Returns the component associated with this MapView that can be used as parent for dialogs.
javax.swing.JInternalFrame	getInternalFrame() Returns the JInternalFrame instance for this map view.
MapControl<G,A,R>	getMapControl() Return the controller of this view.
MapRenderer	getRenderer() Returns the MapRenderer for this view.
javax.swing.JScrollPane	getScrollPane() Returns the JScrollPane of this map view.
java.lang.String	getWindowTitle() Returns the title for the map window.

Methods inherited from class net.sf.gridarta.gui.map.mapview.AbstractMapView

getMapCursor, getMapGrid, getSelectedGameObject, getSelectedGameObjects, getSelectedSquares, setCursorLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMapView

public DefaultMapView(@NotNull
                      MapControl<G,A,R> mapControl,
                      int number,
                      @NotNull
                      PathManager pathManager,
                      @NotNull
                      MapGrid mapGrid,
                      @NotNull
                      MapCursor<G,A,R> mapCursor,
                      @NotNull
                      AbstractMapRenderer<G,A,R> renderer,
                      @Nullable
                      java.awt.Point viewPosition,
                      int xScrollDistance,
                      int yScrollDistance)

Create a new instance.

Parameters:

mapControl - the controller of this view

number - each view of a map will get a number

pathManager - the path manager for converting path names

mapGrid - the map grid for this map view

mapCursor - the map cursor for this map view

renderer - the map renderer for rendering the map model

viewPosition - the initial view position to show; null=show top left corner

xScrollDistance - the x distance when scrolling

yScrollDistance - the y distance when scrolling

Method Detail

closeNotify

public void closeNotify()

This function must be called when the view is closed.

getWindowTitle

@NotNull
public java.lang.String getWindowTitle()

Returns the title for the map window.

Returns:

the title

getComponent

@NotNull
public java.awt.Component getComponent()

Returns the component associated with this MapView that can be used as parent for dialogs.

Returns:

the component as parent for dialogs

getMapControl

@NotNull
public MapControl<G,A,R> getMapControl()

Return the controller of this view.

Returns:

the controller of this view

activate

public void activate()

Activate this map view.

getInternalFrame

@NotNull
public javax.swing.JInternalFrame getInternalFrame()

Returns the JInternalFrame instance for this map view.

Returns:

the internal frame

getRenderer

@NotNull
public MapRenderer getRenderer()

Returns the MapRenderer for this view.

Returns:

the map renderer

getScrollPane

@NotNull
public javax.swing.JScrollPane getScrollPane()

Returns the JScrollPane of this map view.

Returns:

the scroll pane