A factory to create editor-dependent objects. More...

Inheritance diagram for net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Collaboration diagram for net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions
PreferencesGroup	createPreferencesGroup (@NotNull ProjectSettings projectSettings, @NotNull EditorSettings editorSettings, @NotNull DelegatingMapValidator< G, A, R > validators, @NotNull AppPreferencesModel appPreferencesModel, @NotNull ExitConnectorModel exitConnectorModel, @NotNull ConfigSourceFactory configSourceFactory)
	Creates a new PreferencesGroup instance. More...

CacheFiles	getCacheFiles ()
	Returns the cache files for icon and preview images. More...

String	getCompassIconName ()
	Returns the icon name to display in the selected square view. More...

Direction []	getDirectionMap ()
	Returns a map of relative direction to map window direction. More...

String	getGridartaJarFilename ()
	Returns the filename of the editor's .jar file. More...

int []	getLockedItemsTypeNumbers ()
	Returns the type numbers of game objects being locked items. More...

FileFilter	getMapFileFilter ()
	Returns the file filter for map files. More...

String	getScriptExtension ()
	Returns the extension for script files. More...

FileFilter	getScriptFileFilter ()
	Returns the FileFilter for script files. More...

String	getScriptName ()
	Returns the display name for script files. More...

int	getUndefinedSpellIndex ()
	Returns the index for "no spell". More...

boolean	isAllowRandomMapParameters ()
	Returns whether exit paths may point to random map parameters. More...

boolean	isAutoValidatorDefault ()
	Returns whether the auto validator is enabled by default. More...

boolean	isCreateDirectionPane ()
	Returns whether the direction panel should be created. More...

MapPropertiesDialogFactory< G, A, R >	newMapPropertiesDialogFactory (@NotNull ProjectSettings projectSettings, @NotNull MapManager< G, A, R > mapManager)
	Creates a new MapPropertiesDialogFactory instance. More...

MapViewFactory< G, A, R >	newMapViewFactory (@NotNull RendererFactory< G, A, R > rendererFactory, @NotNull PathManager pathManager)
	Creates a new MapViewFactory instance. More...

NewMapDialogFactory< G, A, R >	newNewMapDialogFactory (@NotNull MapViewsManager< G, A, R > mapViewsManager, @NotNull MapArchObjectFactory< A > mapArchObjectFactory, @NotNull PickmapChooserView< G, A, R > pickmapChooserView, @NotNull Component parent)
	Creates a new NewMapDialogFactory instance. More...

ProjectSettings	newProjectSettings (@NotNull EditorSettings editorSettings)
	Creates a new ProjectSettings instance. More...

RendererFactory< G, A, R >	newRendererFactory (@NotNull MapViewSettings mapViewSettings, @NotNull FilterControl< G, A, R > filterControl, @NotNull GameObjectParser< G, A, R > gameObjectParser, @NotNull FaceObjectProviders faceObjectProviders, @NotNull ResourceIcons resourceIcons, @NotNull SmoothFaces smoothFaces)
	Creates a new RendererFactory instance. More...

ScriptArchData< G, A, R >	newScriptArchData ()
	Creates a new ScriptArchData instance. More...

ScriptArchDataUtils< G, A, R >	newScriptArchDataUtils (@NotNull ScriptArchUtils scriptArchUtils, @NotNull ScriptedEventFactory< G, A, R > scriptedEventFactory, @NotNull ScriptedEventEditor< G, A, R > scriptedEventEditor)
	Creates a new ScriptArchDataUtils instance. More...

ScriptArchUtils	newScriptArchUtils (@NotNull ArchetypeTypeList eventTypes)
	Creates a new ScriptArchUtils instance. More...

ScriptedEventFactory< G, A, R >	newScriptedEventFactory (@NotNull ScriptArchUtils scriptArchUtils, @NotNull GameObjectFactory< G, A, R > gameObjectFactory, @NotNull ScriptedEventEditor< G, A, R > scriptedEventEditor, @NotNull ArchetypeSet< G, A, R > archetypeSet)
	Creates a new ScriptedEventFactory instance. More...

