Gridarta Editor: net.sf.gridarta.model.settings.DefaultVolatileSettings Class Reference

Gridarta Editor

Default implementation of VolatileSettings. More...

Inheritance diagram for net.sf.gridarta.model.settings.DefaultVolatileSettings:

Collaboration diagram for net.sf.gridarta.model.settings.DefaultVolatileSettings:

Public Member Functions
	DefaultVolatileSettings (@NotNull final File mapsDirectory)
	Creates a new instance. More...

File	getCurrentSaveMapDirectory ()
	Returns the default directory for saving maps. More...

File	getImageDirectory ()
	Returns the directory to save images to. More...

void	setCurrentSaveMapDirectory (@NotNull final File currentSaveMapDirectory)
	Sets the default directory for saving maps. More...

void	setImageDirectory (@NotNull final File imageDirectory)
	Sets the directory to save created image to. More...

Private Attributes
File	currentSaveMapDirectory
	The the default directory for saving maps. More...

File	imageDirectory
	The image directory. More...

Detailed Description

Default implementation of VolatileSettings.

Author: Andreas Kirschbaum

Definition at line 29 of file DefaultVolatileSettings.java.

Constructor & Destructor Documentation

◆ DefaultVolatileSettings()

net.sf.gridarta.model.settings.DefaultVolatileSettings.DefaultVolatileSettings ( @NotNull final File mapsDirectory )

Creates a new instance.

Parameters

mapsDirectory the maps directory

Definition at line 48 of file DefaultVolatileSettings.java.

Member Function Documentation

◆ getCurrentSaveMapDirectory()

File net.sf.gridarta.model.settings.DefaultVolatileSettings.getCurrentSaveMapDirectory ( )

Returns the default directory for saving maps.

Returns: the default directory for saving maps

Implements net.sf.gridarta.model.settings.VolatileSettings.

Definition at line 66 of file DefaultVolatileSettings.java.

References net.sf.gridarta.model.settings.DefaultVolatileSettings.currentSaveMapDirectory.

◆ getImageDirectory()

File net.sf.gridarta.model.settings.DefaultVolatileSettings.getImageDirectory ( )

Returns the directory to save images to.

Returns: the image directory

Implements net.sf.gridarta.model.settings.VolatileSettings.

Definition at line 55 of file DefaultVolatileSettings.java.

References net.sf.gridarta.model.settings.DefaultVolatileSettings.imageDirectory.

◆ setCurrentSaveMapDirectory()

void net.sf.gridarta.model.settings.DefaultVolatileSettings.setCurrentSaveMapDirectory ( @NotNull final File currentSaveMapDirectory )

Sets the default directory for saving maps.

Parameters

currentSaveMapDirectory the default directory for saving maps

Implements net.sf.gridarta.model.settings.VolatileSettings.

Definition at line 71 of file DefaultVolatileSettings.java.

References net.sf.gridarta.model.settings.DefaultVolatileSettings.currentSaveMapDirectory.

◆ setImageDirectory()

void net.sf.gridarta.model.settings.DefaultVolatileSettings.setImageDirectory ( @NotNull final File imageDirectory )

Sets the directory to save created image to.

It defaults to the maps directory and is not retained across editor restarts.

Parameters

imageDirectory the image directory

Implements net.sf.gridarta.model.settings.VolatileSettings.

Definition at line 60 of file DefaultVolatileSettings.java.

References net.sf.gridarta.model.settings.DefaultVolatileSettings.imageDirectory.

Member Data Documentation

◆ currentSaveMapDirectory

File net.sf.gridarta.model.settings.DefaultVolatileSettings.currentSaveMapDirectory

private

The the default directory for saving maps.

Definition at line 42 of file DefaultVolatileSettings.java.

Referenced by net.sf.gridarta.model.settings.DefaultVolatileSettings.getCurrentSaveMapDirectory(), and net.sf.gridarta.model.settings.DefaultVolatileSettings.setCurrentSaveMapDirectory().

◆ imageDirectory

File net.sf.gridarta.model.settings.DefaultVolatileSettings.imageDirectory

private

The image directory.

By default, created images are stored in this directory.

Definition at line 36 of file DefaultVolatileSettings.java.

Referenced by net.sf.gridarta.model.settings.DefaultVolatileSettings.getImageDirectory(), and net.sf.gridarta.model.settings.DefaultVolatileSettings.setImageDirectory().

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

gridarta-gridarta/src/model/src/main/java/net/sf/gridarta/model/settings/DefaultVolatileSettings.java