Gridarta Editor
ProjectSettings.java
Go to the documentation of this file.
1 /*
2  * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
3  * Copyright (C) 2000-2023 The Gridarta Developers.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 package net.sf.gridarta.model.settings;
21 
22 import java.io.File;
23 import org.jetbrains.annotations.NotNull;
24 
29 public interface ProjectSettings {
30 
36 
42 
47  @NotNull
48  File getArchDirectory();
49 
54  void setArchDirectory(@NotNull File archDirectory);
55 
60  @NotNull
61  File getMapsDirectory();
62 
67  void setMapsDirectory(@NotNull File mapsDirectory);
68 
73  @NotNull
74  String getConfigSourceName();
75 
80  void setConfigSourceName(@NotNull String configSourceName);
81 
86  @NotNull
87  File getPickmapDir();
88 
93  @NotNull
94  File getMediaDirectory();
95 
100  void setMediaDirectory(@NotNull File mediaDirectory);
101 
106  @NotNull
107  String getImageSet();
108 
113  void setImageSet(@NotNull String imageSet);
114 
120  @NotNull
122 
127  @NotNull
128  File getCollectedDirectory();
129 
134  @NotNull
135  String getUserName();
136 
141  void setUserName(@NotNull String userName);
142 
147  boolean saveIndices();
148 
149 }
net.sf.gridarta.model.settings.ProjectSettings.getImageSet
String getImageSet()
Returns the image set.
net.sf.gridarta.model.settings.ProjectSettings.setMediaDirectory
void setMediaDirectory(@NotNull File mediaDirectory)
Sets the media directory.
net.sf.gridarta.model.settings.ProjectSettings.setConfigSourceName
void setConfigSourceName(@NotNull String configSourceName)
Sets the name of the configuration source.
net.sf.gridarta.model.settings.ProjectSettings.setUserName
void setUserName(@NotNull String userName)
Sets the user name.
net.sf.gridarta.model.settings.ProjectSettings.getPickmapDir
File getPickmapDir()
Returns the pickmap directory.
net.sf.gridarta.model.settings.ProjectSettings.getUserName
String getUserName()
Returns the user name.
net.sf.gridarta.model.settings.ProjectSettings.setArchDirectory
void setArchDirectory(@NotNull File archDirectory)
Sets the archetype directory.
net.sf.gridarta.model.settings.ProjectSettingsListener
Interface for listeners interested in ProjectSettings events.
Definition: ProjectSettingsListener.java:30
net.sf.gridarta.model.settings.ProjectSettings.addProjectSettingsListener
void addProjectSettingsListener(@NotNull ProjectSettingsListener listener)
Adds a ProjectSettingsListener to be notified of changes.
net.sf.gridarta.model.settings.ProjectSettings.setMapsDirectory
void setMapsDirectory(@NotNull File mapsDirectory)
Sets the default maps directory.
net.sf.gridarta.model.settings.ProjectSettings.getConfigSourceName
String getConfigSourceName()
Returns the name of the configuration source.
net.sf.gridarta.model.settings.ProjectSettings
Settings that apply to a project.
Definition: ProjectSettings.java:29
net.sf.gridarta.model.settings.ProjectSettings.removeProjectSettingsListener
void removeProjectSettingsListener(@NotNull ProjectSettingsListener listener)
Removes a ProjectSettingsListener to be notified of changes.
net.sf.gridarta.model.settings.ProjectSettings.getArchDirectory
File getArchDirectory()
Returns the archetype directory.
net.sf.gridarta.model.settings.ProjectSettings.getCollectedDirectory
File getCollectedDirectory()
Returns the directory where collected archetypes are stored.
net.sf.gridarta.model.settings.ProjectSettings.saveIndices
boolean saveIndices()
Returns whether indices should be saved to disk.
net.sf.gridarta.model.settings.ProjectSettings.getConfigurationDirectory
File getConfigurationDirectory()
Returns the configuration directory which is used to load configuration information like types....
net.sf.gridarta.model.settings.ProjectSettings.getMapsDirectory
File getMapsDirectory()
Returns the default maps directory.
net.sf.gridarta.model.settings.ProjectSettings.setImageSet
void setImageSet(@NotNull String imageSet)
Sets the image set.
net.sf.gridarta.model.settings.ProjectSettings.getMediaDirectory
File getMediaDirectory()
Returns the media directory.