Default implementation of ProjectSettings. More...

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

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

Public Member Functions
File	getArchDirectory ()
	Returns the archetype directory. More...

String	getConfigSourceName ()
	Returns the name of the configuration source. More...

String	getImageSet ()
	Returns the image set. More...

File	getMapsDirectory ()
	Returns the default maps directory. More...

File	getMediaDirectory ()
	Returns the media directory. More...

String	getUserName ()
	Returns the user name. More...

boolean	saveIndices ()
	Returns whether indices should be saved to disk. More...

void	setArchDirectory (@NotNull final File archDirectory)
	Sets the archetype directory. More...

void	setConfigSourceName (@NotNull final String configSourceName)
	Sets the name of the configuration source. More...

void	setImageSet (@NotNull final String imageSet)
	Sets the image set. More...

void	setMapsDirectory (@NotNull final File mapsDirectory)
	Sets the default maps directory. More...

void	setMediaDirectory (@NotNull final File mediaDirectory)
	Sets the media directory. More...

void	setUserName (@NotNull final String userName)
	Sets the user name. More...

Public Member Functions inherited from net.sf.gridarta.model.settings.AbstractProjectSettings
void	addProjectSettingsListener (@NotNull final ProjectSettingsListener listener)
	Adds a ProjectSettingsListener to be notified of changes. More...

void	removeProjectSettingsListener (@NotNull final ProjectSettingsListener listener)
	Removes a ProjectSettingsListener to be notified of changes. More...

Public Member Functions inherited from net.sf.gridarta.model.settings.ProjectSettings
File	getCollectedDirectory ()
	Returns the directory where collected archetypes are stored. More...

File	getConfigurationDirectory ()
	Returns the configuration directory which is used to load configuration information like types.xml. More...

File	getPickmapDir ()
	Returns the pickmap directory. More...

Protected Member Functions
	AbstractDefaultProjectSettings (@NotNull final EditorSettings editorSettings)
	Creates a new instance. More...

Protected Member Functions inherited from net.sf.gridarta.model.settings.AbstractProjectSettings
void	fireMapsDirectoryChanged ()
	Notifies all listeners about a changed maps directory. More...

Private Member Functions
void	setMapsDirectoryInt (@NotNull final File mapsDirectory, final boolean updatePreferences)
	Sets the mapsDirectory. More...

Private Attributes
File	archDirectory
	The archetype directory. More...

String	configSourceName
	Do we load arches from the collected archives. More...

final EditorSettings	editorSettings
	The EditorSettings for retrieving default values. More...

String	imageSet
	The image set. More...

File	mapsDirectory
	The default maps directory. More...

File	mediaDirectory
	The media directory. More...

Static Private Attributes
static final String	ARCH_DIRECTORY_KEY = "archDirectory"
	The preferences key for the archetype directory. More...

static final String	CONFIG_SOURCE_KEY = "configSource"
	The preferences key for configuration source. More...

static final String	IMAGE_SET_KEY = "useImageSet"
	The preferences key for the selected image set. More...

static final String	MAP_DIRECTORY_KEY = "mapDirectory"
	The preferences key for the archetype directory. More...

static final String	MEDIA_DIRECTORY_KEY = "mediaDirectory"
	The preferences key for the media directory. More...

static final Preferences	PREFERENCES = Preferences.userNodeForPackage(MainControl.class)
	Preferences. More...

static final String	PREFERENCES_USER_NAME = "username"
	Preferences key for user name. More...

Detailed Description

Default implementation of ProjectSettings.

Author: Andreas Kirschbaum

Definition at line 34 of file AbstractDefaultProjectSettings.java.

Constructor & Destructor Documentation

◆ AbstractDefaultProjectSettings()

net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.AbstractDefaultProjectSettings ( @NotNull final EditorSettings editorSettings )

protected

Creates a new instance.

Parameters

editorSettings the editor settings for retrieving default values

Definition at line 118 of file AbstractDefaultProjectSettings.java.

References net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.editorSettings, net.sf.gridarta.utils.IOUtils.getCanonicalFile(), and net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.setMapsDirectoryInt().

Here is the call graph for this function:

Member Function Documentation

◆ getArchDirectory()

File net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.getArchDirectory ( )

Returns the archetype directory.

Returns: the archetype directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 150 of file AbstractDefaultProjectSettings.java.

