net.sf.gridarta.gui.copybuffer

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

java.lang.Object

net.sf.gridarta.gui.copybuffer.CopyBuffer<G,A,R>

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

Common base implementation of CopyBuffer. The CopyBuffer is responsible for cut, copy, paste and related operations like filling. It is backed by an invisible MapModel.

Constructor Summary

Constructors

Constructor and Description
CopyBuffer(MapViewSettings mapViewSettings, GameObjectFactory<G,A,R> gameObjectFactory, MapArchObjectFactory<A> mapArchObjectFactory, MapModelFactory<G,A,R> mapModelFactory, InsertionModeSet<G,A,R> insertionModeSet) Create the copy buffer.

Method Summary

Modifier and Type	Method and Description
void	addMapModelListener(MapModelListener<G,A,R> listener) Adds a MapModelListener to be notified about changes of the cut/copied game objects.
void	clear(MapView<G,A,R> mapView, java.awt.Rectangle selectedRec) Executing the Clear command.
void	copy(MapView<G,A,R> mapView, java.awt.Rectangle selectedRec) Executing the Copy command.
void	cut(MapView<G,A,R> mapView, java.awt.Rectangle selectedRec) Executing the Cut command.
java.util.List<G>	getAllGameObjects() Return all game objects.
boolean	isEmpty() Returns whether this copy buffer contains any game objects.
void	paste(MapView<G,A,R> mapView, java.awt.Point startLocation) Executing the Paste command.
void	pasteTiled(MapView<G,A,R> mapView, java.lang.Iterable<MapSquare<G,A,R>> selectedSquares, java.awt.Point origin) Executing the Paste Tiled command.
void	removeMapModelListener(MapModelListener<G,A,R> listener) Removes a MapModelListener to be notified about changes of the cut/copied game objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyBuffer

public CopyBuffer(@NotNull
                  MapViewSettings mapViewSettings,
                  @NotNull
                  GameObjectFactory<G,A,R> gameObjectFactory,
                  @NotNull
                  MapArchObjectFactory<A> mapArchObjectFactory,
                  @NotNull
                  MapModelFactory<G,A,R> mapModelFactory,
                  @NotNull
                  InsertionModeSet<G,A,R> insertionModeSet)

Create the copy buffer.

Parameters:

mapViewSettings - the map view settings instance

gameObjectFactory - the game object factory to use

mapArchObjectFactory - the map arch object factory to use

mapModelFactory - the map model factory to use

insertionModeSet - the insertion mode set to use

Method Detail

addMapModelListener

public void addMapModelListener(@NotNull
                                MapModelListener<G,A,R> listener)

Adds a MapModelListener to be notified about changes of the cut/copied game objects.

Parameters:

listener - the listener

removeMapModelListener

public void removeMapModelListener(@NotNull
                                   MapModelListener<G,A,R> listener)

Removes a MapModelListener to be notified about changes of the cut/copied game objects.

Parameters:

listener - the listener

clear

public void clear(@NotNull
                  MapView<G,A,R> mapView,
                  @NotNull
                  java.awt.Rectangle selectedRec)

Executing the Clear command.

Parameters:

mapView - the map view to clear

selectedRec - the rectangle to operate on

cut

public void cut(@NotNull
                MapView<G,A,R> mapView,
                @NotNull
                java.awt.Rectangle selectedRec)

Executing the Cut command.

Parameters:

mapView - the map view to cut from

selectedRec - the rectangle to operate on

copy

public void copy(@NotNull
                 MapView<G,A,R> mapView,
                 @NotNull
                 java.awt.Rectangle selectedRec)

Executing the Copy command.

Parameters:

mapView - the map view to copy from

selectedRec - the rectangle to operate on

paste

public void paste(@NotNull
                  MapView<G,A,R> mapView,
                  @NotNull
                  java.awt.Point startLocation)

Executing the Paste command.

Parameters:

mapView - the map view to paste on

startLocation - the location to paste into

pasteTiled

public void pasteTiled(@NotNull
                       MapView<G,A,R> mapView,
                       @NotNull
                       java.lang.Iterable<MapSquare<G,A,R>> selectedSquares,
                       @NotNull
                       java.awt.Point origin)

Executing the Paste Tiled command.

Parameters:

mapView - the map view to paste on

selectedSquares - the square to paste into

origin - the origin where to start pasting

getAllGameObjects

@NotNull
public java.util.List<G> getAllGameObjects()

Return all game objects. Only top-level head parts are returned; tail parts are ignored as are objects in inventories.

Returns:

all game objects

isEmpty

public boolean isEmpty()

Returns whether this copy buffer contains any game objects.

Returns:

whether any game objects exist