org.scijava.ui.behaviour.io.gui

Class CommandDescriptionProvider

java.lang.Object

org.scijava.ui.behaviour.io.gui.CommandDescriptionProvider

All Implemented Interfaces:

SciJavaPlugin

public abstract class CommandDescriptionProvider
extends Object
implements SciJavaPlugin

Implementations of this interface, annotated with @Plugin, are discovered for automatically adding actions/behaviours to a CommandDescriptions map.

(This allows to discover Plugin shortcuts which cannot be hardwired into the default keymap.)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandDescriptionProvider.Scope

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandDescriptionProvider(CommandDescriptionProvider.Scope scope, String... expectedContexts)

Method Summary

Modifier and Type	Method and Description
abstract void	getCommandDescriptions(CommandDescriptions descriptions)
String[]	getExpectedContexts() The contexts in which the described actions/behaviours are expected to be used.
CommandDescriptionProvider.Scope	getScope() The scope describes the application / Fiji plugin that the actions are defined in.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandDescriptionProvider

protected CommandDescriptionProvider(CommandDescriptionProvider.Scope scope,
                                     String... expectedContexts)

Method Detail

getScope

public CommandDescriptionProvider.Scope getScope()

The scope describes the application / Fiji plugin that the actions are defined in. This is to make it possible to only harvest descriptions for the desired scopes.

Note that CommandDescriptionProvider is only used for harvesting actions/behaviours for the config dialog. So basically it has nothing to do with reality, necessarily. Whether these actions are ever actualized depends on other code! The scope is for which scope the config dialog will make the actions configurable. For example, if you put {"mastodon"} there, then the InputTriggerConfig will be picked up by a config dialog requesting these scopes.

getExpectedContexts

public String[] getExpectedContexts()

The contexts in which the described actions/behaviours are expected to be used.

Note that CommandDescriptionProvider is only used for harvesting actions/behaviours for the config dialog. So basically it has nothing to do with reality, necessarily. Whether these actions are ever actualized depends on other code! The expectedContexts is for which context the config dialog will make the actions configurable. For example, if you put {"bdv", "ts"} there, then the InputTriggerConfig made by the config dialog will put InputTriggers with these contexts.

getCommandDescriptions

public abstract void getCommandDescriptions(CommandDescriptions descriptions)