Gridarta Editor
net.sf.gridarta.model.settings.AbstractProjectSettings Class Referenceabstract

Abstract base class for ProjectSettings implementations. More...

+ Inheritance diagram for net.sf.gridarta.model.settings.AbstractProjectSettings:
+ Collaboration diagram for net.sf.gridarta.model.settings.AbstractProjectSettings:

Public Member Functions

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 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...
 
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...
 

Protected Member Functions

void fireMapsDirectoryChanged ()
 Notifies all listeners about a changed maps directory. More...
 

Private Attributes

final EventListenerList2< ProjectSettingsListenerlistenerList = new EventListenerList2<>(ProjectSettingsListener.class)
 The ProjectSettingsListeners to inform of changes. More...
 

Detailed Description

Abstract base class for ProjectSettings implementations.

Author
Andreas Kirschbaum

Definition at line 30 of file AbstractProjectSettings.java.

Member Function Documentation

◆ addProjectSettingsListener()

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

Adds a ProjectSettingsListener to be notified of changes.

Parameters
listenerthe listener

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

Definition at line 40 of file AbstractProjectSettings.java.

References net.sf.gridarta.utils.EventListenerList2< T extends EventListener >.add().

+ Here is the call graph for this function:

◆ fireMapsDirectoryChanged()

void net.sf.gridarta.model.settings.AbstractProjectSettings.fireMapsDirectoryChanged ( )
protected

◆ removeProjectSettingsListener()

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

Removes a ProjectSettingsListener to be notified of changes.

Parameters
listenerthe listener

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

Definition at line 45 of file AbstractProjectSettings.java.

References net.sf.gridarta.utils.EventListenerList2< T extends EventListener >.remove().

+ Here is the call graph for this function:

Member Data Documentation

◆ listenerList

final EventListenerList2<ProjectSettingsListener> net.sf.gridarta.model.settings.AbstractProjectSettings.listenerList = new EventListenerList2<>(ProjectSettingsListener.class)
private

The ProjectSettingsListeners to inform of changes.

Definition at line 37 of file AbstractProjectSettings.java.


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