net.sf.gridarta.gui.misc

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

java.lang.Object

net.sf.gridarta.gui.misc.DefaultFileControl<G,A,R>

All Implemented Interfaces:

FileControl<G,A,R>

public class DefaultFileControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object
implements FileControl<G,A,R>

Default FileControl implementation. Asks the user for directions.

Constructor Summary

Constructors

Constructor and Description

DefaultFileControl(@NotNull ProjectSettings projectSettings, @NotNull VolatileSettings volatileSettings, @NotNull MapImageCache<G,A,R> mapImageCache, @NotNull MapManager<G,A,R> mapManager, @NotNull MapViewsManager<G,A,R> mapViewsManager, @NotNull java.awt.Component parent, @NotNull javax.swing.filechooser.FileFilter mapFileFilter, @NotNull javax.swing.filechooser.FileFilter scriptFileFilter, @NotNull NewMapDialogFactory<G,A,R> newMapDialogFactory, @NotNull java.lang.String scriptExtension, @NotNull ScriptEditControl scriptEditControl, @NotNull PathManager pathManager) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	closeAllMaps() Invoked when the user wants to close all maps.
boolean	confirmSaveChanges(@NotNull MapControl<G,A,R> mapControl) Asks the user whether to save changes of a map.
void	openFile(boolean mapFile) The user wants to edit a file.
void	reportLoadError(@Nullable java.io.File file, @NotNull java.lang.String message)
void	reportOutOfMapBoundsDeleted(@NotNull java.io.File file, int outOfMapBoundsDeleted, @NotNull java.lang.StringBuilder outOfMapBoundsObjects)
void	reportOutOfMemory(@NotNull java.io.File file)
void	reportSaveError(@NotNull java.io.File mapFile, @NotNull java.lang.String message) Reports an error while saving a map file to the user.
void	reportSaveError(@NotNull MapControl<G,A,R> mapControl, @NotNull java.lang.String message) Reports an error while saving a map file to the user.
void	reportTeleportCharacterError(@NotNull java.lang.String mapPath, @NotNull java.lang.String message) Reports an error while teleporting a character to the current map.
boolean	save(@NotNull MapControl<G,A,R> mapControl) Save one map.
void	saveAllMaps() Saves all maps.
boolean	saveAs(@NotNull MapControl<G,A,R> mapControl) Asks the user for a filename, then saves the map.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFileControl

public DefaultFileControl(@NotNull
                          @NotNull ProjectSettings projectSettings,
                          @NotNull
                          @NotNull VolatileSettings volatileSettings,
                          @NotNull
                          @NotNull MapImageCache<G,A,R> mapImageCache,
                          @NotNull
                          @NotNull MapManager<G,A,R> mapManager,
                          @NotNull
                          @NotNull MapViewsManager<G,A,R> mapViewsManager,
                          @NotNull
                          @NotNull java.awt.Component parent,
                          @NotNull
                          @NotNull javax.swing.filechooser.FileFilter mapFileFilter,
                          @NotNull
                          @NotNull javax.swing.filechooser.FileFilter scriptFileFilter,
                          @NotNull
                          @NotNull NewMapDialogFactory<G,A,R> newMapDialogFactory,
                          @NotNull
                          @NotNull java.lang.String scriptExtension,
                          @NotNull
                          @NotNull ScriptEditControl scriptEditControl,
                          @NotNull
                          @NotNull PathManager pathManager)

Creates a new instance.

Parameters:

projectSettings - the project settings instance

volatileSettings - the volatile settings instance

mapImageCache - the map image cache

mapManager - the map manager

mapViewsManager - the map views manager

parent - the parent component for showing dialog boxes

mapFileFilter - the file filter for selecting map files

scriptFileFilter - the file filter for selecting script files

newMapDialogFactory - the new map dialog factory

scriptExtension - the file extension for script files

scriptEditControl - the script edit control to forward to

pathManager - the path manager for creating map file instances

Method Detail

openFile

public void openFile(boolean mapFile)

Description copied from interface: FileControl

The user wants to edit a file.

Specified by:

openFile in interface FileControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapFile - true for map files, false for script files

save

public boolean save(@NotNull
                    @NotNull MapControl<G,A,R> mapControl)

Description copied from interface: FileControl

Save one map.

Specified by:

save in interface FileControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapControl - the map

Returns:

false if saving failed, true otherwise

saveAllMaps

public void saveAllMaps()

Description copied from interface: FileControl

Saves all maps.

Specified by:

saveAllMaps in interface FileControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

closeAllMaps

public boolean closeAllMaps()

Description copied from interface: FileControl

Invoked when the user wants to close all maps.

Specified by:

closeAllMaps in interface FileControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

true if all maps closed, false if user cancelled.

saveAs

public boolean saveAs(@NotNull
                      @NotNull MapControl<G,A,R> mapControl)

Description copied from interface: FileControl

Asks the user for a filename, then saves the map.

Specified by:

saveAs in interface FileControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapControl - the map

Returns:

false if the user cancelled the save or if saving failed, true otherwise

confirmSaveChanges

public boolean confirmSaveChanges(@NotNull
                                  @NotNull MapControl<G,A,R> mapControl)

Description copied from interface: FileControl

Asks the user whether to save changes of a map. Returns true (and does not ask the user) if the map is unmodified.

Specified by:

confirmSaveChanges in interface FileControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapControl - the map

Returns:

whether closing the map is allowed

reportSaveError

public void reportSaveError(@NotNull
                            @NotNull MapControl<G,A,R> mapControl,
                            @NotNull
                            @NotNull java.lang.String message)

Description copied from interface: FileControl

Reports an error while saving a map file to the user.

Specified by:

reportSaveError in interface FileControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapControl - the map control that failed saving

message - the error message

reportSaveError

public void reportSaveError(@NotNull
                            @NotNull java.io.File mapFile,
                            @NotNull
                            @NotNull java.lang.String message)

Description copied from interface: FileControl

Reports an error while saving a map file to the user.

Specified by:

reportSaveError in interface FileControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapFile - the map file that failed saving

message - the error message

reportLoadError

public void reportLoadError(@Nullable
                            @Nullable java.io.File file,
                            @NotNull
                            @NotNull java.lang.String message)

Specified by:

reportLoadError in interface FileControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

reportOutOfMapBoundsDeleted

public void reportOutOfMapBoundsDeleted(@NotNull
                                        @NotNull java.io.File file,
                                        int outOfMapBoundsDeleted,
                                        @NotNull
                                        @NotNull java.lang.StringBuilder outOfMapBoundsObjects)

Specified by:

reportOutOfMapBoundsDeleted in interface FileControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

reportOutOfMemory

public void reportOutOfMemory(@NotNull
                              @NotNull java.io.File file)

Specified by:

reportOutOfMemory in interface FileControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

reportTeleportCharacterError

public void reportTeleportCharacterError(@NotNull
                                         @NotNull java.lang.String mapPath,
                                         @NotNull
                                         @NotNull java.lang.String message)

Description copied from interface: FileControl

Reports an error while teleporting a character to the current map.

Specified by:

reportTeleportCharacterError in interface FileControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

mapPath - the map path to teleport to

message - the error message