org.scijava.plugin

Interface SciJavaPlugin

All Known Subinterfaces:

App, AppEventService, AppService, ButtonWidget<U>, CacheService, ChoiceWidget<U>, ColorWidget<U>, Command, CommandService, ConsoleArgument, ConsoleService, Converter<I,O>, ConvertService, DataHandle<L>, DataHandleService, DateWidget<U>, Display<T>, DisplayService, DisplayViewer<T>, DragAndDropHandler<D>, DragAndDropService, EventHistory, EventService, FileWidget<U>, Gateway, HandlerPlugin<D>, HandlerService<DT,PT>, IconService, InputService, InputWidget<T,W>, IOPlugin<D>, IOService, LogService, MenuService, MessageWidget<U>, ModuleService, NumberWidget<U>, ObjectService, ObjectWidget<U>, OptionsService, Platform, PlatformService, PluginService, PostprocessorPlugin, PrefService, PreprocessorPlugin, PTService<PT>, RecentFileService, RichPlugin, SciJavaService, ScriptHeader, ScriptHeaderService, ScriptLanguage, ScriptService, Service, SingletonPlugin, SingletonService<PT>, StatusService, TextDisplay, TextDisplayViewer, TextFormat, TextService, TextWidget<U>, ThreadService, ToggleWidget<U>, Tool, ToolService, TypedPlugin<D>, TypedService<DT,PT>, UIService, UserInterface, WelcomeService, WidgetService, WrapperPlugin<D>, WrapperService<DT,PT>

All Known Implementing Classes:

AbstractApp, AbstractConsoleArgument, AbstractConverter, AbstractConvertService, AbstractDataHandle, AbstractDisplay, AbstractDisplayViewer, AbstractDragAndDropHandler, AbstractGateway, AbstractHandlerPlugin, AbstractHandlerService, AbstractInputHarvesterPlugin, AbstractInputWidget, AbstractIOPlugin, AbstractLogService, AbstractPlatform, AbstractPostprocessorPlugin, AbstractPrefService, AbstractPreprocessorPlugin, AbstractPTService, AbstractRichPlugin, AbstractScriptHeader, AbstractScriptLanguage, AbstractService, AbstractSingleInputPreprocessor, AbstractSingletonService, AbstractTextDisplayViewer, AbstractTextFormat, AbstractTool, AbstractTypedPlugin, AbstractTypedService, AbstractUIInputWidget, AbstractUserInterface, AbstractWrapperPlugin, AbstractWrapperService, ActiveDisplayPreprocessor, AdaptedScriptLanguage, ArrayConverters.BoolArrayUnwrapper, ArrayConverters.BoolArrayWrapper, ArrayConverters.ByteArrayUnwrapper, ArrayConverters.ByteArrayWrapper, ArrayConverters.CharArrayUnwrapper, ArrayConverters.CharArrayWrapper, ArrayConverters.DoubleArrayUnwrapper, ArrayConverters.DoubleArrayWrapper, ArrayConverters.FloatArrayUnwrapper, ArrayConverters.FloatArrayWrapper, ArrayConverters.IntArrayUnwrapper, ArrayConverters.IntArrayWrapper, ArrayConverters.LongArrayUnwrapper, ArrayConverters.LongArrayWrapper, ArrayConverters.ShortArrayUnwrapper, ArrayConverters.ShortArrayWrapper, CheckInputsPreprocessor, ContextCommand, DebugPostprocessor, DebugPreprocessor, DefaultAppEventService, DefaultAppService, DefaultCacheService, DefaultCommandService, DefaultConsoleService, DefaultConverter, DefaultConvertService, DefaultDataHandleService, DefaultDisplay, DefaultDisplayService, DefaultDragAndDropService, DefaultEventHistory, DefaultEventService, DefaultInputService, DefaultIOService, DefaultMenuService, DefaultModuleService, DefaultObjectService, DefaultOptionsService, DefaultPlatform, DefaultPlatformService, DefaultPluginService, DefaultPrefService, DefaultRecentFileService, DefaultScriptHeaderService, DefaultScriptService, DefaultStatusService, DefaultTextDisplay, DefaultTextService, DefaultThreadService, DefaultToolService, DefaultUIService, DefaultValuePreprocessor, DefaultWelcomeService, DefaultWidgetService, DisplayPostprocessor, DummyTool, DynamicCommand, FileDragAndDropHandler, FileHandle, FilePreprocessor, GatewayPreprocessor, InitPreprocessor, InteractiveCommand, ListDragAndDropHandler, LoadInputsPreprocessor, ModuleCommand, NullConverter, OpenArgument, OptionsPlugin, PrimitiveArrayUnwrapper, PrimitiveArrayWrapper, RunArgument, SaveInputsPreprocessor, SciJava, SciJavaApp, ScriptFileDragAndDropHandler, ScriptIOPlugin, ServicePreprocessor, SortablePlugin, StderrLogService, SystemPropertyArgument, TextIOPlugin, UIArgument, UIPreprocessor, UnimplementedCommand, ValidityPreprocessor

public interface SciJavaPlugin

Top-level interface for plugins. Plugins discoverable at runtime must implement this interface and be annotated with @Plugin.

What all plugins have in common is that they are declared using an annotation (@Plugin), and discovered if present on the classpath at runtime.

The core types of plugins are as follows:

• Command - plugins that are executable. These plugins typically perform a discrete operation, and are accessible via the application menus.
• Display - plugins that visualize objects, often used to display module outputs.
• PreprocessorPlugin - plugins that perform preprocessing on modules. A preprocessor plugin is a discoverable ModulePreprocessor.
• PostprocessorPlugin - plugins that perform postprocessing on modules. A PostprocessorPlugin is a discoverable ModulePostprocessor.
• Platform - plugins for defining platform-specific behavior.
• Service - plugins that define new API in a particular area.
• Tool - plugins that map user input (e.g., keyboard and mouse actions) to behavior. They are usually rendered as icons in the application toolbar.
• InputWidget - plugins that render UI widgets for the InputHarvester preprocessor.

Author:

Curtis Rueden

See Also:

Plugin, PluginService