EditorAction	newServerActions (@NotNull FileControl< G, A, R > fileControl)
	Creates the "open in client" action. More...

Public Member Functions inherited from net.sf.gridarta.project.ProjectFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >
int	getDoubleFaceOffset ()
	Returns the offset for drawing double faces. More...

boolean	getIncludeFaceNumbers ()
	Returns whether the face file contains face numbers. More...

String	getScriptsDir ()
	Returns the default directory for editor scripts. More...

String	getSpellFile ()
	Returns the spell file name to load. More...

int	getSpellType ()
	Returns the archetype type for game object spells. More...

AttributeRangeChecker< G, A, R >	loadAttributeRangeChecker (@NotNull ErrorViewCollector errorViewCollector, @NotNull GameObjectMatchers gameObjectMatchers, @NotNull ValidatorPreferences validatorPreferences)
	Loads the attribute range checker for map validation. More...

ArchetypeFactory< G, A, R >	newArchetypeFactory (@NotNull FaceObjectProviders faceObjectProviders, @NotNull AnimationObjects animationObjects)
	Creates a new ArchetypeFactory instance. More...

AbstractArchetypeParser< G, A, R, ?>	newArchetypeParser (@NotNull ErrorView errorView, GameObjectParser< G, A, R > gameObjectParser, AnimationObjects animationObjects, ArchetypeSet< G, A, R > archetypeSet, @NotNull GameObjectFactory< G, A, R > gameObjectFactory, @NotNull ProjectSettings projectSettings, @NotNull SmoothFaces smoothFaces)
	Creates a new AbstractArchetypeParser instance. More...

ArchetypeSet< G, A, R >	newArchetypeSet (@NotNull ProjectSettings projectSettings, @NotNull ArchetypeFactory< G, A, R > archetypeFactory)
	Creates a new ArchetypeSet instance. More...

GameObjectFactory< G, A, R >	newGameObjectFactory (@NotNull FaceObjectProviders faceObjectProviders, @NotNull AnimationObjects animationObjects, @NotNull ArchetypeTypeSet archetypeTypeSet)
	Creates a new GameObjectFactory instance. More...

GameObjectParserFactory< G, A, R >	newGameObjectParserFactory (@NotNull GameObjectFactory< G, A, R > gameObjectFactory, @NotNull ArchetypeSet< G, A, R > archetypeSet, @NotNull ArchetypeTypeSet archetypeTypeSet)
	Creates a new GameObjectParserFactory instance. More...

MapArchObjectFactory< A >	newMapArchObjectFactory (@NotNull ProjectSettings projectSettings)
	Creates a new MapArchObjectFactory instance. More...

MapArchObjectParserFactory< A >	newMapArchObjectParserFactory ()
	Creates a new MapArchObjectParserFactory instance. More...

MapControlFactory< G, A, R >	newMapControlFactory (@NotNull MapWriter< G, A, R > mapWriter, @NotNull ProjectSettings projectSettings, @NotNull MapModelFactory< G, A, R > mapModelFactory)
	Creates a new MapControlFactory instance. More...

AbstractResources< G, A, R >	newResources (@NotNull GameObjectParser< G, A, R > gameObjectParser, @NotNull ArchetypeSet< G, A, R > archetypeSet, @NotNull AbstractArchetypeParser< G, A, R, ?> archetypeParser, @NotNull FaceObjects faceObjects, @NotNull AnimationObjects animationObjects, @NotNull ArchFaceProvider archFaceProvider, @NotNull FaceObjectProviders faceObjectProviders, @NotNull SmoothFaces smoothFaces)
	Creates a new AbstractResources instance. More...

Detailed Description

A factory to create editor-dependent objects.

Author: Andreas Kirschbaum

Definition at line 69 of file EditorFactory.java.

Member Function Documentation

◆ createPreferencesGroup()

