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

Fields

Modifier and Type	Field	Description
static String	ACCELERATOR	Shortcut key combination for desktop app.
static String	APPS_MENU	Define standard context menus.
static String	COMMAND	Name of command used by Command Executor.
static String	COMMAND_DESCRIPTION	Description for a command.
static String	COMMAND_EXAMPLE_JSON	A valid JSON string representative of the expected JSON output of a command.
static String	COMMAND_LONG_DESCRIPTION	Prose description for a command.
static String	COMMAND_NAMESPACE	Name space for a command.
static String	COMMAND_SUPPORTS_JSON	Indicates if the command supports JSON output.
static String	EDGE_APPS_MENU
static String	EDGE_DYNAMIC_LINKOUTS_MENU
static String	EDGE_EDIT_MENU
static String	EDGE_LINKOUTS_MENU
static String	EDGE_PREFERENCES_MENU
static String	EDGE_SELECT_MENU
static String	ENABLE_FOR	Action should be enabled or disabled by states if this property is set
static String	ID	Unique ID of an OSGi service.
static String	IN_CONTEXT_MENU	Action will be added to the network view context menu if this flag is set to "true".
static String	IN_EDGE_TABLE_TOOL_BAR	The CyAction, TaskFactory or TableTaskFactory will be added to the Edge Table Panel's tool bar if this flag is set to "true".
static String	IN_MENU_BAR	The CyAction or TaskFactory will be added to menu bar if this flag is set to "true".
static String	IN_NETWORK_PANEL_CONTEXT_MENU	Action will be added to network panel's context menu if this flag is set to "true".
static String	IN_NETWORK_TABLE_TOOL_BAR	The CyAction, TaskFactory or TableTaskFactory will be added to the Network Table Panel's tool bar if this flag is set to "true".
static String	IN_NODE_TABLE_TOOL_BAR	The CyAction, TaskFactory or TableTaskFactory will be added to the Node Table Panel's tool bar if this flag is set to "true".
static String	IN_TOOL_BAR	The CyAction (or TaskFactory) will be added to the main tool bar if this flag is set to "true".
static String	IN_UNASSIGNED_TABLE_TOOL_BAR	The CyAction, TaskFactory or TableTaskFactory will be added to the Unassigned Tables Panel's tool bar if this flag is set to "true".
static String	INSERT_SEPARATOR_AFTER	Insert separator after this menu item.
static String	INSERT_SEPARATOR_BEFORE	Insert separator before this menu item.
static String	INSERT_TOOLBAR_SEPARATOR_AFTER	Insert separator after this toolbar item.
static String	INSERT_TOOLBAR_SEPARATOR_BEFORE	Insert separator before this toolbar item.
static String	LARGE_ICON_ID	The String ID of the Icon to be used in a swing component, usually a tool bar button (see IN_TOOL_BAR).
static String	LARGE_ICON_URL	Location of large icon data for desktop application (see IN_TOOL_BAR).
static String	MENU_GRAVITY	Specify relative location of the action in the menu.
static String	NETWORK_ADD_MENU
static String	NETWORK_APPS_MENU
static String	NETWORK_DELETE_MENU
static String	NETWORK_EDIT_MENU
static String	NETWORK_GROUP_MENU
static String	NETWORK_LAYOUT_MENU
static String	NETWORK_PREFERENCES_MENU
static String	NETWORK_SELECT_MENU
static String	NODE_ADD_MENU
static String	NODE_APPS_MENU
static String	NODE_DYNAMIC_LINKOUTS_MENU
static String	NODE_EDIT_MENU
static String	NODE_GROUP_MENU
static String	NODE_LINKOUTS_MENU
static String	NODE_NESTED_NETWORKS_MENU
static String	NODE_PREFERENCES_MENU
static String	NODE_SELECT_MENU
static String	PREFERRED_ACTION	Preferred action properties.
static String	PREFERRED_MENU	Preferred menu item for an action.
static String	SMALL_ICON_ID	The String ID of the Icon to be used in a swing component, usually a menu item (see IN_MENU_BAR).
static String	SMALL_ICON_URL	Location of small icon data for desktop application (see IN_MENU_BAR).
static String	TITLE	Human-readable display name of a service
static String	TOOL_BAR_GRAVITY	Specify relative location of the action in the tool bar.
static String	TOOLTIP	Short tool tip text for an action.
static String	TOOLTIP_IMAGE	Optional tool tip image for an action (usually used in tool bars).
static String	TOOLTIP_LONG_DESCRIPTION	Optional longer tool tip description for an action (usually used in tool bars).

