Package org.cytoscape.work
Interface ServiceProperties
public interface ServiceProperties
Reserved keywords for OSGi service properties (meta data).
These properties will be used for
TaskFactory
services.Module: work-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>work-api</artifactId> </dependency>
Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Shortcut key combination for desktop app.static final String
Define standard context menus.static final String
Name of command used by Command Executor.static final String
Description for a command.static final String
A valid JSON string representative of the expected JSON output of a command.static final String
Prose description for a command.static final String
Name space for a command.static final String
Indicates if the command supports JSON output.static final String
static final String
static final String
static final String
static final String
static final String
static final String
Action should be enabled or disabled by states if this property is setstatic final String
Unique ID of an OSGi service.static final String
Action will be added to the network view context menu if this flag is set to"true"
.static final String
TheCyAction
,TaskFactory
orTableTaskFactory
will be added to the Edge Table Panel's tool bar if this flag is set to"true"
.static final String
The CyAction or TaskFactory will be added to menu bar if this flag is set to"true"
.static final String
Action will be added to network panel's context menu if this flag is set to"true"
.static final String
TheCyAction
,TaskFactory
orTableTaskFactory
will be added to the Network Table Panel's tool bar if this flag is set to"true"
.static final String
TheCyAction
,TaskFactory
orTableTaskFactory
will be added to the Node Table Panel's tool bar if this flag is set to"true"
.static final String
The CyAction (or TaskFactory) will be added to the main tool bar if this flag is set to"true"
.static final String
TheCyAction
,TaskFactory
orTableTaskFactory
will be added to the Unassigned Tables Panel's tool bar if this flag is set to"true"
.static final String
Insert separator after this menu item.static final String
Insert separator before this menu item.static final String
Insert separator after this toolbar item.static final String
Insert separator before this toolbar item.static final String
The String ID of the Icon to be used in a swing component, usually a tool bar button (seeIN_TOOL_BAR
).static final String
Location of large icon data for desktop application (seeIN_TOOL_BAR
).static final String
Specify relative location of the action in the menu.static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
Preferred action properties.static final String
Preferred menu item for an action.static final String
The String ID of the Icon to be used in a swing component, usually a menu item (seeIN_MENU_BAR
).static final String
Location of small icon data for desktop application (seeIN_MENU_BAR
).static final String
Human-readable display name of a servicestatic final String
Specify relative location of the action in the tool bar.static final String
Short tool tip text for an action.static final String
Optional tool tip image for an action (usually used in tool bars).static final String
Optional longer tool tip description for an action (usually used in tool bars).
-
Field Details
-
ID
Unique ID of an OSGi service. If you need to filter a service from collection of services, use this property as its unique identifier.- See Also:
-
TITLE
Human-readable display name of a service- See Also:
-
ENABLE_FOR
Action should be enabled or disabled by states if this property is set- See Also:
-
PREFERRED_MENU
Preferred menu item for an action.- See Also:
-
COMMAND
Name of command used by Command Executor.- See Also:
-
COMMAND_NAMESPACE
Name space for a command.- See Also:
-
COMMAND_DESCRIPTION
Description for a command.- See Also:
-
COMMAND_LONG_DESCRIPTION
Prose description for a command.- See Also:
-
COMMAND_EXAMPLE_JSON
A valid JSON string representative of the expected JSON output of a command.- See Also:
-
COMMAND_SUPPORTS_JSON
Indicates if the command supports JSON output.- See Also:
-
LARGE_ICON_URL
Location of large icon data for desktop application (seeIN_TOOL_BAR
).- See Also:
-
SMALL_ICON_URL
Location of small icon data for desktop application (seeIN_MENU_BAR
).- See Also:
-
LARGE_ICON_ID
The String ID of the Icon to be used in a swing component, usually a tool bar button (seeIN_TOOL_BAR
). The icon must be registered with the same ID first -- seeIconManager.addIcon(String, Icon)
.- See Also:
-
SMALL_ICON_ID
The String ID of the Icon to be used in a swing component, usually a menu item (seeIN_MENU_BAR
). The icon must be registered with the same ID first -- seeIconManager.addIcon(String, Icon)
.- See Also:
-
TOOLTIP
Short tool tip text for an action.- See Also:
-
TOOLTIP_LONG_DESCRIPTION
Optional longer tool tip description for an action (usually used in tool bars).- See Also:
-
TOOLTIP_IMAGE
Optional tool tip image for an action (usually used in tool bars).- See Also:
-
IN_MENU_BAR
The CyAction or TaskFactory will be added to menu bar if this flag is set to"true"
. You can also set the menu item's icon through the propertiesSMALL_ICON_URL
orSMALL_ICON_ID
.- See Also:
-
IN_TOOL_BAR
The CyAction (or TaskFactory) will be added to the main tool bar if this flag is set to"true"
. You can also set the button's icon through the propertiesLARGE_ICON_URL
orLARGE_ICON_ID
.- See Also:
-
IN_NODE_TABLE_TOOL_BAR
TheCyAction
,TaskFactory
orTableTaskFactory
will be added to the Node Table Panel's tool bar if this flag is set to"true"
. You can also set the button's icon through the propertiesLARGE_ICON_URL
orLARGE_ICON_ID
.- See Also:
-
IN_EDGE_TABLE_TOOL_BAR
TheCyAction
,TaskFactory
orTableTaskFactory
will be added to the Edge Table Panel's tool bar if this flag is set to"true"
. You can also set the button's icon through the propertiesLARGE_ICON_URL
orLARGE_ICON_ID
.- See Also:
-
IN_NETWORK_TABLE_TOOL_BAR
TheCyAction
,TaskFactory
orTableTaskFactory
will be added to the Network Table Panel's tool bar if this flag is set to"true"
. You can also set the button's icon through the propertiesLARGE_ICON_URL
orLARGE_ICON_ID
.- See Also:
-
IN_UNASSIGNED_TABLE_TOOL_BAR
TheCyAction
,TaskFactory
orTableTaskFactory
will be added to the Unassigned Tables Panel's tool bar if this flag is set to"true"
. You can also set the button's icon through the propertiesLARGE_ICON_URL
orLARGE_ICON_ID
.- See Also:
-
IN_CONTEXT_MENU
Action will be added to the network view context menu if this flag is set to"true"
.This service property only affects:
NodeViewTaskFactory
EdgeViewTaskFactory
NetworkViewTaskFactory
If no value is defined, the default value is
"true"
.- See Also:
-
ACCELERATOR
Shortcut key combination for desktop app.- See Also:
-
MENU_GRAVITY
Specify relative location of the action in the menu.- See Also:
-
TOOL_BAR_GRAVITY
Specify relative location of the action in the tool bar.- See Also:
-
IN_NETWORK_PANEL_CONTEXT_MENU
Action will be added to network panel's context menu if this flag is set to"true"
.- See Also:
-
PREFERRED_ACTION
Preferred action properties.- See Also:
-
INSERT_SEPARATOR_BEFORE
Insert separator before this menu item.- See Also:
-
INSERT_SEPARATOR_AFTER
Insert separator after this menu item.- See Also:
-
INSERT_TOOLBAR_SEPARATOR_BEFORE
Insert separator before this toolbar item.- See Also:
-
INSERT_TOOLBAR_SEPARATOR_AFTER
Insert separator after this toolbar item.- See Also:
-
APPS_MENU
Define standard context menus. This is done here so that they will be consistenty used since this is the only way to define gravity for these...- See Also:
-
NETWORK_ADD_MENU
- See Also:
-
NETWORK_DELETE_MENU
- See Also:
-
NETWORK_EDIT_MENU
- See Also:
-
NETWORK_SELECT_MENU
- See Also:
-
NETWORK_GROUP_MENU
- See Also:
-
NETWORK_LAYOUT_MENU
- See Also:
-
NETWORK_APPS_MENU
- See Also:
-
NETWORK_PREFERENCES_MENU
- See Also:
-
NODE_ADD_MENU
- See Also:
-
NODE_EDIT_MENU
- See Also:
-
NODE_SELECT_MENU
- See Also:
-
NODE_GROUP_MENU
- See Also:
-
NODE_NESTED_NETWORKS_MENU
- See Also:
-
NODE_APPS_MENU
- See Also:
-
NODE_LINKOUTS_MENU
- See Also:
-
NODE_DYNAMIC_LINKOUTS_MENU
- See Also:
-
NODE_PREFERENCES_MENU
- See Also:
-
EDGE_EDIT_MENU
- See Also:
-
EDGE_SELECT_MENU
- See Also:
-
EDGE_APPS_MENU
- See Also:
-
EDGE_LINKOUTS_MENU
- See Also:
-
EDGE_DYNAMIC_LINKOUTS_MENU
- See Also:
-
EDGE_PREFERENCES_MENU
- See Also:
-