PreferencesGroup net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.createPreferencesGroup	(	@NotNull ProjectSettings	projectSettings,
		@NotNull EditorSettings	editorSettings,
		@NotNull DelegatingMapValidator< G, A, R >	validators,
		@NotNull AppPreferencesModel	appPreferencesModel,
		@NotNull ExitConnectorModel	exitConnectorModel,
		@NotNull ConfigSourceFactory	configSourceFactory
	)

Creates a new PreferencesGroup instance.

Parameters

projectSettings	the project settings to use
editorSettings	the editor settings to use
validators	the validators to use
appPreferencesModel	the app preferences model to use
exitConnectorModel	the exit connector model to use
configSourceFactory	the config source factory to use

Returns: the new instance

Referenced by net.sf.gridarta.action.OptionsAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.options().

Here is the caller graph for this function:

◆ getCacheFiles()

CacheFiles net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getCacheFiles ( )

Returns the cache files for icon and preview images.

Returns: the cache files

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ getCompassIconName()

String net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getCompassIconName ( )

Returns the icon name to display in the selected square view.

Returns: the icon name or
null
to display no icon

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ getDirectionMap()

Direction [] net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getDirectionMap ( )

Returns a map of relative direction to map window direction.

Returns: the map

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ getGridartaJarFilename()

String net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getGridartaJarFilename ( )

Returns the filename of the editor's .jar file.

Returns: the filename

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ getLockedItemsTypeNumbers()

int [] net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getLockedItemsTypeNumbers ( )

Returns the type numbers of game objects being locked items.

Returns: the type numbers

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ getMapFileFilter()

FileFilter net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMapFileFilter ( )

Returns the file filter for map files.

Returns: the file filter for map files

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ getScriptExtension()

String net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getScriptExtension ( )

Returns the extension for script files.

Returns: the extension

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ getScriptFileFilter()

FileFilter net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getScriptFileFilter ( )

Returns the FileFilter for script files.

Returns: the file filter

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ getScriptName()

String net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getScriptName ( )

Returns the display name for script files.

Returns: the display name

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ getUndefinedSpellIndex()

int net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getUndefinedSpellIndex ( )

Returns the index for "no spell".

Returns: tne index

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ isAllowRandomMapParameters()

boolean net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isAllowRandomMapParameters ( )

Returns whether exit paths may point to random map parameters.

Returns: whether exit paths may point to random map parameters

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ isAutoValidatorDefault()

boolean net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isAutoValidatorDefault ( )

Returns whether the auto validator is enabled by default.

Returns: whether the auto validator is enabled by default

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ isCreateDirectionPane()

boolean net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isCreateDirectionPane ( )

Returns whether the direction panel should be created.

Returns: whether the direction panel should be created

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ newMapPropertiesDialogFactory()

MapPropertiesDialogFactory<G, A, R> net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newMapPropertiesDialogFactory	(	@NotNull ProjectSettings	projectSettings,
		@NotNull MapManager< G, A, R >	mapManager
	)

Creates a new MapPropertiesDialogFactory instance.

Parameters

projectSettings	the project settings to use
mapManager	the map manager to use

Returns: the new instance

◆ newMapViewFactory()

MapViewFactory<G, A, R> net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newMapViewFactory	(	@NotNull RendererFactory< G, A, R >	rendererFactory,
		@NotNull PathManager	pathManager
	)

Creates a new MapViewFactory instance.

Parameters

rendererFactory	the renderer factory to use
pathManager	the path manager for converting path names view factories

Returns: the new instance

◆ newNewMapDialogFactory()

NewMapDialogFactory<G, A, R> net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newNewMapDialogFactory	(	@NotNull MapViewsManager< G, A, R >	mapViewsManager,
		@NotNull MapArchObjectFactory< A >	mapArchObjectFactory,
		@NotNull PickmapChooserView< G, A, R >	pickmapChooserView,
		@NotNull Component	parent
	)

Creates a new NewMapDialogFactory instance.

Parameters

mapViewsManager	the map views
mapArchObjectFactory	the map arch object factory instance
pickmapChooserView	the pickmap chooser view for creating new pickmaps
parent	the parent component of the dialogs

Returns: the new new map dialog factory instance

◆ newProjectSettings()

