Package net.sf.gridarta.action

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

java.lang.Object

net.sf.gridarta.action.AddBookmarkAction<G,A,R>

All Implemented Interfaces:

MapViewManagerListener<G,A,R>, EditorAction

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

An EditorAction that creates a new bookmark for the current map.

Constructor Summary

Constructors

Constructor	Description
AddBookmarkAction(@NotNull AbstractMapMenuPreferences bookmarksMapMenuPreferences)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	activeMapViewChanged(@Nullable MapView<G,A,R> mapView)	This event handler is called when the current map view has changed.
void	addBookmark()	Action method for "addBookmark".
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	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

AddBookmarkAction

public AddBookmarkAction(@NotNull
                         @NotNull AbstractMapMenuPreferences bookmarksMapMenuPreferences)

Creates a new instance.

Parameters:

bookmarksMapMenuPreferences - the map menu preferences defining the bookmarks menu entries

Method Detail

addBookmark

@ActionMethod
public void addBookmark()

Action method for "addBookmark". Creates a new bookmark for the currently opened map.

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