org.cytoscape.application.swing

Interface CytoPanelComponent2

All Superinterfaces:

CytoPanelComponent

public interface CytoPanelComponent2
extends CytoPanelComponent

Implement this interface rather than CytoPanelComponent, if you want to allow your component to be retrieved from the CytoPanel by its identifier. See CytoPanel.indexOfComponent(String).

Module: swing-application-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>swing-application-api</artifactId>
</dependency>

Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.

Method Summary

Modifier and Type	Method and Description
String	getIdentifier() Returns this component's identifier, which should be unique.

Methods inherited from interface org.cytoscape.application.swing.CytoPanelComponent

getComponent, getCytoPanelName, getIcon, getTitle

Method Detail

getIdentifier

String getIdentifier()

Returns this component's identifier, which should be unique. To minimize the risk of returning an identifier that is also used by another app, you should add a prefix/namespace. As a suggestion, the prefix can be your app's name or your organization reverse domain. For example, return "com.myorganizationname.MyPanel" instead of just "MyPanel". The prefix "org.cytoscape." is reserved for modules and apps provided by the Cytoscape Consortium only and must not be used by third-party apps.

Returns:

The identifier of this component.