net.sf.gridarta.gui.mapcursor

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

java.lang.Object

net.sf.gridarta.gui.mapcursor.MapCursorActions<G,A,R>

All Implemented Interfaces:

java.util.EventListener, MapViewManagerListener<G,A,R>, MapCursorListener<G,A,R>, EditorAction

public class MapCursorActions<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object
implements EditorAction, MapCursorListener<G,A,R>, MapViewManagerListener<G,A,R>

Cursor related actions.

Constructor Summary

Constructors

Constructor and Description
MapCursorActions(@NotNull MapActions<G,A,R> mapActions) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	activeMapViewChanged(@Nullable MapView<G,A,R> mapView) This event handler is called when the current map view has changed.
void	mapCursorChangedGameObject(@Nullable MapSquare<G,A,R> mapSquare, G gameObject) Called whenever the selected game object has changed.
void	mapCursorChangedMode() This event handler is called when MapCursor changes mode (drag, select).
void	mapCursorChangedPos(@NotNull java.awt.Point location) This event handler is called when MapCursor has moved.
void	mapCursorChangedSize() Called whenever the map cursor's map grid size has changed.
void	mapViewClosing(@NotNull MapView<G,A,R> mapView) This event handler is called when a map view is to be closed.
void	mapViewCreated(@NotNull MapView<G,A,R> mapView) This event handler is called when a map view was created.
void	moveCursorEast() Action method for "move cursor east".
void	moveCursorNorth() Action method for "move cursor north".
void	moveCursorNorthEast() Action method for "move cursor north east".
void	moveCursorNorthWest() Action method for "move cursor north west".
void	moveCursorSouth() Action method for "move cursor south".
void	moveCursorSouthEast() Action method for "move cursor south east".
void	moveCursorSouthWest() Action method for "move cursor south west".
void	moveCursorWest() Action method for "move cursor west".
void	setAction(@NotNull javax.swing.Action action, @NotNull java.lang.String name) Sets the Action instance for this editor action.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapCursorActions

public MapCursorActions(@NotNull
                        @NotNull MapActions<G,A,R> mapActions)

Creates a new instance.

Method Detail

moveCursorNorth

@ActionMethod
public void moveCursorNorth()

Action method for "move cursor north".

moveCursorSouth

@ActionMethod
public void moveCursorSouth()

Action method for "move cursor south".

moveCursorEast

@ActionMethod
public void moveCursorEast()

Action method for "move cursor east".

moveCursorWest

@ActionMethod
public void moveCursorWest()

Action method for "move cursor west".

moveCursorNorthEast

@ActionMethod
public void moveCursorNorthEast()

Action method for "move cursor north east".

moveCursorNorthWest

@ActionMethod
public void moveCursorNorthWest()

Action method for "move cursor north west".

moveCursorSouthEast

@ActionMethod
public void moveCursorSouthEast()

Action method for "move cursor south east".

moveCursorSouthWest

@ActionMethod
public void moveCursorSouthWest()

Action method for "move cursor south west".

setAction

public void setAction(@NotNull
                      @NotNull javax.swing.Action action,
                      @NotNull
                      @NotNull java.lang.String name)

Description copied from interface: EditorAction

Sets the Action instance for this editor action.

Specified by:

setAction in interface EditorAction

Parameters:

action - the action instance

name - the name of the action

activeMapViewChanged

public void activeMapViewChanged(@Nullable
                                 @Nullable MapView<G,A,R> mapView)

Description copied from interface: MapViewManagerListener

This event handler is called when the current map view has changed.

Specified by:

activeMapViewChanged in interface MapViewManagerListener<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapView - the new map view or null if no opened map view exists

mapViewCreated

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

Description copied from interface: MapViewManagerListener

This event handler is called when a map view was created.

Specified by:

mapViewCreated in interface MapViewManagerListener<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapView - the created map view

mapViewClosing

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

Description copied from interface: MapViewManagerListener

This event handler is called when a map view is to be closed.

Specified by:

mapViewClosing in interface MapViewManagerListener<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapView - the map view that is to be closed

mapCursorChangedPos

public void mapCursorChangedPos(@NotNull
                                @NotNull java.awt.Point location)

Description copied from interface: MapCursorListener

This event handler is called when MapCursor has moved.

Specified by:

mapCursorChangedPos in interface MapCursorListener<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

location - the new location

mapCursorChangedMode

public void mapCursorChangedMode()

Description copied from interface: MapCursorListener

This event handler is called when MapCursor changes mode (drag, select).

Specified by:

mapCursorChangedMode in interface MapCursorListener<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

mapCursorChangedGameObject

public void mapCursorChangedGameObject(@Nullable
                                       @Nullable MapSquare<G,A,R> mapSquare,
                                       @Nullable
                                       G gameObject)

Description copied from interface: MapCursorListener

Called whenever the selected game object has changed. This function is not called if MapCursorListener.mapCursorChangedPos(Point) occurs concurrently.

Specified by:

mapCursorChangedGameObject in interface MapCursorListener<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapSquare - the newly selected map square or null if no map square is selected

gameObject - the newly selected game object or null if no game object is selected

mapCursorChangedSize

public void mapCursorChangedSize()

Description copied from interface: MapCursorListener

Called whenever the map cursor's map grid size has changed.

Specified by:

mapCursorChangedSize in interface MapCursorListener<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>