Field Details

ID

static final String 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:

Constant Field Values

TITLE

static final String TITLE

Human-readable display name of a service

See Also:

Constant Field Values

ENABLE_FOR

static final String ENABLE_FOR

Action should be enabled or disabled by states if this property is set

See Also:

Constant Field Values

PREFERRED_MENU

static final String PREFERRED_MENU

Preferred menu item for an action.

See Also:

Constant Field Values

COMMAND

static final String COMMAND

Name of command used by Command Executor.

See Also:

Constant Field Values

COMMAND_NAMESPACE

static final String COMMAND_NAMESPACE

Name space for a command.

See Also:

Constant Field Values

COMMAND_DESCRIPTION

static final String COMMAND_DESCRIPTION

Description for a command.

See Also:

Constant Field Values

COMMAND_LONG_DESCRIPTION

static final String COMMAND_LONG_DESCRIPTION

Prose description for a command.

See Also:

Constant Field Values

COMMAND_EXAMPLE_JSON

static final String COMMAND_EXAMPLE_JSON

A valid JSON string representative of the expected JSON output of a command.

See Also:

Constant Field Values

COMMAND_SUPPORTS_JSON

static final String COMMAND_SUPPORTS_JSON

Indicates if the command supports JSON output.

See Also:

Constant Field Values

LARGE_ICON_URL

static final String LARGE_ICON_URL

Location of large icon data for desktop application (see IN_TOOL_BAR).

See Also:

Constant Field Values

SMALL_ICON_URL

static final String SMALL_ICON_URL

Location of small icon data for desktop application (see IN_MENU_BAR).

See Also:

Constant Field Values

LARGE_ICON_ID

static final String LARGE_ICON_ID

The String ID of the Icon to be used in a swing component, usually a tool bar button (see IN_TOOL_BAR). The icon must be registered with the same ID first -- see IconManager.addIcon(String, Icon).

See Also:

Constant Field Values

SMALL_ICON_ID

static final String SMALL_ICON_ID

The String ID of the Icon to be used in a swing component, usually a menu item (see IN_MENU_BAR). The icon must be registered with the same ID first -- see IconManager.addIcon(String, Icon).

See Also:

Constant Field Values

TOOLTIP

static final String TOOLTIP

Short tool tip text for an action.

See Also:

Constant Field Values

TOOLTIP_LONG_DESCRIPTION

static final String TOOLTIP_LONG_DESCRIPTION

Optional longer tool tip description for an action (usually used in tool bars).

See Also:

Constant Field Values

TOOLTIP_IMAGE

static final String TOOLTIP_IMAGE

Optional tool tip image for an action (usually used in tool bars).

See Also:

Constant Field Values

IN_MENU_BAR

static final String 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 properties SMALL_ICON_URL or SMALL_ICON_ID.

See Also:

Constant Field Values

IN_TOOL_BAR

static final String 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 properties LARGE_ICON_URL or LARGE_ICON_ID.

See Also:

Constant Field Values

IN_NODE_TABLE_TOOL_BAR

static final String IN_NODE_TABLE_TOOL_BAR

The CyAction, TaskFactory or TableTaskFactory 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 properties LARGE_ICON_URL or LARGE_ICON_ID.

See Also:

Constant Field Values

IN_EDGE_TABLE_TOOL_BAR

static final String IN_EDGE_TABLE_TOOL_BAR

The CyAction, TaskFactory or TableTaskFactory 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 properties LARGE_ICON_URL or LARGE_ICON_ID.

See Also:

Constant Field Values

IN_NETWORK_TABLE_TOOL_BAR

static final String IN_NETWORK_TABLE_TOOL_BAR

The CyAction, TaskFactory or TableTaskFactory 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 properties LARGE_ICON_URL or LARGE_ICON_ID.

See Also:

Constant Field Values

IN_UNASSIGNED_TABLE_TOOL_BAR

static final String IN_UNASSIGNED_TABLE_TOOL_BAR

The CyAction, TaskFactory or TableTaskFactory 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 properties LARGE_ICON_URL or LARGE_ICON_ID.

See Also:

Constant Field Values

IN_CONTEXT_MENU