References net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.archDirectory.

Referenced by net.sf.gridarta.var.atrinik.model.settings.AtrinikDefaultProjectSettings.getCollectedDirectory(), net.sf.gridarta.var.daimonin.model.settings.DaimoninDefaultProjectSettings.getCollectedDirectory(), net.sf.gridarta.var.daimonin.model.settings.DaimoninDefaultProjectSettings.getConfigurationDirectory(), net.sf.gridarta.var.atrinik.model.settings.AtrinikDefaultProjectSettings.getConfigurationDirectory(), net.sf.gridarta.var.daimonin.model.settings.DaimoninDefaultProjectSettings.getPickmapDir(), and net.sf.gridarta.var.atrinik.model.settings.AtrinikDefaultProjectSettings.getPickmapDir().

Here is the caller graph for this function:

◆ getConfigSourceName()

String net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.getConfigSourceName ( )

Returns the name of the configuration source.

Returns: the name of the configuration source

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 235 of file AbstractDefaultProjectSettings.java.

References net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.configSourceName.

◆ getImageSet()

String net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.getImageSet ( )

Returns the image set.

Returns: the image set

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 216 of file AbstractDefaultProjectSettings.java.

References net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.imageSet.

◆ getMapsDirectory()

File net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.getMapsDirectory ( )

Returns the default maps directory.

Returns: the default maps directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 167 of file AbstractDefaultProjectSettings.java.

References net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.mapsDirectory.

Referenced by net.sf.gridarta.var.crossfire.model.settings.CrossfireDefaultProjectSettings.getPickmapDir().

Here is the caller graph for this function:

◆ getMediaDirectory()

File net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.getMediaDirectory ( )

Returns the media directory.

It contains background music files.

Returns: the media directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 196 of file AbstractDefaultProjectSettings.java.

References net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.mediaDirectory.

◆ getUserName()

String net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.getUserName ( )

Returns the user name.

Returns: the user name

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 251 of file AbstractDefaultProjectSettings.java.

References net.sf.gridarta.model.settings.EditorSettings.getUserNameDefault().

Here is the call graph for this function:

◆ saveIndices()

boolean net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.saveIndices ( )

Returns whether indices should be saved to disk.

Returns: whether indices should be saved to disk

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 261 of file AbstractDefaultProjectSettings.java.

◆ setArchDirectory()

void net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.setArchDirectory ( @NotNull final File archDirectory )

Sets the archetype directory.

Parameters

archDirectory the archetype directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 155 of file AbstractDefaultProjectSettings.java.

References net.sf.gridarta.utils.IOUtils.getCanonicalFile().

Here is the call graph for this function:

◆ setConfigSourceName()

void net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.setConfigSourceName ( @NotNull final String configSourceName )

Sets the name of the configuration source.

Parameters

configSourceName the name

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 240 of file AbstractDefaultProjectSettings.java.

References net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.configSourceName.

◆ setImageSet()

void net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.setImageSet ( @NotNull final String imageSet )

Sets the image set.

Parameters

imageSet the image set

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 221 of file AbstractDefaultProjectSettings.java.

References net.sf.gridarta.model.settings.EditorSettings.hasImageSet(), and net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.imageSet.

Here is the call graph for this function:

◆ setMapsDirectory()

void net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.setMapsDirectory ( @NotNull final File mapsDirectory )

Sets the default maps directory.

Parameters

mapsDirectory the default maps directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 172 of file AbstractDefaultProjectSettings.java.

References net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.setMapsDirectoryInt().

Here is the call graph for this function:

◆ setMapsDirectoryInt()

void net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.setMapsDirectoryInt	(	@NotNull final File	mapsDirectory,
		final boolean	updatePreferences
	)

private

Sets the mapsDirectory.

Parameters

mapsDirectory	the new maps directory
updatePreferences	whether the preferences should be updated

Definition at line 181 of file AbstractDefaultProjectSettings.java.

References net.sf.gridarta.model.settings.AbstractProjectSettings.fireMapsDirectoryChanged(), and net.sf.gridarta.utils.IOUtils.getCanonicalFile().

Referenced by net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.AbstractDefaultProjectSettings(), and net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.setMapsDirectory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMediaDirectory()

void net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.setMediaDirectory ( @NotNull final File mediaDirectory )

Sets the media directory.

It contains background music files.

Parameters

