IGUIPlugin (jaicore-algorithminspector 0.2.1 API)

All Known Subinterfaces:

IComputedGUIPlugin

All Known Implementing Classes:

ASimpleMVCPlugin, ControlBarGUIPlugin, GraphViewPlugin, NodeInfoGUIPlugin, SolutionPerformanceTimelinePlugin, SpeedSliderGUIPlugin, TimeSliderGUIPlugin
```
public interface IGUIPlugin
```
IGUIPlugins can be used to display information about an IAlgorithm or its behavior in an AlgorithmVisualizationWindow. Such a plugin consists of an IGUIPluginController responsible for handling GUIEvents provided by the underlying window and IPropertyProcessedAlgorithmEvents which are constructed from the IAlgorithmEvents provided by the underlying IAlgorithm based on the information computed by AlgorithmEventPropertyComputers. Furthermore, an IGUIPlugin has an IGUIPluginModel which serves as the model for the actual view, i.e. the IGUIPluginView, which is the last part of such a plugin. The IGUIPluginView is responsible for creating the actually displayable content.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`IGUIPluginController`	`getController()`	Returns the underlying `IGUIPluginController`.
`IGUIPluginModel`	`getModel()`	Returns the underlying `IGUIPluginModel`.
`IGUIPluginView`	`getView()`	Returns the underlying `IGUIPluginView`.
`void`	`setAlgorithmEventSource(PropertyProcessedAlgorithmEventSource propertyProcessedAlgorithmEventSource)`	Sets the `PropertyProcessedAlgorithmEventSource` yielding `IPropertyProcessedAlgorithmEvent`s which are handled by the `IGUIPluginController`.
`void`	`setGUIEventSource(GUIEventSource guiEventSource)`	Sets the `GUIEventSource` yielding `GUIEvent`s which are handled by the `IGUIPluginController`.
`void`	`stop()`	Stops execution of all threads in this plugin (irrevocable).

- Method Detail
  - getController
```
IGUIPluginController getController()
```
    Returns the underlying IGUIPluginController.
    
    Returns:
    
    The underlying IGUIPluginController.
  - getModel
```
IGUIPluginModel getModel()
```
    Returns the underlying IGUIPluginModel.
    
    Returns:
    
    The underlying IGUIPluginModel.
  - getView
```
IGUIPluginView getView()
```
    Returns the underlying IGUIPluginView.
    
    Returns:
    
    The underlying IGUIPluginView.
  - setAlgorithmEventSource
```
void setAlgorithmEventSource(PropertyProcessedAlgorithmEventSource propertyProcessedAlgorithmEventSource)
```
    Sets the PropertyProcessedAlgorithmEventSource yielding IPropertyProcessedAlgorithmEvents which are handled by the IGUIPluginController.
    
    Parameters:
    
    propertyProcessedAlgorithmEventSource - The PropertyProcessedAlgorithmEventSource yielding IPropertyProcessedAlgorithmEvents which are handled by the IGUIPluginController.
  - setGUIEventSource
```
void setGUIEventSource(GUIEventSource guiEventSource)
```
    Sets the GUIEventSource yielding GUIEvents which are handled by the IGUIPluginController.
    
    Parameters:
    
    guiEventSource - The GUIEventSource yielding GUIEvents which are handled by the IGUIPluginController.
  - stop
```
void stop()
```
    Stops execution of all threads in this plugin (irrevocable).