Package org.cytoscape.application.swing
Interface CytoPanelComponent
- All Known Subinterfaces:
CytoPanelComponent2
public interface CytoPanelComponent
An interface that allows a component to be registered as a service
that will then be added to the appropriate
CytoPanel
.
To make your component discoverable by other apps, implement CytoPanelComponent2
instead.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.
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>
-
Method Summary
Modifier and TypeMethodDescriptionReturns the Component to be added to the CytoPanel.Returns the name of the CytoPanel that this component should be added to.getIcon()
Returns the Icon to be used along with the title in the tab for this this component.getTitle()
Returns the title of the tab within the CytoPanel for this component.
-
Method Details
-
getComponent
Component getComponent()Returns the Component to be added to the CytoPanel.- Returns:
- The Component to be added to the CytoPanel.
-
getCytoPanelName
CytoPanelName getCytoPanelName()Returns the name of the CytoPanel that this component should be added to.- Returns:
- the name of the CytoPanel that this component should be added to.
-
getTitle
String getTitle()Returns the title of the tab within the CytoPanel for this component.- Returns:
- the title of the tab within the CytoPanel for this component.
-
getIcon
Icon getIcon()Returns the Icon to be used along with the title in the tab for this this component. May be null!- Returns:
- the Icon to be used along with the title in the tab for this this component. May be null!
-