mediaDirectory the media directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 201 of file AbstractDefaultProjectSettings.java.

References net.sf.gridarta.utils.IOUtils.getCanonicalFile(), and net.sf.gridarta.model.settings.EditorSettings.hasMediaDirectory().

Here is the call graph for this function:

◆ setUserName()

void net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.setUserName ( @NotNull final String userName )

Sets the user name.

Parameters

userName the user name

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 256 of file AbstractDefaultProjectSettings.java.

Member Data Documentation

◆ ARCH_DIRECTORY_KEY

final String net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.ARCH_DIRECTORY_KEY = "archDirectory"

staticprivate

The preferences key for the archetype directory.

Definition at line 46 of file AbstractDefaultProjectSettings.java.

◆ archDirectory

File net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.archDirectory

private

The archetype directory.

Definition at line 88 of file AbstractDefaultProjectSettings.java.

Referenced by net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.getArchDirectory().

◆ CONFIG_SOURCE_KEY

final String net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.CONFIG_SOURCE_KEY = "configSource"

staticprivate

The preferences key for configuration source.

Definition at line 70 of file AbstractDefaultProjectSettings.java.

◆ configSourceName

String net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.configSourceName

private

Do we load arches from the collected archives.

Definition at line 112 of file AbstractDefaultProjectSettings.java.

Referenced by net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.getConfigSourceName(), and net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.setConfigSourceName().

◆ editorSettings

final EditorSettings net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.editorSettings

private

The EditorSettings for retrieving default values.

Definition at line 82 of file AbstractDefaultProjectSettings.java.

Referenced by net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.AbstractDefaultProjectSettings().

◆ IMAGE_SET_KEY

final String net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.IMAGE_SET_KEY = "useImageSet"

staticprivate

The preferences key for the selected image set.

Definition at line 58 of file AbstractDefaultProjectSettings.java.

◆ imageSet

String net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.imageSet

private

The image set.

Definition at line 106 of file AbstractDefaultProjectSettings.java.

Referenced by net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.getImageSet(), and net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.setImageSet().

◆ MAP_DIRECTORY_KEY

final String net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.MAP_DIRECTORY_KEY = "mapDirectory"

staticprivate

The preferences key for the archetype directory.

Definition at line 40 of file AbstractDefaultProjectSettings.java.

◆ mapsDirectory

File net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.mapsDirectory

private

The default maps directory.

Definition at line 94 of file AbstractDefaultProjectSettings.java.

Referenced by net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.getMapsDirectory().

◆ MEDIA_DIRECTORY_KEY

final String net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.MEDIA_DIRECTORY_KEY = "mediaDirectory"

staticprivate

The preferences key for the media directory.

Definition at line 52 of file AbstractDefaultProjectSettings.java.

◆ mediaDirectory

File net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.mediaDirectory

private

The media directory.

Definition at line 100 of file AbstractDefaultProjectSettings.java.

Referenced by net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.getMediaDirectory().

◆ PREFERENCES

final Preferences net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.PREFERENCES = Preferences.userNodeForPackage(MainControl.class)

staticprivate

Preferences.

Definition at line 76 of file AbstractDefaultProjectSettings.java.

◆ PREFERENCES_USER_NAME

final String net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.PREFERENCES_USER_NAME = "username"

staticprivate

Preferences key for user name.

Definition at line 64 of file AbstractDefaultProjectSettings.java.

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

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AbstractDefaultProjectSettings()

Member Function Documentation

◆ getArchDirectory()

◆ getConfigSourceName()

◆ getImageSet()

◆ getMapsDirectory()

◆ getMediaDirectory()

◆ getUserName()

◆ saveIndices()

◆ setArchDirectory()

◆ setConfigSourceName()

◆ setImageSet()

◆ setMapsDirectory()

◆ setMapsDirectoryInt()

◆ setMediaDirectory()

◆ setUserName()

Member Data Documentation

◆ ARCH_DIRECTORY_KEY

◆ archDirectory

◆ CONFIG_SOURCE_KEY

◆ configSourceName

◆ editorSettings

◆ IMAGE_SET_KEY

◆ imageSet

◆ MAP_DIRECTORY_KEY

◆ mapsDirectory

◆ MEDIA_DIRECTORY_KEY

◆ mediaDirectory

◆ PREFERENCES

◆ PREFERENCES_USER_NAME