Settings that apply to the editor. More...

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

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

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

File	getArchDirectoryDefault ()
	Returns the default archetype directory. More...

String	getImageSetDefault ()
	Returns the default image set. More...

String	getKey (@NotNull EditorSettingsKey key, @NotNull String defaultValue)
	Returns a settings value. More...

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

File	getMediaDirectoryDefault ()
	Returns the default media directory. More...

String	getUserNameDefault ()
	Returns the default user name. More...

boolean	hasImageSet ()
	Returns whether an image set is used. More...

boolean	hasMediaDirectory ()
	Returns whether a media directory is used. More...

boolean	isShowMainToolbar ()
	Returns whether the main toolbar should be shown. More...

void	removeEditorSettingsListener (@NotNull EditorSettingsListener listener)
	Removes a EditorSettingsListener to be notified of changes. More...

void	setKey (@NotNull EditorSettingsKey key, @NotNull String value)
	Saves a settings value. More...

void	setShowMainToolbar (boolean selected)
	Sets whether the main toolbar should be shown. More...

Public Attributes
boolean	SHOW_MAIN_TOOLBAR_DEFAULT = true
	Default value for whether the main window's toolbar is shown. More...

Detailed Description

Settings that apply to the editor.

These settings are not project specific.

Author: Andreas Kirschbaum

Definition at line 29 of file EditorSettings.java.

Member Function Documentation

◆ addEditorSettingsListener()

void net.sf.gridarta.model.settings.EditorSettings.addEditorSettingsListener ( @NotNull EditorSettingsListener listener )

Adds a EditorSettingsListener to be notified of changes.

Parameters

listener the listener

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

◆ getArchDirectoryDefault()

File net.sf.gridarta.model.settings.EditorSettings.getArchDirectoryDefault ( )

Returns the default archetype directory.

Returns: the default archetype directory

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

Referenced by net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.AbstractDefaultProjectSettings(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.defaults().

Here is the caller graph for this function:

◆ getImageSetDefault()

String net.sf.gridarta.model.settings.EditorSettings.getImageSetDefault ( )

Returns the default image set.

Returns: the default image set

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

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

Here is the caller graph for this function:

◆ getKey()

String net.sf.gridarta.model.settings.EditorSettings.getKey	(	@NotNull EditorSettingsKey	key,
		@NotNull String	defaultValue
	)

Returns a settings value.

Parameters

key	the settings key
defaultValue	the default value if the key is unset

Returns: the settings value

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

Referenced by net.sf.gridarta.gui.filter.DefaultFilterControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.DefaultFilterControl().

Here is the caller graph for this function:

◆ getMapsDirectoryDefault()

File net.sf.gridarta.model.settings.EditorSettings.getMapsDirectoryDefault ( )

Returns the default maps directory.

Returns: the default maps directory

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

Referenced by net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.AbstractDefaultProjectSettings(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.defaults().

Here is the caller graph for this function:

◆ getMediaDirectoryDefault()

File net.sf.gridarta.model.settings.EditorSettings.getMediaDirectoryDefault ( )

Returns the default media directory.

Returns: the default media directory

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

Referenced by net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.AbstractDefaultProjectSettings(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.defaults().

Here is the caller graph for this function:

◆ getUserNameDefault()

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

Returns the default user name.

Returns: the default user name

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

Referenced by net.sf.gridarta.gui.dialog.prefs.MiscPreferences.defaults(), and net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.getUserName().

Here is the caller graph for this function:

◆ hasImageSet()

boolean net.sf.gridarta.model.settings.EditorSettings.hasImageSet ( )

Returns whether an image set is used.

Returns: whether an image set is used

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

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.apply(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.createGlobalPanel(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.defaults(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.isChanged(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert(), and net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.setImageSet().

Here is the caller graph for this function:

◆ hasMediaDirectory()

boolean net.sf.gridarta.model.settings.EditorSettings.hasMediaDirectory ( )

Returns whether a media directory is used.

Returns: whether a media directory is used

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

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.apply(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.createResourcePanel(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.defaults(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.isChanged(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert(), and net.sf.gridarta.model.settings.AbstractDefaultProjectSettings.setMediaDirectory().

Here is the caller graph for this function:

◆ isShowMainToolbar()

boolean net.sf.gridarta.model.settings.EditorSettings.isShowMainToolbar ( )

Returns whether the main toolbar should be shown.

Returns: whether the main toolbar should be shown

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

Referenced by net.sf.gridarta.gui.dialog.prefs.GUIPreferences.createLayoutPanel(), net.sf.gridarta.model.settings.AbstractEditorSettings.fireShowMainToolbarChanged(), net.sf.gridarta.gui.dialog.prefs.GUIPreferences.isChanged(), and net.sf.gridarta.gui.dialog.prefs.GUIPreferences.revert().

Here is the caller graph for this function:

◆ removeEditorSettingsListener()

void net.sf.gridarta.model.settings.EditorSettings.removeEditorSettingsListener ( @NotNull EditorSettingsListener listener )

Removes a EditorSettingsListener to be notified of changes.

Parameters

listener the listener

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

◆ setKey()

void net.sf.gridarta.model.settings.EditorSettings.setKey	(	@NotNull EditorSettingsKey	key,
		@NotNull String	value
	)

Saves a settings value.

Parameters

key	the settings key
value	the settings value

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

◆ setShowMainToolbar()

void net.sf.gridarta.model.settings.EditorSettings.setShowMainToolbar ( boolean selected )

Sets whether the main toolbar should be shown.

Parameters

selected whether the main toolbar should be shown

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

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

Here is the caller graph for this function:

Member Data Documentation

◆ SHOW_MAIN_TOOLBAR_DEFAULT

boolean net.sf.gridarta.model.settings.EditorSettings.SHOW_MAIN_TOOLBAR_DEFAULT = true

Default value for whether the main window's toolbar is shown.

Definition at line 34 of file EditorSettings.java.

Referenced by net.sf.gridarta.gui.dialog.prefs.GUIPreferences.defaults(), and net.sf.gridarta.model.settings.DefaultEditorSettings.isShowMainToolbar().

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

src/model/src/main/java/net/sf/gridarta/model/settings/EditorSettings.java

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addEditorSettingsListener()

◆ getArchDirectoryDefault()

◆ getImageSetDefault()

◆ getKey()

◆ getMapsDirectoryDefault()

◆ getMediaDirectoryDefault()

◆ getUserNameDefault()

◆ hasImageSet()

◆ hasMediaDirectory()

◆ isShowMainToolbar()

◆ removeEditorSettingsListener()

◆ setKey()

◆ setShowMainToolbar()

Member Data Documentation

◆ SHOW_MAIN_TOOLBAR_DEFAULT