net.sf.gridarta.maincontrol

Interface EditorFactory<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

All Superinterfaces:

ProjectFactory<G,A,R>

All Known Implementing Classes:

DefaultEditorFactory, DefaultEditorFactory, DefaultEditorFactory

public interface EditorFactory<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends ProjectFactory<G,A,R>

A factory to create editor-dependent objects.

Method Summary

Modifier and Type	Method and Description
@NotNull net.sf.japi.swing.prefs.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.
@NotNull CacheFiles	getCacheFiles() Returns the cache files for icon and preview images.
@Nullable java.lang.String	getCompassIconName() Returns the icon name to display in the selected square view.
@NotNull Direction[]	getDirectionMap() Returns a map of relative direction to map window direction.
@NotNull java.lang.String	getGridartaJarFilename() Returns the filename of the editor's .jar file.
int[]	getLockedItemsTypeNumbers() Returns the type numbers of game objects being locked items.
@NotNull javax.swing.filechooser.FileFilter	getMapFileFilter() Returns the file filter for map files.
@NotNull java.lang.String	getScriptExtension() Returns the extension for script files.
@NotNull javax.swing.filechooser.FileFilter	getScriptFileFilter() Returns the FileFilter for script files.
@NotNull java.lang.String	getScriptName() Returns the display name for script files.
int	getUndefinedSpellIndex() Returns the index for "no spell".
boolean	isAllowRandomMapParameters() Returns whether exit paths may point to random map parameters.
boolean	isAutoValidatorDefault() Returns whether the auto validator is enabled by default.
boolean	isCreateDirectionPane() Returns whether the direction panel should be created.
@NotNull MapPropertiesDialogFactory<G,A,R>	newMapPropertiesDialogFactory(@NotNull ProjectSettings projectSettings, @NotNull MapManager<G,A,R> mapManager) Creates a new MapPropertiesDialogFactory instance.
@NotNull MapViewFactory<G,A,R>	newMapViewFactory(@NotNull RendererFactory<G,A,R> rendererFactory, @NotNull PathManager pathManager) Creates a new MapViewFactory instance.
@NotNull NewMapDialogFactory<G,A,R>	newNewMapDialogFactory(@NotNull MapViewsManager<G,A,R> mapViewsManager, @NotNull MapArchObjectFactory<A> mapArchObjectFactory, @NotNull PickmapChooserView<G,A,R> pickmapChooserView, @NotNull java.awt.Component parent) Creates a new NewMapDialogFactory instance.
@NotNull ProjectSettings	newProjectSettings(@NotNull EditorSettings editorSettings) Creates a new ProjectSettings instance.
@NotNull 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.
@NotNull ScriptArchData<G,A,R>	newScriptArchData() Creates a new ScriptArchData instance.
@NotNull 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.
@NotNull ScriptArchUtils	newScriptArchUtils(@NotNull ArchetypeTypeList eventTypes) Creates a new ScriptArchUtils instance.
@NotNull 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.
@Nullable EditorAction	newServerActions(@NotNull FileControl<G,A,R> fileControl) Creates the "open in client" action.

Methods inherited from interface net.sf.gridarta.project.ProjectFactory

getDoubleFaceOffset, getIncludeFaceNumbers, getScriptsDir, getSpellFile, getSpellType, loadAttributeRangeChecker, newArchetypeFactory, newArchetypeParser, newArchetypeSet, newGameObjectFactory, newGameObjectParserFactory, newMapArchObjectFactory, newMapArchObjectParserFactory, newMapControlFactory, newResources

Method Detail

newProjectSettings

@NotNull
@NotNull ProjectSettings newProjectSettings(@NotNull
                                                     @NotNull EditorSettings editorSettings)

Creates a new ProjectSettings instance.

Parameters:

editorSettings - the editor settings instance for default values

Returns:

the new instance

newScriptArchUtils

@NotNull
@NotNull ScriptArchUtils newScriptArchUtils(@NotNull
                                                     @NotNull ArchetypeTypeList eventTypes)

Creates a new ScriptArchUtils instance.

Parameters:

eventTypes - the event types to use

Returns:

the new instance

newScriptedEventFactory

