Preferences Module for resource preferences. More...

Inheritance diagram for net.sf.gridarta.gui.dialog.prefs.ResPreferences:

Collaboration diagram for net.sf.gridarta.gui.dialog.prefs.ResPreferences:

Public Member Functions
void	apply ()

void	defaults ()

boolean	isChanged ()

	ResPreferences (@NotNull final ProjectSettings projectSettings, @NotNull final EditorSettings editorSettings, @NotNull final ConfigSourceFactory configSourceFactory)
	Creates a new instance. More...

void	revert ()

Private Member Functions
Component	buildImageSetBox ()
	Constructs the combo box for the selection of image sets. More...

Component	createGlobalPanel ()
	Creates the sub-panel with the editor settings. More...

Component	createResourcePanel ()
	Creates the sub-panel with the resource paths. More...

String	getCurrentImageSet ()
	Returns the name of the currently selected image set. More...

Static Private Member Functions
static String	convertImageSet (@Nullable final String imageSet)
	Returns a human readable name for a given image set. More...

static Border	createTitledBorder (final String titleKey)
	Creates a titled border. More...

Private Attributes
JFileField	archField
	TextField for arch directory path. More...

JComboBox< ConfigSource >	configSourceComboBox
	ComboBox for choosing the configuration source. More...

final ConfigSourceFactory	configSourceFactory
	The ConfigSourceFactory to use. More...

final EditorSettings	editorSettings
	The editor settings instance. More...

JComboBox< String >	imageSetBox
	ComboBox for choosing the image set. More...

String[]	imageSets
	Contains all supported image sets. More...

final ItemListener	itemListener
	The ItemListener attached to configSourceComboBox. More...

JFileField	mapField
	TextField for map directory path. More...

JFileField	mediaField
	TextField for media directory path. More...

final ProjectSettings	projectSettings
	The project settings instance. More...

Static Private Attributes
static final ActionBuilder	ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta")
	Action Builder. More...

static final long	serialVersionUID = 1L
	The serial version UID. More...

Detailed Description

Preferences Module for resource preferences.

Author: Christian Hujer; Andreas Kirschbaum @serial exclude

Definition at line 58 of file ResPreferences.java.

Constructor & Destructor Documentation

◆ ResPreferences()

net.sf.gridarta.gui.dialog.prefs.ResPreferences.ResPreferences	(	@NotNull final ProjectSettings	projectSettings,
		@NotNull final EditorSettings	editorSettings,
		@NotNull final ConfigSourceFactory	configSourceFactory
	)

Creates a new instance.

Parameters

projectSettings	the project settings instance
editorSettings	the editor settings instance
configSourceFactory	the config source factory to use

Definition at line 147 of file ResPreferences.java.