static final String 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:

Constant Field Values

ACCELERATOR

static final String ACCELERATOR

Shortcut key combination for desktop app.

See Also:

Constant Field Values

MENU_GRAVITY

static final String MENU_GRAVITY

Specify relative location of the action in the menu.

See Also:

Constant Field Values

TOOL_BAR_GRAVITY

static final String TOOL_BAR_GRAVITY

Specify relative location of the action in the tool bar.

See Also:

Constant Field Values

IN_NETWORK_PANEL_CONTEXT_MENU

static final String IN_NETWORK_PANEL_CONTEXT_MENU

Action will be added to network panel's context menu if this flag is set to "true".

See Also:

Constant Field Values

PREFERRED_ACTION

static final String PREFERRED_ACTION

Preferred action properties.

See Also:

Constant Field Values

INSERT_SEPARATOR_BEFORE

static final String INSERT_SEPARATOR_BEFORE

Insert separator before this menu item.

See Also:

Constant Field Values

INSERT_SEPARATOR_AFTER

static final String INSERT_SEPARATOR_AFTER

Insert separator after this menu item.

See Also:

Constant Field Values

INSERT_TOOLBAR_SEPARATOR_BEFORE

static final String INSERT_TOOLBAR_SEPARATOR_BEFORE

Insert separator before this toolbar item.

See Also:

Constant Field Values

INSERT_TOOLBAR_SEPARATOR_AFTER

static final String INSERT_TOOLBAR_SEPARATOR_AFTER

Insert separator after this toolbar item.

See Also:

Constant Field Values

APPS_MENU

static final String 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:

Constant Field Values

NETWORK_ADD_MENU

static final String NETWORK_ADD_MENU

See Also:

Constant Field Values

NETWORK_DELETE_MENU

static final String NETWORK_DELETE_MENU

See Also:

Constant Field Values

NETWORK_EDIT_MENU

static final String NETWORK_EDIT_MENU

See Also:

Constant Field Values

NETWORK_SELECT_MENU

static final String NETWORK_SELECT_MENU

See Also:

Constant Field Values

NETWORK_GROUP_MENU

static final String NETWORK_GROUP_MENU

See Also:

Constant Field Values

NETWORK_LAYOUT_MENU

static final String NETWORK_LAYOUT_MENU

See Also:

Constant Field Values

NETWORK_APPS_MENU

static final String NETWORK_APPS_MENU

See Also:

Constant Field Values

NETWORK_PREFERENCES_MENU

static final String NETWORK_PREFERENCES_MENU

See Also:

Constant Field Values

NODE_ADD_MENU

static final String NODE_ADD_MENU

See Also:

Constant Field Values

NODE_EDIT_MENU

static final String NODE_EDIT_MENU

See Also:

Constant Field Values

NODE_SELECT_MENU

static final String NODE_SELECT_MENU

See Also:

Constant Field Values

NODE_GROUP_MENU

static final String NODE_GROUP_MENU

See Also:

Constant Field Values

NODE_NESTED_NETWORKS_MENU

static final String NODE_NESTED_NETWORKS_MENU

See Also:

Constant Field Values

NODE_APPS_MENU

static final String NODE_APPS_MENU

See Also:

Constant Field Values

NODE_LINKOUTS_MENU

static final String NODE_LINKOUTS_MENU

See Also:

Constant Field Values

NODE_DYNAMIC_LINKOUTS_MENU

static final String NODE_DYNAMIC_LINKOUTS_MENU

See Also:

Constant Field Values

NODE_PREFERENCES_MENU

static final String NODE_PREFERENCES_MENU

See Also:

Constant Field Values

EDGE_EDIT_MENU

static final String EDGE_EDIT_MENU

See Also:

Constant Field Values

EDGE_SELECT_MENU

static final String EDGE_SELECT_MENU

See Also:

Constant Field Values

EDGE_APPS_MENU

static final String EDGE_APPS_MENU

See Also:

Constant Field Values

EDGE_LINKOUTS_MENU

static final String EDGE_LINKOUTS_MENU

See Also:

Constant Field Values

EDGE_DYNAMIC_LINKOUTS_MENU

static final String EDGE_DYNAMIC_LINKOUTS_MENU

See Also:

Constant Field Values

EDGE_PREFERENCES_MENU

static final String EDGE_PREFERENCES_MENU

See Also:

Constant Field Values