Encapsulates functionality related to actions for pickmap folder selection. More...

Inheritance diagram for net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Collaboration diagram for net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions
void	createPickmapFolder ()
	Action callback function to create a new pickmap folder. More...

void	deletePickmapFolder ()
	Action callback function to delete the current pickmap folder. More...

	MapFolderTreeActions (@NotNull final MapFolderTree< G, A, R > mapFolderTree, @NotNull final PickmapSettings pickmapSettings, @NotNull final NewMapDialogFactory< G, A, R > newMapDialogFactory, @NotNull final String createFolderKey, @NotNull final String deleteFolderKey, @NotNull final String confirmDeleteFolderKey, @NotNull final String deleteFolderNotEmptyKey)
	Creates a new instance. More...

void	setAction (@NotNull final Action action, @NotNull final String name)
	Sets the Action instance for this editor action. More...

void	setPickmapFoldersMenu (@Nullable final JMenu folderMenu)
	Sets the pickmap folders menu to manage. More...

Private Member Functions
boolean	doCreateFolder (final boolean performAction)
	Executes the "create folder" action. More...

boolean	doDeletePickmapFolder (final boolean performAction)
	Executes the "delete pickmap" action. More...

void	refresh ()
	Updates the actions' states. More...

Private Attributes
Action	aCreateFolderAction
	Action for "create folder". More...

MapFolder< G, A, R >	activeMapFolder
	The last known active folder. More...

Action	aDeletePickmapFolder
	Action called for "delete active folder". More...

final String	confirmDeleteFolderKey
	The dialog key for "confirm delete folder?". More...

final String	createFolderKey
	The action key for "create folder". More...

final String	deleteFolderKey
	The action key for "delete folder". More...

final String	deleteFolderNotEmptyKey
	The dialog key for "folder is not empty". More...

JMenu	folderMenu
	The pickmap folders menu to update. More...

final MapFolderTree< G, A, R >	mapFolderTree
	The model to operate on. More...

final MapFolderTreeListener< G, A, R >	mapFolderTreeListener
	The MapFolderTreeListener which is registered to the selected pickmap. More...

final NewMapDialogFactory< G, A, R >	newMapDialogFactory
	The factory for creating new pickmap folders. More...

final PickmapSettings	pickmapSettings
	The PickmapSettings to use. More...

final PickmapSettingsListener	pickmapSettingsListener
	The PickmapSettingsListener attached to pickmapSettings. More...

Static Private Attributes
static final ActionBuilder	ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta")
	Action Builder. More...

Detailed Description

Encapsulates functionality related to actions for pickmap folder selection.

Author: Andreas Kirschbaum

Definition at line 43 of file MapFolderTreeActions.java.

Constructor & Destructor Documentation

◆ MapFolderTreeActions()

net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.MapFolderTreeActions	(	@NotNull final MapFolderTree< G, A, R >	mapFolderTree,
		@NotNull final PickmapSettings	pickmapSettings,
		@NotNull final NewMapDialogFactory< G, A, R >	newMapDialogFactory,
		@NotNull final String	createFolderKey,
		@NotNull final String	deleteFolderKey,
		@NotNull final String	confirmDeleteFolderKey,
		@NotNull final String	deleteFolderNotEmptyKey
	)

Creates a new instance.

Parameters

mapFolderTree	the model to operate on
pickmapSettings	the pickmap settings to use
newMapDialogFactory	the factory for creating new pickmap folders
createFolderKey	the action key for "create folder"
deleteFolderKey	the action key for "delete folder"
confirmDeleteFolderKey	the dialog key for "confirm delete folder?"
deleteFolderNotEmptyKey	the dialog key for "delete folder not empty"

Definition at line 168 of file MapFolderTreeActions.java.

Here is the call graph for this function:

Member Function Documentation

◆ createPickmapFolder()

void net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.createPickmapFolder ( )

Action callback function to create a new pickmap folder.

Definition at line 225 of file MapFolderTreeActions.java.

References net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doCreateFolder().

Here is the call graph for this function:

◆ deletePickmapFolder()

void net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.deletePickmapFolder ( )

Action callback function to delete the current pickmap folder.

Definition at line 250 of file MapFolderTreeActions.java.

References net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doDeletePickmapFolder().

Here is the call graph for this function:

◆ doCreateFolder()

boolean net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doCreateFolder ( final boolean performAction )

private

Executes the "create folder" action.

Parameters

performAction whether the action should be performed

Returns: whether the action was or can be performed

Definition at line 234 of file MapFolderTreeActions.java.

References net.sf.gridarta.model.pickmapsettings.PickmapSettings.isLocked(), and net.sf.gridarta.gui.dialog.newmap.NewMapDialogFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.showNewPickmapFolderDialog().

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.createPickmapFolder(), and net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doDeletePickmapFolder()

boolean net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doDeletePickmapFolder ( final boolean performAction )

private

Executes the "delete pickmap" action.

Parameters

performAction whether the action should be performed

Returns: whether the action was or can be performed

Definition at line 259 of file MapFolderTreeActions.java.

References net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.activeMapFolder, net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getName(), net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getParent(), net.sf.gridarta.gui.mapfiles.MapFolder< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getPickmaps(), net.sf.gridarta.model.pickmapsettings.PickmapSettings.isLocked(), and net.sf.gridarta.gui.mapfiles.MapFolderTree< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.removeMapFolder().

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.deletePickmapFolder(), and net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refresh()

void net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refresh ( )

private

Updates the actions' states.

Definition at line 196 of file MapFolderTreeActions.java.