References net.sf.gridarta.gui.dialog.prefs.ResPreferences.ACTION_BUILDER, net.sf.gridarta.gui.dialog.prefs.ResPreferences.configSourceFactory, net.sf.gridarta.gui.dialog.prefs.ResPreferences.createGlobalPanel(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.createResourcePanel(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.editorSettings, net.sf.gridarta.utils.ActionBuilderUtils.getString(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.projectSettings.

Here is the call graph for this function:

Member Function Documentation

◆ apply()

void net.sf.gridarta.gui.dialog.prefs.ResPreferences.apply ( )

Definition at line 170 of file ResPreferences.java.

Here is the call graph for this function:

◆ buildImageSetBox()

Component net.sf.gridarta.gui.dialog.prefs.ResPreferences.buildImageSetBox ( )

private

Constructs the combo box for the selection of image sets.

Returns: the combo box with image sets to select

Definition at line 302 of file ResPreferences.java.

References net.sf.gridarta.gui.dialog.prefs.ResPreferences.ACTION_BUILDER, net.sf.gridarta.gui.dialog.prefs.ResPreferences.getCurrentImageSet(), net.sf.gridarta.utils.ActionBuilderUtils.getString(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.imageSetBox, net.sf.gridarta.gui.dialog.prefs.ResPreferences.imageSets, and net.sf.gridarta.utils.StringUtils.PATTERN_WHITESPACE.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.createGlobalPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ convertImageSet()

static String net.sf.gridarta.gui.dialog.prefs.ResPreferences.convertImageSet ( @Nullable final String imageSet )

staticprivate

Returns a human readable name for a given image set.

Parameters

imageSet the image set

Returns: the name

Definition at line 335 of file ResPreferences.java.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.getCurrentImageSet(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.isChanged().

Here is the caller graph for this function:

◆ createGlobalPanel()

Component net.sf.gridarta.gui.dialog.prefs.ResPreferences.createGlobalPanel ( )

private

Creates the sub-panel with the editor settings.

Returns: the sub-panel

Definition at line 276 of file ResPreferences.java.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.ResPreferences().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createResourcePanel()

Component net.sf.gridarta.gui.dialog.prefs.ResPreferences.createResourcePanel ( )

private

Creates the sub-panel with the resource paths.

Returns: sub-panel

Definition at line 252 of file ResPreferences.java.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.ResPreferences().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createTitledBorder()

static Border net.sf.gridarta.gui.dialog.prefs.ResPreferences.createTitledBorder ( final String titleKey )

staticprivate

Creates a titled border.

Parameters

titleKey the action key for border title

Returns: the titled border

Definition at line 165 of file ResPreferences.java.

References net.sf.gridarta.gui.dialog.prefs.ResPreferences.ACTION_BUILDER, net.sf.gridarta.gui.utils.GUIConstants.DIALOG_BORDER, and net.sf.gridarta.utils.ActionBuilderUtils.getString().

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.createGlobalPanel(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.createResourcePanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ defaults()

void net.sf.gridarta.gui.dialog.prefs.ResPreferences.defaults ( )

Definition at line 208 of file ResPreferences.java.

Here is the call graph for this function:

◆ getCurrentImageSet()

String net.sf.gridarta.gui.dialog.prefs.ResPreferences.getCurrentImageSet ( )

private

Returns the name of the currently selected image set.

Returns: the name or "disabled" if no image set is selected

Definition at line 325 of file ResPreferences.java.

References net.sf.gridarta.gui.dialog.prefs.ResPreferences.convertImageSet(), net.sf.gridarta.model.settings.ProjectSettings.getImageSet(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.projectSettings.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.buildImageSetBox(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.isChanged(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isChanged()

boolean net.sf.gridarta.gui.dialog.prefs.ResPreferences.isChanged ( )

Definition at line 226 of file ResPreferences.java.

References net.sf.gridarta.gui.dialog.prefs.ResPreferences.archField, net.sf.gridarta.gui.dialog.prefs.ResPreferences.configSourceComboBox, net.sf.gridarta.gui.dialog.prefs.ResPreferences.convertImageSet(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.editorSettings, net.sf.gridarta.model.settings.ProjectSettings.getArchDirectory(), net.sf.gridarta.model.settings.ProjectSettings.getConfigSourceName(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.getCurrentImageSet(), net.sf.gridarta.gui.utils.JFileField.getFile(), net.sf.gridarta.model.settings.ProjectSettings.getMapsDirectory(), net.sf.gridarta.model.settings.ProjectSettings.getMediaDirectory(), net.sf.gridarta.model.settings.EditorSettings.hasImageSet(), net.sf.gridarta.model.settings.EditorSettings.hasMediaDirectory(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.imageSetBox, net.sf.gridarta.gui.dialog.prefs.ResPreferences.mapField, net.sf.gridarta.gui.dialog.prefs.ResPreferences.mediaField, and net.sf.gridarta.gui.dialog.prefs.ResPreferences.projectSettings.

Here is the call graph for this function:

◆ revert()

void net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert ( )

Definition at line 189 of file ResPreferences.java.

Here is the call graph for this function:

Member Data Documentation

◆ ACTION_BUILDER

final ActionBuilder net.sf.gridarta.gui.dialog.prefs.ResPreferences.ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta")

staticprivate

Action Builder.

Definition at line 69 of file ResPreferences.java.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.apply(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.buildImageSetBox(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.createGlobalPanel(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.createResourcePanel(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.createTitledBorder(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.ResPreferences().

◆ archField

JFileField net.sf.gridarta.gui.dialog.prefs.ResPreferences.archField

private

TextField for arch directory path.

Definition at line 93 of file ResPreferences.java.

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.createResourcePanel(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.defaults(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.isChanged(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert().

◆ configSourceComboBox

JComboBox<ConfigSource> net.sf.gridarta.gui.dialog.prefs.ResPreferences.configSourceComboBox

private

ComboBox for choosing the configuration source.

Definition at line 111 of file ResPreferences.java.

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(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert().

◆ configSourceFactory

final ConfigSourceFactory net.sf.gridarta.gui.dialog.prefs.ResPreferences.configSourceFactory

private

The ConfigSourceFactory to use.

Definition at line 87 of file ResPreferences.java.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.createGlobalPanel(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.defaults(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.ResPreferences(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert().

◆ editorSettings

final EditorSettings net.sf.gridarta.gui.dialog.prefs.ResPreferences.editorSettings

private

The editor settings instance.

Definition at line 81 of file ResPreferences.java.

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.createResourcePanel(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.defaults(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.isChanged(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.ResPreferences(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert().

◆ imageSetBox

JComboBox<String> net.sf.gridarta.gui.dialog.prefs.ResPreferences.imageSetBox

private

ComboBox for choosing the image set.

Definition at line 117 of file ResPreferences.java.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.apply(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.buildImageSetBox(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.defaults(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.isChanged(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert().

◆ imageSets

String [] net.sf.gridarta.gui.dialog.prefs.ResPreferences.imageSets

private

Contains all supported image sets.

Definition at line 123 of file ResPreferences.java.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.buildImageSetBox(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.defaults(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert().

◆ itemListener

final ItemListener net.sf.gridarta.gui.dialog.prefs.ResPreferences.itemListener

private

Initial value:

= new ItemListener() {
 
        @Override
        public void itemStateChanged(final ItemEvent e) {
            if (e.getStateChange() == ItemEvent.SELECTED) {
                final ConfigSource configSource = (ConfigSource) e.getItem();
                archField.setEnabled(configSource.isArchDirectoryInputFieldEnabled());
            }
        }
 
    }

The ItemListener attached to configSourceComboBox.

Definition at line 129 of file ResPreferences.java.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.createGlobalPanel().

◆ mapField

JFileField net.sf.gridarta.gui.dialog.prefs.ResPreferences.mapField

private

TextField for map directory path.

Definition at line 99 of file ResPreferences.java.

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(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert().

◆ mediaField

JFileField net.sf.gridarta.gui.dialog.prefs.ResPreferences.mediaField

private

TextField for media directory path.

Definition at line 105 of file ResPreferences.java.

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(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert().

◆ projectSettings

final ProjectSettings net.sf.gridarta.gui.dialog.prefs.ResPreferences.projectSettings

private

The project settings instance.

Definition at line 75 of file ResPreferences.java.

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.createResourcePanel(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.getCurrentImageSet(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.isChanged(), net.sf.gridarta.gui.dialog.prefs.ResPreferences.ResPreferences(), and net.sf.gridarta.gui.dialog.prefs.ResPreferences.revert().

◆ serialVersionUID

final long net.sf.gridarta.gui.dialog.prefs.ResPreferences.serialVersionUID = 1L

staticprivate

The serial version UID.

Definition at line 63 of file ResPreferences.java.

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

src/gridarta/src/main/java/net/sf/gridarta/gui/dialog/prefs/ResPreferences.java

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ResPreferences()

Member Function Documentation

◆ apply()

◆ buildImageSetBox()

◆ convertImageSet()

◆ createGlobalPanel()

◆ createResourcePanel()

◆ createTitledBorder()

◆ defaults()

◆ getCurrentImageSet()

◆ isChanged()

◆ revert()

Member Data Documentation

◆ ACTION_BUILDER

◆ archField

◆ configSourceComboBox

◆ configSourceFactory

◆ editorSettings

◆ imageSetBox

◆ imageSets

◆ itemListener

◆ mapField

◆ mediaField

◆ projectSettings

◆ serialVersionUID