CommandManager

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> virtuosotechnologies >> asaph >> [ maingui overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.virtuosotechnologies.asaph.maingui.CommandManager

SOURCE |

Download com.virtuosotechnologies.asaph.maingui.CommandManager

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.virtuosotechnologies.asaph.maingui
Interface CommandManager

All Known Implementing Classes:: CommandManagerImpl

public interface CommandManager

The command manager API exported by the maingui plugin

Nested Class Summary

static class CommandManager.CommandCategory
          A category for commands, specifying where in the menus the command will appear, as well as additional behaviors involving appearance and enabling.

Field Summary

static java.lang.String API_NAME
          The name of this API.

static CommandManager.CommandCategory OPEN_COMMANDS
          Denotes commands for database creating and opening.

static CommandManager.CommandCategory SAVE_COMMANDS
          Denotes commands for database saving.

static CommandManager.CommandCategory SONG_COMMANDS
          Denotes commands for song manipulation.

static CommandManager.CommandCategory TOOL_COMMANDS
          Denotes commands for publishing, report generation, and other features provided by the plugin.

Method Summary

com.virtuosotechnologies.lib.command.CommandNode createCommandGroup(CommandManager.CommandCategory category)
          Returns a group-flavored CommandNode that can be filled with commands which a plugin wants to submit to the menu system.

boolean setDefaultSongCommand(com.virtuosotechnologies.lib.command.CommandNode node, int priority)
          Sets the default song command.

Field Detail

API_NAME

public static final java.lang.String API_NAME

The name of this API.

See Also:: Constant Field Values

OPEN_COMMANDS

public static final CommandManager.CommandCategory OPEN_COMMANDS

Denotes commands for database creating and opening. Commands registered in this category will show up towards the top of the File menu. The plugin has complete control over the enable/disable state of these commands, and it may change the state at any time.

SAVE_COMMANDS

public static final CommandManager.CommandCategory SAVE_COMMANDS

Denotes commands for database saving. Commands registered in this category will show up towards the middle and bottom of the File menu, and will be located in a group that is enabled only when a database is selected. Additionally, the plugin may further disable this node or its subnodes if it chooses, in response to the type of database selected.

SONG_COMMANDS

public static final CommandManager.CommandCategory SONG_COMMANDS

Denotes commands for song manipulation. Commands registered in this category will show up in the Song menu, and will be located in a group that is enabled only when at least one song is selected. Additionally, the plugin may further disable this node or its subnodes if it chooses, in response to selection changes or other state changes.

TOOL_COMMANDS

public static final CommandManager.CommandCategory TOOL_COMMANDS

Denotes commands for publishing, report generation, and other features provided by the plugin. Commands registered under this node will show up in the Tools menu. The plugin has complete control over the enable/disable state of these commands, and it may change the state in response to selection changes or other state changes.

Method Detail

createCommandGroup

public com.virtuosotechnologies.lib.command.CommandNode createCommandGroup(CommandManager.CommandCategory category)

Returns a group-flavored CommandNode that can be filled with commands which a plugin wants to submit to the menu system. Commands are separated into categories, identified by the constants OPEN_COMMANDS, SAVE_COMMANDS, SONG_COMMANDS and TOOL_COMMANDS. See the comments for the various key constants for more information about command categories.

setDefaultSongCommand

public boolean setDefaultSongCommand(com.virtuosotechnologies.lib.command.CommandNode node,
                                     int priority)

Sets the default song command. If a command is already present, the one with the higher priority will be taken. Returns true if the command was set, or false if not.