Package org.cytoscape.application.swing
Interface CySwingApplication
public interface CySwingApplication
This interface provides basic access to the Swing objects that
constitute this application.
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 (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.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a CyAction to application.getCytoPanel(CytoPanelName compassDirection)
Returns the appropriate CytoPanel for the specified compass direction.Returns the JFrame that contains the application.Returns the JMenu for the specified name and null if no menu exists for the name.Returns the JMenuBar object for the application.Returns the JToolBar object for the application.Returns the status JToolBar of the application.void
removeAction(CyAction action)
Remove the specified CyAction from the application.
-
Method Details
-
getJMenu
Returns the JMenu for the specified name and null if no menu exists for the name.- Parameters:
menuName
- the name of the JMenu.- Returns:
- The JMenu for the specified name and null if no menu exists for the name.
-
getJMenuBar
JMenuBar getJMenuBar()Returns the JMenuBar object for the application.- Returns:
- The JMenuBar object for the application.
-
getJToolBar
JToolBar getJToolBar()Returns the JToolBar object for the application.- Returns:
- The JToolBar object for the application.
-
addAction
Add a CyAction to application.- Parameters:
action
- The CyAction to be added to the application.
-
removeAction
Remove the specified CyAction from the application.- Parameters:
action
- The CyAction to be removed from the application.
-
getCytoPanel
Returns the appropriate CytoPanel for the specified compass direction.- Parameters:
compassDirection
- one of the enum values of CytoPanelName- Returns:
- the CytoPanel corresponding to "compassDirection"
-
getJFrame
JFrame getJFrame()Returns the JFrame that contains the application.- Returns:
- the JFrame that contains the application.
-
getStatusToolBar
JToolBar getStatusToolBar()Returns the status JToolBar of the application.- Returns:
- the status JToolBar of the application.
-