net.sf.gridarta.gui.panel.pickmapchooser

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

java.lang.Object

net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserControl<G,A,R>

All Implemented Interfaces:

ObjectChooserTab<G,A,R>, EditorAction

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

Manages the pickmap panel and most pickmap-related code in general.

Constructor Summary

Constructors

Constructor and Description
PickmapChooserControl(PickmapChooserModel<G,A,R> pickmapChooserModel, PickmapSettings pickmapSettings, NewMapDialogFactory<G,A,R> newMapDialogFactory, MapFolderTree<G,A,R> mapFolderTree, MapManager<G,A,R> mapManager, java.awt.Component parent, MapViewsManager<G,A,R> mapViewsManager, FileControl<G,A,R> fileControl, PickmapChooserView<G,A,R> pickmapChooserView) Create a PickmapChooserControl.

Method Summary

Modifier and Type	Method and Description
void	addNewPickmap() Invoked when user wants to open a new pickmap.
boolean	canExit() Invoked when the user wants to exit the application.
void	deletePickmap() Invoked when the user wants to delete the active pickmap.
java.awt.Component	getComponent() Returns the component to show in the object chooser.
PickmapState<G,A,R>	getSelectedPickmap() Returns the selected pickmap.
G	getSelection() Returns the selected game object.
java.util.List<G>	getSelections() Returns the selected game objects.
java.lang.String	getTitle() Returns the title to display in the object chooser.
boolean	isLockAllPickmaps() Return whether all pickmaps are locked.
boolean	isMatching(G gameObject) Returns whether the current selection matches the given game object.
void	openPickmapMap() Open active pickmap as normal map for extensive editing.
void	revertPickmap() Invoked when user wants to revert the current pickmap to previously saved state.
void	savePickmap() Save current active pickmap.
void	setAction(javax.swing.Action action, java.lang.String name) Sets the Action instance for this editor action.
void	setActive(boolean active) Called whenever this tab becomes active or inactive.
void	setLockAllPickmaps(boolean lockAllPickmaps) Set whether all pickmaps are locked.
void	setPopupMenu(javax.swing.JPopupMenu popupMenu) Sets the popup menu to show.

Methods inherited from class java.lang.Object

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

Constructor Detail

PickmapChooserControl

public PickmapChooserControl(@NotNull
                             PickmapChooserModel<G,A,R> pickmapChooserModel,
                             @NotNull
                             PickmapSettings pickmapSettings,
                             @NotNull
                             NewMapDialogFactory<G,A,R> newMapDialogFactory,
                             @NotNull
                             MapFolderTree<G,A,R> mapFolderTree,
                             @NotNull
                             MapManager<G,A,R> mapManager,
                             @NotNull
                             java.awt.Component parent,
                             @NotNull
                             MapViewsManager<G,A,R> mapViewsManager,
                             @NotNull
                             FileControl<G,A,R> fileControl,
                             @NotNull
                             PickmapChooserView<G,A,R> pickmapChooserView)

Create a PickmapChooserControl.

Parameters:

pickmapChooserModel - the pickmap chooser model to control

pickmapSettings - the pickmap settings to use

newMapDialogFactory - the factory for creating new pickmaps

mapFolderTree - the map folder tree instance

mapManager - the map manager instance

parent - the parent component

mapViewsManager - the map views

fileControl - the file control instance

pickmapChooserView - the view for this controller

Method Detail

setPopupMenu

public void setPopupMenu(@NotNull
                         javax.swing.JPopupMenu popupMenu)

Sets the popup menu to show.

Parameters:

popupMenu - the popup menu to use

isLockAllPickmaps

@ActionMethod
public boolean isLockAllPickmaps()

Return whether all pickmaps are locked.

Returns:

true if all pickmaps are locked

getSelection

@Nullable
public G getSelection()

Returns the selected game object.

Specified by:

getSelection in interface ObjectChooserTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

one of the selected game objects or null if no game objects are selected

canExit

public boolean canExit()

Invoked when the user wants to exit the application.

Returns:

true if exiting the application is allowed

getSelectedPickmap

@Nullable
public PickmapState<G,A,R> getSelectedPickmap()

Returns the selected pickmap.

Returns:

the selected pickmap

getComponent

@NotNull
public java.awt.Component getComponent()

Returns the component to show in the object chooser.

Specified by:

getComponent in interface ObjectChooserTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the component to show

setActive

public void setActive(boolean active)

Called whenever this tab becomes active or inactive.

Specified by:

setActive in interface ObjectChooserTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

active - whether this tab is active

isMatching

public boolean isMatching(@NotNull
                          G gameObject)

Returns whether the current selection matches the given game object.

Specified by:

isMatching in interface ObjectChooserTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

gameObject - the game object to compare to

Returns:

whether the game object matches

getSelections

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

Returns the selected game objects.

Specified by:

getSelections in interface ObjectChooserTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the selected game objects

getTitle

@NotNull
public java.lang.String getTitle()

Returns the title to display in the object chooser.

Specified by:

getTitle in interface ObjectChooserTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the title

addNewPickmap

@ActionMethod
public void addNewPickmap()

Invoked when user wants to open a new pickmap.

openPickmapMap

@ActionMethod
public void openPickmapMap()

Open active pickmap as normal map for extensive editing.

deletePickmap

@ActionMethod
public void deletePickmap()

Invoked when the user wants to delete the active pickmap.

savePickmap

@ActionMethod
public void savePickmap()

Save current active pickmap.

revertPickmap

@ActionMethod
public void revertPickmap()

Invoked when user wants to revert the current pickmap to previously saved state.

setLockAllPickmaps

@ActionMethod
public void setLockAllPickmaps(boolean lockAllPickmaps)

Set whether all pickmaps are locked.

Parameters:

lockAllPickmaps - true if all pickmaps are locked

setAction

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

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