net.sf.gridarta.model.settings

Interface ProjectSettings

All Known Implementing Classes:

AbstractDefaultProjectSettings, AbstractProjectSettings, AtrinikDefaultProjectSettings, CrossfireDefaultProjectSettings, DaimoninDefaultProjectSettings

public interface ProjectSettings

Settings that apply to a project. These settings are project specific.

Method Summary

Modifier and Type	Method and Description
void	addProjectSettingsListener(ProjectSettingsListener listener) Adds a ProjectSettingsListener to be notified of changes.
java.io.File	getArchDirectory() Returns the archetype directory.
java.io.File	getCollectedDirectory() Returns the directory where collected archetypes are stored.
java.lang.String	getConfigSourceName() Returns the name of the configuration source.
java.io.File	getConfigurationDirectory() Returns the configuration directory which is used to load configuration information like types.xml.
java.lang.String	getImageSet() Returns the image set.
java.io.File	getMapsDirectory() Returns the default maps directory.
java.io.File	getMediaDirectory() Returns the media directory.
java.io.File	getPickmapDir() Returns the pickmap directory.
java.lang.String	getUserName() Returns the user name.
void	removeProjectSettingsListener(ProjectSettingsListener listener) Removes a ProjectSettingsListener to be notified of changes.
boolean	saveIndices() Returns whether indices should be saved to disk.
void	setArchDirectory(java.io.File archDirectory) Sets the archetype directory.
void	setConfigSourceName(java.lang.String configSourceName) Sets the name of the configuration source.
void	setImageSet(java.lang.String imageSet) Sets the image set.
void	setMapsDirectory(java.io.File mapsDirectory) Sets the default maps directory.
void	setMediaDirectory(java.io.File mediaDirectory) Sets the media directory.
void	setUserName(java.lang.String userName) Sets the user name.

Method Detail

addProjectSettingsListener

void addProjectSettingsListener(@NotNull
                                ProjectSettingsListener listener)

Adds a ProjectSettingsListener to be notified of changes.

Parameters:

listener - the listener

removeProjectSettingsListener

void removeProjectSettingsListener(@NotNull
                                   ProjectSettingsListener listener)

Removes a ProjectSettingsListener to be notified of changes.

Parameters:

listener - the listener

getArchDirectory

@NotNull
java.io.File getArchDirectory()

Returns the archetype directory.

Returns:

the archetype directory

setArchDirectory

void setArchDirectory(@NotNull
                      java.io.File archDirectory)

Sets the archetype directory.

Parameters:

archDirectory - the archetype directory

getMapsDirectory

@NotNull
java.io.File getMapsDirectory()

Returns the default maps directory.

Returns:

the default maps directory

setMapsDirectory

void setMapsDirectory(@NotNull
                      java.io.File mapsDirectory)

Sets the default maps directory.

Parameters:

mapsDirectory - the default maps directory

getConfigSourceName

@NotNull
java.lang.String getConfigSourceName()

Returns the name of the configuration source.

Returns:

the name of the configuration source

setConfigSourceName

void setConfigSourceName(@NotNull
                         java.lang.String configSourceName)

Sets the name of the configuration source.

Parameters:

configSourceName - the name

getPickmapDir

@NotNull
java.io.File getPickmapDir()

Returns the pickmap directory.

Returns:

the pickmap directory

getMediaDirectory

@NotNull
java.io.File getMediaDirectory()

Returns the media directory. It contains background music files.

Returns:

the media directory

setMediaDirectory

void setMediaDirectory(@NotNull
                       java.io.File mediaDirectory)

Sets the media directory. It contains background music files.

Parameters:

mediaDirectory - the media directory

getImageSet

@NotNull
java.lang.String getImageSet()

Returns the image set.

Returns:

the image set

setImageSet

void setImageSet(@NotNull
                 java.lang.String imageSet)

Sets the image set.

Parameters:

imageSet - the image set

getConfigurationDirectory

@NotNull
java.io.File getConfigurationDirectory()

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

Returns:

the directory

getCollectedDirectory

@NotNull
java.io.File getCollectedDirectory()

Returns the directory where collected archetypes are stored.

Returns:

the directory

getUserName

@NotNull
java.lang.String getUserName()

Returns the user name.

Returns:

the user name

setUserName

void setUserName(@NotNull
                 java.lang.String userName)

Sets the user name.

Parameters:

userName - the user name

saveIndices

boolean saveIndices()

Returns whether indices should be saved to disk.

Returns:

whether indices should be saved to disk