org.scijava.ui.behaviour.io.gui

Class CommandDescriptions

java.lang.Object

org.scijava.ui.behaviour.io.gui.CommandDescriptions

public final class CommandDescriptions
extends Object

A map linking Command (action name and context name) to its CommandDescriptions.DescriptionAndTriggers (textual description and default triggers of the command).

New entries are added using add(String, String[], String). This specifies only the action name of the Command. The context of the Command is the current context of this CommandDescriptions. The current context is changed by setKeyconfigContext(String), and then used for subsequently added entries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandDescriptions.DescriptionAndTriggers

Constructor Summary

Constructors

Constructor and Description
CommandDescriptions()

Method Summary

Modifier and Type	Method and Description
void	add(String name, String[] defaultTriggers, String description) Adds a new entry, linking a Command to textual description and default triggers.
void	augmentInputTriggerConfig(InputTriggerConfig config) For commands that are not yet defined in config, add them with their default triggers.
Map<Command,String>	createCommandDescriptionsMap() Builds a map from Command to textual description.
InputTriggerConfig	createDefaultKeyconfig() Builds a InputTriggerConfig with all commands and their default triggers.
void	setKeyconfigContext(String context) Sets the current context.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandDescriptions

public CommandDescriptions()

Method Detail

add

public void add(String name,
                String[] defaultTriggers,
                String description)

Adds a new entry, linking a Command to textual description and default triggers.

Parameters:

name - name of the Action or Behaviour. Together with the current context name (see setKeyconfigContext(String)) this specifies a Command.

defaultTriggers - default InputTriggers for the command.

description - textual description of the command (for displaying in UI).

setKeyconfigContext

public void setKeyconfigContext(String context)

Sets the current context. This context name is then used for subsequently added commands.

Parameters:

context - the context name.

createCommandDescriptionsMap

public Map<Command,String> createCommandDescriptionsMap()

Builds a map from Command to textual description. This is for making a keyconfig VisualEditorPanel.

Returns:

a new map.

createDefaultKeyconfig

public InputTriggerConfig createDefaultKeyconfig()

Builds a InputTriggerConfig with all commands and their default triggers. Commands that have no specified default triggers will have trigger "not mapped".

Returns:

a new InputTriggerConfig.

augmentInputTriggerConfig

public void augmentInputTriggerConfig(InputTriggerConfig config)

For commands that are not yet defined in config, add them with their default triggers. Commands that have no specified default triggers will have trigger "not mapped".

Parameters:

config - the input trigger config to add commands to.