com.redhat.thermostat.client.ui

Interface MenuAction

All Superinterfaces:

ContextAction

@ExtensionPoint
public interface MenuAction
extends ContextAction

MenuActions are used to create top-level menu items in the main window.

Plugins can register menu items by creating classes that implement this interface and registering them as OSGi services. To register a menu item for for the menu "File" in thermostat client window, register a service that returns {"File", getName()} from getPath().

Implementation Notes

The following information is specific to the current release and may change in a future release.

The swing client uses MenuActionss to implement top-level menus in the main window only.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MenuAction.Type

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Invoked when the user selects this menu item
String	getDescription() A user-visible description of what this MenuAction does.
String	getName() The user-visible text displayed as the menu item.
String[]	getPath() The path to the menu action.
MenuAction.Type	getType() The type of the menu (radio, check, standard)

Method Detail

getName

String getName()

The user-visible text displayed as the menu item.

Specified by:

getName in interface ContextAction

getDescription

String getDescription()

A user-visible description of what this MenuAction does.

Specified by:

getDescription in interface ContextAction

execute

void execute()

Invoked when the user selects this menu item

getType

MenuAction.Type getType()

The type of the menu (radio, check, standard)

getPath

String[] getPath()

The path to the menu action. The last element must equal getName()