ProjectSettings net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newProjectSettings ( @NotNull EditorSettings editorSettings )

Creates a new ProjectSettings instance.

Parameters

editorSettings the editor settings instance for default values

Returns: the new instance

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ newRendererFactory()

RendererFactory<G, A, R> net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newRendererFactory	(	@NotNull MapViewSettings	mapViewSettings,
		@NotNull FilterControl< G, A, R >	filterControl,
		@NotNull GameObjectParser< G, A, R >	gameObjectParser,
		@NotNull FaceObjectProviders	faceObjectProviders,
		@NotNull ResourceIcons	resourceIcons,
		@NotNull SmoothFaces	smoothFaces
	)

Creates a new RendererFactory instance.

Parameters

mapViewSettings	the map view settings to use
filterControl	the filter control to use
gameObjectParser	the game object parser for creating tooltip information
faceObjectProviders	the face object providers for looking up faces
resourceIcons	the resource icons for creating icons
smoothFaces	the smooth faces to use

Returns: the new instance

◆ newScriptArchData()

ScriptArchData<G, A, R> net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newScriptArchData ( )

Creates a new ScriptArchData instance.

Returns: the new instance

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ newScriptArchDataUtils()

ScriptArchDataUtils<G, A, R> net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newScriptArchDataUtils	(	@NotNull ScriptArchUtils	scriptArchUtils,
		@NotNull ScriptedEventFactory< G, A, R >	scriptedEventFactory,
		@NotNull ScriptedEventEditor< G, A, R >	scriptedEventEditor
	)

Creates a new ScriptArchDataUtils instance.

Parameters

scriptArchUtils	the script arch utils to use
scriptedEventFactory	the scripted event factory to use
scriptedEventEditor	the scripted event editor to use

Returns: the new instance

◆ newScriptArchUtils()

ScriptArchUtils net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newScriptArchUtils ( @NotNull ArchetypeTypeList eventTypes )

Creates a new ScriptArchUtils instance.

Parameters

eventTypes the event types to use

Returns: the new instance

Implemented in net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory, net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory, and net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.

◆ newScriptedEventFactory()

ScriptedEventFactory<G, A, R> net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newScriptedEventFactory	(	@NotNull ScriptArchUtils	scriptArchUtils,
		@NotNull GameObjectFactory< G, A, R >	gameObjectFactory,
		@NotNull ScriptedEventEditor< G, A, R >	scriptedEventEditor,
		@NotNull ArchetypeSet< G, A, R >	archetypeSet
	)

Creates a new ScriptedEventFactory instance.

Parameters

scriptArchUtils	the script arch utils to use
gameObjectFactory	the game object factory for creating game objects
scriptedEventEditor	the scripted event editor to use
archetypeSet	the archetype set to use

Returns: the new instance

◆ newServerActions()

EditorAction net.sf.gridarta.maincontrol.EditorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newServerActions ( @NotNull FileControl< G, A, R > fileControl )

Creates the "open in client" action.

Does nothing if this editor does not support this action.

Parameters

fileControl the file control for saving maps

Returns: the action or
null

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

gridarta-gridarta/src/gridarta/src/main/java/net/sf/gridarta/maincontrol/EditorFactory.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ createPreferencesGroup()

◆ getCacheFiles()

◆ getCompassIconName()

◆ getDirectionMap()

◆ getGridartaJarFilename()

◆ getLockedItemsTypeNumbers()

◆ getMapFileFilter()

◆ getScriptExtension()

◆ getScriptFileFilter()

◆ getScriptName()

◆ getUndefinedSpellIndex()

◆ isAllowRandomMapParameters()

◆ isAutoValidatorDefault()

◆ isCreateDirectionPane()

◆ newMapPropertiesDialogFactory()

◆ newMapViewFactory()

◆ newNewMapDialogFactory()

◆ newProjectSettings()

◆ newRendererFactory()

◆ newScriptArchData()

◆ newScriptArchDataUtils()

◆ newScriptArchUtils()

◆ newScriptedEventFactory()

◆ newServerActions()