References net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doCreateFolder(), net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doDeletePickmapFolder(), net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapFolderTree, and net.sf.gridarta.gui.utils.MenuUtils.removeAll().

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.MapFolderTreeActions(), net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setAction(), and net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setPickmapFoldersMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAction()

void net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setAction	(	@NotNull final Action	action,
		@NotNull final String	name
	)

Sets the Action instance for this editor action.

Parameters

action	the action instance
name	the name of the action

Implements net.sf.gridarta.utils.EditorAction.

Definition at line 285 of file MapFolderTreeActions.java.

References net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refresh().

Here is the call graph for this function:

◆ setPickmapFoldersMenu()

void net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setPickmapFoldersMenu ( @Nullable final JMenu folderMenu )

Sets the pickmap folders menu to manage.

If the passed menu is

null

, nothing is updated.

Parameters

folderMenu the pickmap folders menu

Definition at line 188 of file MapFolderTreeActions.java.

References net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.folderMenu, and net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refresh().

Here is the call graph for this function:

Member Data Documentation

◆ aCreateFolderAction

Action net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.aCreateFolderAction

private

Action for "create folder".

Definition at line 109 of file MapFolderTreeActions.java.

◆ ACTION_BUILDER

final ActionBuilder net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta")

staticprivate

Action Builder.

Definition at line 49 of file MapFolderTreeActions.java.

◆ activeMapFolder

MapFolder<G, A, R> net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.activeMapFolder

private

The last known active folder.

Definition at line 103 of file MapFolderTreeActions.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doDeletePickmapFolder().

◆ aDeletePickmapFolder

Action net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.aDeletePickmapFolder

private

Action called for "delete active folder".

Definition at line 115 of file MapFolderTreeActions.java.

◆ confirmDeleteFolderKey

final String net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.confirmDeleteFolderKey

private

The dialog key for "confirm delete folder?".

Definition at line 85 of file MapFolderTreeActions.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.MapFolderTreeActions().

◆ createFolderKey

final String net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.createFolderKey

private

The action key for "create folder".

Definition at line 73 of file MapFolderTreeActions.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.MapFolderTreeActions().

◆ deleteFolderKey

final String net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.deleteFolderKey

private

The action key for "delete folder".

Definition at line 79 of file MapFolderTreeActions.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.MapFolderTreeActions().

◆ deleteFolderNotEmptyKey

final String net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.deleteFolderNotEmptyKey

private

The dialog key for "folder is not empty".

Definition at line 91 of file MapFolderTreeActions.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.MapFolderTreeActions().

◆ folderMenu

JMenu net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.folderMenu

private

The pickmap folders menu to update.

Definition at line 97 of file MapFolderTreeActions.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setPickmapFoldersMenu().

◆ mapFolderTree

final MapFolderTree<G, A, R> net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapFolderTree

private

The model to operate on.

Definition at line 55 of file MapFolderTreeActions.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.MapFolderTreeActions(), and net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refresh().

◆ mapFolderTreeListener

final MapFolderTreeListener<G, A, R> net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapFolderTreeListener

private

Initial value:

= new MapFolderTreeListener<G, A, R>() {
        @Override
        public void activeMapFolderChanged(@Nullable final MapFolder<G, A, R> mapFolder) {
            activeMapFolder = mapFolder;
            refresh();
        }
        @Override
        public void folderAdded(@NotNull final MapFolder<G, A, R> mapFolder) {
            refresh();
        }
        @Override
        public void folderRemoved(@NotNull final MapFolder<G, A, R> mapFolder) {
            refresh();
        }
    }

The MapFolderTreeListener which is registered to the selected pickmap.

Definition at line 122 of file MapFolderTreeActions.java.

◆ newMapDialogFactory

final NewMapDialogFactory<G, A, R> net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newMapDialogFactory

private

The factory for creating new pickmap folders.

Definition at line 67 of file MapFolderTreeActions.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.MapFolderTreeActions().

◆ pickmapSettings

final PickmapSettings net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.pickmapSettings

private

The PickmapSettings to use.

Definition at line 61 of file MapFolderTreeActions.java.

Referenced by net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.MapFolderTreeActions().

◆ pickmapSettingsListener

final PickmapSettingsListener net.sf.gridarta.gui.mapfiles.MapFolderTreeActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.pickmapSettingsListener

private

Initial value:

= new PickmapSettingsListener() {
        @Override
        public void lockedChanged(final boolean locked) {
            refresh();
        }
    }

The PickmapSettingsListener attached to pickmapSettings.

Definition at line 147 of file MapFolderTreeActions.java.

The documentation for this class was generated from the following file:

gridarta-gridarta/src/gridarta/src/main/java/net/sf/gridarta/gui/mapfiles/MapFolderTreeActions.java

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MapFolderTreeActions()

Member Function Documentation

◆ createPickmapFolder()

◆ deletePickmapFolder()

◆ doCreateFolder()

◆ doDeletePickmapFolder()

◆ refresh()

◆ setAction()

◆ setPickmapFoldersMenu()

Member Data Documentation

◆ aCreateFolderAction

◆ ACTION_BUILDER

◆ activeMapFolder

◆ aDeletePickmapFolder

◆ confirmDeleteFolderKey

◆ createFolderKey

◆ deleteFolderKey

◆ deleteFolderNotEmptyKey

◆ folderMenu

◆ mapFolderTree

◆ mapFolderTreeListener

◆ newMapDialogFactory

◆ pickmapSettings

◆ pickmapSettingsListener