org.cytoscape.app.swing

Class AbstractCySwingApp

java.lang.Object

org.cytoscape.app.AbstractCyApp

org.cytoscape.app.swing.AbstractCySwingApp

public abstract class AbstractCySwingApp
extends AbstractCyApp

The primary Swing-based app interface for Cytoscape that all Swing-based apps must extend. This extension to AbstractCyApp simply provides access to CySwingAppAdapter, which provides access to Swing specific services. All other services from CyAppAdapter will still be available.

Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Module: swing-app-api

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected CySwingAppAdapter	swingAdapter Reference to access Cytoscape functionality -- various managers and factories that are normally available as OSGi services.

Fields inherited from class org.cytoscape.app.AbstractCyApp

adapter

Constructor Summary

Constructors

Constructor and Description
AbstractCySwingApp(CySwingAppAdapter swingAdapter) The constructor that all apps must call using "super(adapter);" where the "adapter" is a CySwingAppAdapter reference provided as an argument to the constructor.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

swingAdapter

protected final CySwingAppAdapter swingAdapter

Reference to access Cytoscape functionality -- various managers and factories that are normally available as OSGi services.

Constructor Detail

AbstractCySwingApp

public AbstractCySwingApp(CySwingAppAdapter swingAdapter)

The constructor that all apps must call using "super(adapter);" where the "adapter" is a CySwingAppAdapter reference provided as an argument to the constructor. Cytoscape's app loader will execute the constructor and provide the proper CySwingAppAdapter reference.

 
 public class MySwingApp extends AbstractCySwingApp {
    public MySwingApp(CySwingAppAdapter adapter) {
       super(adapter);
       // app code here
    }
 }
 

Parameters:

adapter - a CySwingAppAdapter reference provided as an argument to the constructor.