net.sf.gridarta.gui.map.mapactions

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

java.lang.Object

net.sf.gridarta.gui.map.mapactions.MapActions<G,A,R>

All Implemented Interfaces:

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

public class MapActions<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>

Manages actions in the "map" menu.

Constructor Summary

Constructors

Constructor and Description

MapActions(@NotNull java.awt.Frame helpParent, @NotNull MapManager<G,A,R> mapManager, @NotNull MapViewManager<G,A,R> mapViewManager, @NotNull ExitMatcher<G,A,R> exitMatcher, @NotNull javax.swing.filechooser.FileFilter mapFileFilter, @NotNull SelectedSquareModel<G,A,R> selectedSquareModel, boolean allowRandomMapParameters, @NotNull MapPropertiesDialogFactory<G,A,R> mapPropertiesDialogFactory, @NotNull MapViewSettings mapViewSettings, @NotNull MapViewsManager<G,A,R> mapViewsManager, @NotNull EnterMap<G,A,R> enterMap, @NotNull ProjectSettings projectSettings) 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	createTileDown() Action method for creating down tiled map.
void	createTileEast() Action method for creating east tiled map.
void	createTileNorth() Action method for creating north tiled map.
void	createTileNorthEast() Action method for creating northeast tiled map.
void	createTileNorthWest() Action method for creating northwest tiled map.
void	createTileSouth() Action method for creating south tiled map.
void	createTileSouthEast() Action method for creating southeast tiled map.
void	createTileSouthWest() Action method for creating southwest tiled map.
void	createTileUp() Action method for creating up tiled map.
void	createTileWest() Action method for creating west tiled map.
void	deleteUnknownObjects() Deletes all game objects referencing unknown archetypes.
boolean	doEnterMap(boolean performAction, @NotNull Direction direction) Executes the "enter map" action.
void	enterDownMap() Action method for entering the down map.
void	enterEastMap() Action method for entering the east map.
void	enterExit() Tries to load the map where the selected map-exit points to.
void	enterMap(@NotNull MapFile mapFile, @Nullable java.awt.Point destinationPoint) Enters a map.
void	enterNorthEastMap() Action method for entering the north east map.
void	enterNorthMap() Action method for entering the north map.
void	enterNorthWestMap() Action method for entering the north west map.
void	enterSouthEastMap() Action method for entering the south east map.
void	enterSouthMap() Action method for entering the south map.
void	enterSouthWestMap() Action method for entering the south west map.
void	enterUpMap() Action method for entering the up map.
void	enterWestMap() Action method for entering the west map.
boolean	isAutoJoin() Action method for "autojoin".
boolean	isDoubleFaces() Action method for "double faces".
boolean	isGridVisible() Action method for "grid visible".
boolean	isSmoothing() Action method for "smoothing".
boolean	isTileShow() Action method for "tile show".
boolean	isTileStretching() Action method for "tile-stretching".
void	mapCreateView() Action method for "create view".
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	mapProperties() Action method for "map properties".
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	nextExit() Selects the next exit.
void	prevExit() Selects the previous exit.
void	setAction(@NotNull javax.swing.Action action, @NotNull java.lang.String name) Sets the Action instance for this editor action.
void	setAutoJoin(boolean autoJoin) Action method for "autoJoin".
void	setDoubleFaces(boolean doubleFaces) Sets whether double faces on the current map should be shown.
void	setGridVisible(boolean gridVisible) Sets whether the grid of the current map should be visible.
void	setSmoothing(boolean smoothing) Sets whether smoothing of the current map is active.
void	setTileShow(boolean tileShow) Action method for "tile show".
void	setTileStretching(boolean tileStretching) Sets whether tile-stretching of the current map is active.
void	shrinkMapSize() Action method for "shrink map size".

Methods inherited from class java.lang.Object

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

Constructor Detail

MapActions

public MapActions(@NotNull
                  @NotNull java.awt.Frame helpParent,
                  @NotNull
                  @NotNull MapManager<G,A,R> mapManager,
                  @NotNull
                  @NotNull MapViewManager<G,A,R> mapViewManager,
                  @NotNull
                  @NotNull ExitMatcher<G,A,R> exitMatcher,
                  @NotNull
                  @NotNull javax.swing.filechooser.FileFilter mapFileFilter,
                  @NotNull
                  @NotNull SelectedSquareModel<G,A,R> selectedSquareModel,
                  boolean allowRandomMapParameters,
                  @NotNull
                  @NotNull MapPropertiesDialogFactory<G,A,R> mapPropertiesDialogFactory,
                  @NotNull
                  @NotNull MapViewSettings mapViewSettings,
                  @NotNull
                  @NotNull MapViewsManager<G,A,R> mapViewsManager,
                  @NotNull
                  @NotNull EnterMap<G,A,R> enterMap,
                  @NotNull
                  @NotNull ProjectSettings projectSettings)

Creates a new instance.

Parameters:

helpParent - the parent frame for help windows

mapManager - the map manager

mapViewManager - the map view manager

exitMatcher - the exit matcher for selecting exit game objects

mapFileFilter - the Swing file filter to use

selectedSquareModel - the selected square model to use

allowRandomMapParameters - whether exit paths may point to random maps

mapPropertiesDialogFactory - the map properties dialog factory to use

mapViewSettings - the map view settings instance to use

mapViewsManager - the map views

enterMap - the enter map instance to use

Method Detail

isGridVisible

@ActionMethod
public boolean isGridVisible()

