net.sf.gridarta.model.settings

Interface EditorSettings

All Known Implementing Classes:

AbstractEditorSettings, DefaultEditorSettings

public interface EditorSettings

Settings that apply to the editor. These settings are not project specific.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	SHOW_MAIN_TOOLBAR_DEFAULT Default value for whether the main window's toolbar is shown.

Method Summary

Modifier and Type	Method and Description
void	addEditorSettingsListener(@NotNull EditorSettingsListener listener) Adds a EditorSettingsListener to be notified of changes.
@NotNull java.io.File	getArchDirectoryDefault() Returns the default archetype directory.
@NotNull java.lang.String	getImageSetDefault() Returns the default image set.
java.lang.String	getKey(@NotNull EditorSettingsKey key, @NotNull java.lang.String defaultValue) Returns a settings value.
@NotNull java.io.File	getMapsDirectoryDefault() Returns the default maps directory.
@NotNull java.io.File	getMediaDirectoryDefault() Returns the default media directory.
@NotNull java.lang.String	getUserNameDefault() Returns the default user name.
boolean	hasImageSet() Returns whether an image set is used.
boolean	hasMediaDirectory() Returns whether a media directory is used.
boolean	isShowMainToolbar() Returns whether the main toolbar should be shown.
void	removeEditorSettingsListener(@NotNull EditorSettingsListener listener) Removes a EditorSettingsListener to be notified of changes.
void	setKey(@NotNull EditorSettingsKey key, @NotNull java.lang.String value) Saves a settings value.
void	setShowMainToolbar(boolean selected) Sets whether the main toolbar should be shown.

Field Detail

SHOW_MAIN_TOOLBAR_DEFAULT

static final boolean SHOW_MAIN_TOOLBAR_DEFAULT

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

See Also:

Constant Field Values

Method Detail

addEditorSettingsListener

void addEditorSettingsListener(@NotNull
                               @NotNull EditorSettingsListener listener)

Adds a EditorSettingsListener to be notified of changes.

Parameters:

listener - the listener

removeEditorSettingsListener

void removeEditorSettingsListener(@NotNull
                                  @NotNull EditorSettingsListener listener)

Removes a EditorSettingsListener to be notified of changes.

Parameters:

listener - the listener

getArchDirectoryDefault

@NotNull
@NotNull java.io.File getArchDirectoryDefault()

Returns the default archetype directory.

Returns:

the default archetype directory

getMapsDirectoryDefault

@NotNull
@NotNull java.io.File getMapsDirectoryDefault()

Returns the default maps directory.

Returns:

the default maps directory

hasMediaDirectory

boolean hasMediaDirectory()

Returns whether a media directory is used.

Returns:

whether a media directory is used

getMediaDirectoryDefault

@NotNull
@NotNull java.io.File getMediaDirectoryDefault()

Returns the default media directory.

Returns:

the default media directory

hasImageSet

boolean hasImageSet()

Returns whether an image set is used.

Returns:

whether an image set is used

getImageSetDefault

@NotNull
@NotNull java.lang.String getImageSetDefault()

Returns the default image set.

Returns:

the default image set

isShowMainToolbar

boolean isShowMainToolbar()

Returns whether the main toolbar should be shown.

Returns:

whether the main toolbar should be shown

setShowMainToolbar

void setShowMainToolbar(boolean selected)

Sets whether the main toolbar should be shown.

Parameters:

selected - whether the main toolbar should be shown

getUserNameDefault

@NotNull
@NotNull java.lang.String getUserNameDefault()

Returns the default user name.

Returns:

the default user name

getKey

java.lang.String getKey(@NotNull
                        @NotNull EditorSettingsKey key,
                        @NotNull
                        @NotNull java.lang.String defaultValue)

Returns a settings value.

Parameters:

key - the settings key

defaultValue - the default value if the key is unset

Returns:

the settings value

setKey

void setKey(@NotNull
            @NotNull EditorSettingsKey key,
            @NotNull
            @NotNull java.lang.String value)

Saves a settings value.

Parameters:

key - the settings key

value - the settings value