@NotNull
@NotNull ScriptedEventFactory<G,A,R> newScriptedEventFactory(@NotNull
                                                                      @NotNull ScriptArchUtils scriptArchUtils,
                                                                      @NotNull
                                                                      @NotNull GameObjectFactory<G,A,R> gameObjectFactory,
                                                                      @NotNull
                                                                      @NotNull ScriptedEventEditor<G,A,R> scriptedEventEditor,
                                                                      @NotNull
                                                                      @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

newScriptArchData

@NotNull
@NotNull ScriptArchData<G,A,R> newScriptArchData()

Creates a new ScriptArchData instance.

Returns:

the new instance

newScriptArchDataUtils

@NotNull
@NotNull ScriptArchDataUtils<G,A,R> newScriptArchDataUtils(@NotNull
                                                                    @NotNull ScriptArchUtils scriptArchUtils,
                                                                    @NotNull
                                                                    @NotNull ScriptedEventFactory<G,A,R> scriptedEventFactory,
                                                                    @NotNull
                                                                    @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

newRendererFactory

@NotNull
@NotNull RendererFactory<G,A,R> newRendererFactory(@NotNull
                                                            @NotNull MapViewSettings mapViewSettings,
                                                            @NotNull
                                                            @NotNull FilterControl<G,A,R> filterControl,
                                                            @NotNull
                                                            @NotNull GameObjectParser<G,A,R> gameObjectParser,
                                                            @NotNull
                                                            @NotNull FaceObjectProviders faceObjectProviders,
                                                            @NotNull
                                                            @NotNull ResourceIcons resourceIcons,
                                                            @NotNull
                                                            @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

newMapViewFactory

@NotNull
@NotNull MapViewFactory<G,A,R> newMapViewFactory(@NotNull
                                                          @NotNull RendererFactory<G,A,R> rendererFactory,
                                                          @NotNull
                                                          @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

newMapPropertiesDialogFactory

@NotNull
@NotNull MapPropertiesDialogFactory<G,A,R> newMapPropertiesDialogFactory(@NotNull
                                                                                  @NotNull ProjectSettings projectSettings,
                                                                                  @NotNull
                                                                                  @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

newNewMapDialogFactory

@NotNull
@NotNull NewMapDialogFactory<G,A,R> newNewMapDialogFactory(@NotNull
                                                                    @NotNull MapViewsManager<G,A,R> mapViewsManager,
                                                                    @NotNull
                                                                    @NotNull MapArchObjectFactory<A> mapArchObjectFactory,
                                                                    @NotNull
                                                                    @NotNull PickmapChooserView<G,A,R> pickmapChooserView,
                                                                    @NotNull
                                                                    @NotNull java.awt.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

createPreferencesGroup

@NotNull
@NotNull net.sf.japi.swing.prefs.PreferencesGroup createPreferencesGroup(@NotNull
                                                                                  @NotNull ProjectSettings projectSettings,
                                                                                  @NotNull
                                                                                  @NotNull EditorSettings editorSettings,
                                                                                  @NotNull
                                                                                  @NotNull DelegatingMapValidator<G,A,R> validators,
                                                                                  @NotNull
                                                                                  @NotNull AppPreferencesModel appPreferencesModel,
                                                                                  @NotNull
                                                                                  @NotNull ExitConnectorModel exitConnectorModel,
                                                                                  @NotNull
                                                                                  @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

newServerActions

@Nullable
@Nullable EditorAction newServerActions(@NotNull
                                                  @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

getScriptFileFilter

@NotNull
@NotNull javax.swing.filechooser.FileFilter getScriptFileFilter()

Returns the FileFilter for script files.

Returns:

the file filter

getScriptExtension

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

Returns the extension for script files.

Returns:

the extension

getScriptName

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

Returns the display name for script files.

Returns:

the display name

isCreateDirectionPane

boolean isCreateDirectionPane()

Returns whether the direction panel should be created.

Returns:

whether the direction panel should be created

getUndefinedSpellIndex

int getUndefinedSpellIndex()

Returns the index for "no spell".

Returns:

tne index

getCacheFiles

@NotNull
@NotNull CacheFiles getCacheFiles()

Returns the cache files for icon and preview images.

Returns:

the cache files

getDirectionMap

@NotNull
@NotNull Direction[] getDirectionMap()

Returns a map of relative direction to map window direction.

Returns:

the map

isAllowRandomMapParameters

boolean isAllowRandomMapParameters()

Returns whether exit paths may point to random map parameters.

Returns:

whether exit paths may point to random map parameters

getCompassIconName

@Nullable
@Nullable java.lang.String getCompassIconName()

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

Returns:

the icon name or null to display no icon

getGridartaJarFilename

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

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

Returns:

the filename

getMapFileFilter

@NotNull
@NotNull javax.swing.filechooser.FileFilter getMapFileFilter()

Returns the file filter for map files.

Returns:

the file filter for map files

getLockedItemsTypeNumbers

int[] getLockedItemsTypeNumbers()

Returns the type numbers of game objects being locked items.

Returns:

the type numbers

isAutoValidatorDefault

boolean isAutoValidatorDefault()

Returns whether the auto validator is enabled by default.

Returns:

whether the auto validator is enabled by default