net.sf.gridarta.gui.map.mapview

Interface MapView<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

All Known Implementing Classes:

AbstractMapView, DefaultMapView

public interface MapView<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

A map view consists of a map grid and a map cursor, and is attached to a map control.

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.
MapCursor<G,A,R>	getMapCursor() Returns the MapCursor of this view.
MapGrid	getMapGrid() Returns the MapGrid of this view.
MapRenderer	getRenderer() Returns the MapRenderer for this view.
javax.swing.JScrollPane	getScrollPane() Returns the JScrollPane of this map view.
G	getSelectedGameObject() Return one selected game object.
java.util.List<G>	getSelectedGameObjects() Return all selected game objects.
java.util.List<MapSquare<G,A,R>>	getSelectedSquares() Returns the selected squares.
java.lang.String	getWindowTitle() Returns the title for the map window.
void	setCursorLocation(java.awt.Point point) Sets the cursor location.

Method Detail

closeNotify

void closeNotify()

This function must be called when the view is closed.

getSelectedGameObject

@Nullable
G getSelectedGameObject()

Return one selected game object. If more than one game object is selected, return a random one. If nothing is selected, return a random game object from the entire map.

Returns:

one random selected game object, or null if no game object is selected

getSelectedGameObjects

@NotNull
java.util.List<G> getSelectedGameObjects()

Return all selected game objects. If nothing is selected, return all game objects from the entire map.

Returns:

the selected game objects

getWindowTitle

@NotNull
java.lang.String getWindowTitle()

Returns the title for the map window.

Returns:

the title

getComponent

@NotNull
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
MapControl<G,A,R> getMapControl()

Return the controller of this view.

Returns:

the controller of this view

activate

void activate()

Activate this map view.

getInternalFrame

@NotNull
javax.swing.JInternalFrame getInternalFrame()

Returns the JInternalFrame instance for this map view.

Returns:

the internal frame

getSelectedSquares

@NotNull
java.util.List<MapSquare<G,A,R>> getSelectedSquares()

Returns the selected squares.

Returns:

the selected squares; the list may be modified by the caller

getMapGrid

@NotNull
MapGrid getMapGrid()

Returns the MapGrid of this view.

Returns:

the map grid of this view

getMapCursor

@NotNull
MapCursor<G,A,R> getMapCursor()

Returns the MapCursor of this view.

Returns:

the map cursor of this view

getRenderer

@NotNull
MapRenderer getRenderer()

Returns the MapRenderer for this view.

Returns:

the map renderer

getScrollPane

@NotNull
javax.swing.JScrollPane getScrollPane()

Returns the JScrollPane of this map view.

Returns:

the scroll pane

setCursorLocation

void setCursorLocation(@NotNull
                       java.awt.Point point)

Sets the cursor location. If the map location is not within map bounds the cursor is set to the nearest valid location.

Parameters:

point - the new location will be modified to the actually set cursor location