net.sf.gridarta.gui.dialog.plugin

Class PluginEditor<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.PluginEditor<G,A,R>

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

Constructor Summary

Constructors

Constructor and Description
PluginEditor(@NotNull Plugin<G,A,R> plugin, @NotNull PluginController<G,A,R> pluginController, @NotNull PluginModel<G,A,R> pluginModel, @NotNull PluginParameterViewFactory<G,A,R> pluginParameterViewFactory, @NotNull ResourceIcons resourceIcons) Creates a visual JComponent used to edit the given script.

Method Summary

Modifier and Type	Method and Description
@NotNull java.awt.Component	getComponent() Returns the Component for this plugin editor.
boolean	isPluginEditorIsAutoRun() Action method for option to run the editor script automatically.
boolean	isPluginIsEditorFilter() Action method for option to make an editor script a map filter.
boolean	isPluginIsScript() Action method for option to add an editor script to the plugins menu.
void	pluginEditorAddParameter() Action method to add a parameter to the current plugin script.
void	pluginEditorExport() Action method to export the current plugin as an XML file.
void	pluginEditorRemoveParameter() Action method to remove the selected parameter from the current plugin script.
void	pluginEditorReRegister() Action method to re-register the current plugin.
void	pluginEditorRunScript() Action method to execute the selected plugin script.
void	setPluginEditorIsAutoRun(boolean autoRun) Action method for option to run the editor script automatically.
void	setPluginIsEditorFilter(boolean filter) Action method for option to run the editor script automatically.
void	setPluginIsScript(boolean script) Action method for option to add the script to the plugins menu.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginEditor

public PluginEditor(@NotNull
                    @NotNull Plugin<G,A,R> plugin,
                    @NotNull
                    @NotNull PluginController<G,A,R> pluginController,
                    @NotNull
                    @NotNull PluginModel<G,A,R> pluginModel,
                    @NotNull
                    @NotNull PluginParameterViewFactory<G,A,R> pluginParameterViewFactory,
                    @NotNull
                    @NotNull ResourceIcons resourceIcons)

Creates a visual JComponent used to edit the given script.

Parameters:

plugin - the script object to edit

pluginController - the associated script control instance

resourceIcons - the resource icons for creating icons

Method Detail

getComponent

@NotNull
public @NotNull java.awt.Component getComponent()

Returns the Component for this plugin editor.

Returns:

the component

isPluginEditorIsAutoRun

@ActionMethod
public boolean isPluginEditorIsAutoRun()

Action method for option to run the editor script automatically.

Returns:

whether auto-run is enabled

setPluginEditorIsAutoRun

@ActionMethod
public void setPluginEditorIsAutoRun(boolean autoRun)

Action method for option to run the editor script automatically.

Parameters:

autoRun - whether auto-run is enabled

isPluginIsEditorFilter

@ActionMethod
public boolean isPluginIsEditorFilter()

Action method for option to make an editor script a map filter.

Returns:

whether the editor script is a map filter

setPluginIsEditorFilter

@ActionMethod
public void setPluginIsEditorFilter(boolean filter)

Action method for option to run the editor script automatically.

Parameters:

filter - whether the editor script is a filter

isPluginIsScript

@ActionMethod
public boolean isPluginIsScript()

Action method for option to add an editor script to the plugins menu.

Returns:

whether the editor script should be added to the plugins menu

setPluginIsScript

@ActionMethod
public void setPluginIsScript(boolean script)

Action method for option to add the script to the plugins menu.

Parameters:

script - whether the editor script should be added to the plugins menu

pluginEditorReRegister

@ActionMethod
public void pluginEditorReRegister()

Action method to re-register the current plugin.

pluginEditorExport

@ActionMethod
public void pluginEditorExport()

Action method to export the current plugin as an XML file.

pluginEditorAddParameter

@ActionMethod
public void pluginEditorAddParameter()

Action method to add a parameter to the current plugin script.

pluginEditorRemoveParameter

@ActionMethod
public void pluginEditorRemoveParameter()

Action method to remove the selected parameter from the current plugin script.

pluginEditorRunScript

@ActionMethod
public void pluginEditorRunScript()

Action method to execute the selected plugin script.