net.sf.gridarta.gui.dialog.plugin

Class PluginController<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

java.lang.Object

net.sf.gridarta.gui.dialog.plugin.PluginController<G,A,R>

All Implemented Interfaces:

EditorAction

public class PluginController<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object
implements EditorAction

Controller for plugins.

Todo:

documentation

Constructor Summary

Constructors

Constructor and Description
PluginController(FilterControl<G,A,R> filterControl, PluginModel<G,A,R> pluginModel, PluginParameters pluginParameters, java.awt.Component parent, PluginParameterViewFactory<G,A,R> pluginParameterViewFactory, java.io.File pluginsDir, ResourceIcons resourceIcons) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	canExit() Prompts the user for all unsaved plugins.
javax.swing.Action	createRunAction(Plugin<G,A,R> plugin) Creates an action to run a plugin plugin.
PluginView<G,A,R>	getView()
void	runPlugin(Plugin<G,A,R> plugin)
void	runPlugin(java.lang.String name)
void	saveAllPlugins() Saves all modified plugins.
boolean	savePluginAs(Plugin<G,A,R> plugin, boolean updatePluginFile) Prompts the user for a file name to save a plugin.
void	setAction(javax.swing.Action action, java.lang.String name) Sets the Action instance for this editor action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginController

public PluginController(@NotNull
                        FilterControl<G,A,R> filterControl,
                        @NotNull
                        PluginModel<G,A,R> pluginModel,
                        @NotNull
                        PluginParameters pluginParameters,
                        @NotNull
                        java.awt.Component parent,
                        @NotNull
                        PluginParameterViewFactory<G,A,R> pluginParameterViewFactory,
                        @NotNull
                        java.io.File pluginsDir,
                        @NotNull
                        ResourceIcons resourceIcons)

Creates a new instance.

Method Detail

canExit

public boolean canExit()

Prompts the user for all unsaved plugins.

Returns:

whether no unsaved plugins remain

saveAllPlugins

public void saveAllPlugins()

Saves all modified plugins. Does nothing if all plugins are unchanged.

savePluginAs

public boolean savePluginAs(@NotNull
                            Plugin<G,A,R> plugin,
                            boolean updatePluginFile)

Prompts the user for a file name to save a plugin. The plugin is saved regardless whether the plugin is modified or not.

Parameters:

plugin - the plugin to save

updatePluginFile - if set, update the plugin file to the save location

Returns:

whether the plugin has been saved

runPlugin

public void runPlugin(@NotNull
                      Plugin<G,A,R> plugin)

runPlugin

@ActionMethod
public void runPlugin(@NotNull
                                    java.lang.String name)

getView

@NotNull
public PluginView<G,A,R> getView()

createRunAction

@NotNull
public javax.swing.Action createRunAction(@NotNull
                                                   Plugin<G,A,R> plugin)

Creates an action to run a plugin plugin.

Parameters:

plugin - the plugin to run

Returns:

the action

setAction

public void setAction(@NotNull
                      javax.swing.Action action,
                      @NotNull
                      java.lang.String name)

Sets the Action instance for this editor action.

Specified by:

setAction in interface EditorAction

Parameters:

action - the action instance

name - the name of the action