Settings that apply to a project. More...

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

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

Public Member Functions
void	addProjectSettingsListener (@NotNull ProjectSettingsListener listener)
	Adds a ProjectSettingsListener to be notified of changes. More...

File	getArchDirectory ()
	Returns the archetype directory. More...

File	getCollectedDirectory ()
	Returns the directory where collected archetypes are stored. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Detailed Description

Settings that apply to a project.

These settings are project specific.

Author: Andreas Kirschbaum

Definition at line 29 of file ProjectSettings.java.

Member Function Documentation

◆ addProjectSettingsListener()

void net.sf.gridarta.model.settings.ProjectSettings.addProjectSettingsListener ( @NotNull ProjectSettingsListener listener )

Adds a ProjectSettingsListener to be notified of changes.

Parameters

listener the listener

Implemented in net.sf.gridarta.model.settings.AbstractProjectSettings.

Referenced by net.sf.gridarta.model.index.MapsIndexer< G, A, R >.start().

Here is the caller graph for this function:

◆ getArchDirectory()

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

Returns the archetype directory.

Returns: the archetype directory

Implemented in net.sf.gridarta.model.settings.AbstractDefaultProjectSettings, and net.sf.gridarta.model.settings.TestProjectSettings.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.createResourcePanel(), net.sf.gridarta.model.validation.checks.ValidatorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.createStringArray(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.isChanged(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert().

Here is the caller graph for this function:

◆ getCollectedDirectory()

File net.sf.gridarta.model.settings.ProjectSettings.getCollectedDirectory ( )

Returns the directory where collected archetypes are stored.

Returns: the directory

Implemented in net.sf.gridarta.model.settings.TestProjectSettings, net.sf.gridarta.var.atrinik.model.settings.AtrinikDefaultProjectSettings, net.sf.gridarta.var.crossfire.model.settings.CrossfireDefaultProjectSettings, and net.sf.gridarta.var.daimonin.model.settings.DaimoninDefaultProjectSettings.

Referenced by net.sf.gridarta.model.validation.checks.ValidatorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.createStringArray(), net.sf.gridarta.action.CollectArchesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doCollectArches(), and net.sf.gridarta.commands.CollectArchesCommand.execute().

Here is the caller graph for this function:

◆ getConfigSourceName()

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

Returns the name of the configuration source.

Returns: the name of the configuration source

Implemented in net.sf.gridarta.model.settings.AbstractDefaultProjectSettings, and net.sf.gridarta.model.settings.TestProjectSettings.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.createGlobalPanel(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.isChanged(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert(), and net.sf.gridarta.maincontrol.GridartaEditor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.run().

Here is the caller graph for this function:

◆ getConfigurationDirectory()

File net.sf.gridarta.model.settings.ProjectSettings.getConfigurationDirectory ( )

Returns the configuration directory which is used to load configuration information like types.xml.

Returns: the directory

Implemented in net.sf.gridarta.model.settings.TestProjectSettings, net.sf.gridarta.var.atrinik.model.settings.AtrinikDefaultProjectSettings, net.sf.gridarta.var.crossfire.model.settings.CrossfireDefaultProjectSettings, and net.sf.gridarta.var.daimonin.model.settings.DaimoninDefaultProjectSettings.

Referenced by net.sf.gridarta.action.CollectSpellsAction.collectSpells().

Here is the caller graph for this function:

◆ getImageSet()

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

Returns the image set.

Returns: the image set

Implemented in net.sf.gridarta.model.settings.AbstractDefaultProjectSettings, and net.sf.gridarta.model.settings.TestProjectSettings.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.getCurrentImageSet().

Here is the caller graph for this function:

◆ getMapsDirectory()

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

Returns the default maps directory.

Returns: the default maps directory

Implemented in net.sf.gridarta.model.settings.AbstractDefaultProjectSettings, and net.sf.gridarta.model.settings.TestProjectSettings.

Here is the caller graph for this function:

◆ getMediaDirectory()

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

Returns the media directory.

It contains background music files.

Returns: the media directory

Implemented in net.sf.gridarta.model.settings.AbstractDefaultProjectSettings, and net.sf.gridarta.model.settings.TestProjectSettings.

Referenced by net.sf.gridarta.var.daimonin.gui.mappropertiesdialog.MapPropertiesDialog.createMapPanel(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.createResourcePanel(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.isChanged(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert().

Here is the caller graph for this function:

◆ getPickmapDir()

File net.sf.gridarta.model.settings.ProjectSettings.getPickmapDir ( )

Returns the pickmap directory.

Returns: the pickmap directory

Implemented in net.sf.gridarta.model.settings.TestProjectSettings, net.sf.gridarta.var.atrinik.model.settings.AtrinikDefaultProjectSettings, net.sf.gridarta.var.crossfire.model.settings.CrossfireDefaultProjectSettings, and net.sf.gridarta.var.daimonin.model.settings.DaimoninDefaultProjectSettings.

◆ getUserName()

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

Returns the user name.

Returns: the user name

Implemented in net.sf.gridarta.model.settings.AbstractDefaultProjectSettings, and net.sf.gridarta.model.settings.TestProjectSettings.

Referenced by net.sf.gridarta.gui.dialog.prefs.MiscPreferences.createUserPanel(), net.sf.gridarta.gui.dialog.prefs.MiscPreferences.isChanged(), net.sf.gridarta.var.atrinik.model.maparchobject.DefaultMapArchObjectFactory.newMapArchObject(), net.sf.gridarta.var.crossfire.model.maparchobject.DefaultMapArchObjectFactory.newMapArchObject(), net.sf.gridarta.var.daimonin.model.maparchobject.DefaultMapArchObjectFactory.newMapArchObject(), net.sf.gridarta.gui.dialog.prefs.MiscPreferences.revert(), and net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.save().

Here is the caller graph for this function:

◆ removeProjectSettingsListener()

void net.sf.gridarta.model.settings.ProjectSettings.removeProjectSettingsListener ( @NotNull ProjectSettingsListener listener )

Removes a ProjectSettingsListener to be notified of changes.

Parameters

listener the listener

Implemented in net.sf.gridarta.model.settings.AbstractProjectSettings.

Referenced by net.sf.gridarta.model.index.MapsIndexer< G, A, R >.stop().

Here is the caller graph for this function:

◆ saveIndices()

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

Returns whether indices should be saved to disk.

Returns: whether indices should be saved to disk

Implemented in net.sf.gridarta.model.settings.AbstractDefaultProjectSettings, and net.sf.gridarta.model.settings.TestProjectSettings.

Referenced by net.sf.gridarta.model.index.MapsIndexer< G, A, R >.saveMapsIndex().

Here is the caller graph for this function:

◆ setArchDirectory()

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

Sets the archetype directory.

Parameters

archDirectory the archetype directory

Implemented in net.sf.gridarta.model.settings.AbstractDefaultProjectSettings, and net.sf.gridarta.model.settings.TestProjectSettings.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.apply().

Here is the caller graph for this function:

◆ setConfigSourceName()

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

Sets the name of the configuration source.

Parameters

configSourceName the name

Implemented in net.sf.gridarta.model.settings.AbstractDefaultProjectSettings, and net.sf.gridarta.model.settings.TestProjectSettings.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.apply().

Here is the caller graph for this function:

◆ setImageSet()

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

Sets the image set.

Parameters

imageSet the image set

Implemented in net.sf.gridarta.model.settings.AbstractDefaultProjectSettings, and net.sf.gridarta.model.settings.TestProjectSettings.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.apply().

Here is the caller graph for this function:

◆ setMapsDirectory()

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

Sets the default maps directory.

Parameters

mapsDirectory the default maps directory

Implemented in net.sf.gridarta.model.settings.AbstractDefaultProjectSettings, and net.sf.gridarta.model.settings.TestProjectSettings.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.apply(), and net.sf.gridarta.model.mapcontrol.TestMapControlCreator.createMapsDirectory().

Here is the caller graph for this function:

◆ setMediaDirectory()

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

Sets the media directory.

It contains background music files.

Parameters

mediaDirectory the media directory

Implemented in net.sf.gridarta.model.settings.AbstractDefaultProjectSettings, and net.sf.gridarta.model.settings.TestProjectSettings.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.apply().

Here is the caller graph for this function:

◆ setUserName()

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

Sets the user name.

Parameters

userName the user name

Implemented in net.sf.gridarta.model.settings.AbstractDefaultProjectSettings, and net.sf.gridarta.model.settings.TestProjectSettings.

Referenced by net.sf.gridarta.gui.dialog.prefs.MiscPreferences.apply().

Here is the caller graph for this function:

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ addProjectSettingsListener()

◆ getArchDirectory()

◆ getCollectedDirectory()

◆ getConfigSourceName()

◆ getConfigurationDirectory()

◆ getImageSet()

◆ getMapsDirectory()

◆ getMediaDirectory()

◆ getPickmapDir()

◆ getUserName()

◆ removeProjectSettingsListener()

◆ saveIndices()

◆ setArchDirectory()

◆ setConfigSourceName()

◆ setImageSet()

◆ setMapsDirectory()

◆ setMediaDirectory()

◆ setUserName()