Action method for "grid visible".

Returns:

true if the grid is visible, or false if the grid is invisible

setGridVisible

@ActionMethod
public void setGridVisible(boolean gridVisible)

Sets whether the grid of the current map should be visible.

Parameters:

gridVisible - new visibility of grid in current map, true if the grid should be visible, false if invisible

See Also:

isGridVisible()

isSmoothing

@ActionMethod
public boolean isSmoothing()

Action method for "smoothing".

Returns:

true if smoothing is active, or false if smoothing is disabled

setSmoothing

@ActionMethod
public void setSmoothing(boolean smoothing)

Sets whether smoothing of the current map is active.

Parameters:

smoothing - new smoothing in current map, true if the smoothing should be active, false if deactivated

See Also:

()

isDoubleFaces

@ActionMethod
public boolean isDoubleFaces()

Action method for "double faces".

Returns:

true if double faces are shown, or false if not

setDoubleFaces

@ActionMethod
public void setDoubleFaces(boolean doubleFaces)

Sets whether double faces on the current map should be shown.

Parameters:

doubleFaces - new value

See Also:

isDoubleFaces()

isTileShow

@ActionMethod
public boolean isTileShow()

Action method for "tile show".

Returns:

true if adjacent tiles are shown, or false if not

No Inspection:

MethodMayBeStatic, SameReturnValue

isTileStretching

@ActionMethod
public boolean isTileStretching()

Action method for "tile-stretching".

Returns:

true if tile-stretching is active, or false if tile-stretching is disabled

setTileStretching

@ActionMethod
public void setTileStretching(boolean tileStretching)

Sets whether tile-stretching of the current map is active.

Parameters:

tileStretching - new tile-stretching in current map, true if the tile-stretching should be active, false if deactivated

See Also:

()

setTileShow

@ActionMethod
public void setTileShow(boolean tileShow)

Action method for "tile show".

Parameters:

tileShow - if set, show adjacent tiles

mapCreateView

@ActionMethod
public void mapCreateView()

Action method for "create view".

mapProperties

@ActionMethod
public void mapProperties()

Action method for "map properties".

shrinkMapSize

@ActionMethod
public void shrinkMapSize()

Action method for "shrink map size".

isAutoJoin

@ActionMethod
public boolean isAutoJoin()

Action method for "autojoin".

Returns:

true if autojoining is enabled, or false if autojoining is disabled

setAutoJoin

@ActionMethod
public void setAutoJoin(boolean autoJoin)

Action method for "autoJoin".

Parameters:

autoJoin - if set, enable autojoining

enterExit

@ActionMethod
public void enterExit()

Tries to load the map where the selected map-exit points to.

nextExit

@ActionMethod
public void nextExit()

Selects the next exit.

prevExit

@ActionMethod
public void prevExit()

Selects the previous exit.

enterNorthMap

@ActionMethod
public void enterNorthMap()

Action method for entering the north map.

enterNorthEastMap

@ActionMethod
public void enterNorthEastMap()

Action method for entering the north east map.

enterEastMap

@ActionMethod
public void enterEastMap()

Action method for entering the east map.

enterSouthEastMap

@ActionMethod
public void enterSouthEastMap()

Action method for entering the south east map.

enterSouthMap

@ActionMethod
public void enterSouthMap()

Action method for entering the south map.

enterSouthWestMap

@ActionMethod
public void enterSouthWestMap()

Action method for entering the south west map.

enterWestMap

@ActionMethod
public void enterWestMap()

Action method for entering the west map.

enterNorthWestMap

@ActionMethod
public void enterNorthWestMap()

Action method for entering the north west map.

enterUpMap

@ActionMethod
public void enterUpMap()

Action method for entering the up map.

enterDownMap

@ActionMethod
public void enterDownMap()

Action method for entering the down map.

createTileNorth

@ActionMethod
public void createTileNorth()

Action method for creating north tiled map.

createTileEast

@ActionMethod
public void createTileEast()

Action method for creating east tiled map.

createTileSouth

@ActionMethod
public void createTileSouth()

Action method for creating south tiled map.

createTileWest

@ActionMethod
public void createTileWest()

Action method for creating west tiled map.

createTileNorthEast

@ActionMethod
public void createTileNorthEast()

Action method for creating northeast tiled map.

createTileSouthEast

@ActionMethod
public void createTileSouthEast()

Action method for creating southeast tiled map.

createTileSouthWest

@ActionMethod
public void createTileSouthWest()

Action method for creating southwest tiled map.

createTileNorthWest

@ActionMethod
public void createTileNorthWest()

Action method for creating northwest tiled map.

createTileUp

@ActionMethod
public void createTileUp()

Action method for creating up tiled map.

createTileDown

@ActionMethod
public void createTileDown()

Action method for creating down tiled map.

deleteUnknownObjects

@ActionMethod
public void deleteUnknownObjects()

Deletes all game objects referencing unknown archetypes.

enterMap

public void enterMap(@NotNull
                     @NotNull MapFile mapFile,
                     @Nullable
                     @Nullable java.awt.Point destinationPoint)

Enters a map.

Parameters:

mapFile - the map file to enter

destinationPoint - the desired destination point on the map or null for default

doEnterMap

public boolean doEnterMap(boolean performAction,
                          @NotNull
                          @NotNull Direction direction)

Executes the "enter map" action.

Parameters:

performAction - whether the action should be performed

direction - the direction to enter

Returns:

whether the action was or can be performed

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>>