Author: mes
Date: 2012-05-02 16:43:23 -0700 (Wed, 02 May 2012)
New Revision: 29086
Modified:
core3/api/trunk/app-api/src/main/java/org/cytoscape/app/AbstractCyApp.java
core3/api/trunk/app-api/src/main/java/org/cytoscape/app/CyAppAdapter.java
core3/api/trunk/swing-app-api/src/main/java/org/cytoscape/app/swing/AbstractCySwingApp.java
core3/api/trunk/swing-app-api/src/main/java/org/cytoscape/app/swing/CySwingAppAdapter.java
core3/api/trunk/swing-app-api/src/main/java/org/cytoscape/app/swing/package-info.java
Log:
updated javadoc
Modified:
core3/api/trunk/app-api/src/main/java/org/cytoscape/app/AbstractCyApp.java
===================================================================
--- core3/api/trunk/app-api/src/main/java/org/cytoscape/app/AbstractCyApp.java
2012-05-02 23:06:17 UTC (rev 29085)
+++ core3/api/trunk/app-api/src/main/java/org/cytoscape/app/AbstractCyApp.java
2012-05-02 23:43:23 UTC (rev 29086)
@@ -4,13 +4,15 @@
/**
* The primary app interface for Cytoscape that all
* apps must extend. App developers will have access
- * to all Cytoscape 3.X services, but are not required to
- * know about or use Maven, OSGi, or Spring.
- * However, there are limitations on which packages may
+ * to all core Cytoscape 3.X services, but are not required to
+ * know about or use Maven or OSGi. This interface does not
+ * provide access to Swing or GUI related services, for
+ * that use AbstractCySwingApp found in the org.cytoscape.app.swing
+ * package.
+ * There are limitations on which packages may
* be included in the app jar based on those already loaded in the classpath.
* To load alternative versions of the same library used by other apps or
- * Cytoscape itself, it will be necessary to write your app using OSGi
- * and Spring.
+ * Cytoscape itself, it will be necessary to write your app using OSGi.
* @CyAPI.Abstract.Class
*/
public abstract class AbstractCyApp {
@@ -34,7 +36,7 @@
* <br/>
*
* <blockquote><pre>
- * public class MyApp extends CyApp {
+ * public class MyApp extends AbstractCyApp {
* public MyApp(CyAppAdapter adapter) {
* super(adapter);
* // app code here
Modified:
core3/api/trunk/app-api/src/main/java/org/cytoscape/app/CyAppAdapter.java
===================================================================
--- core3/api/trunk/app-api/src/main/java/org/cytoscape/app/CyAppAdapter.java
2012-05-02 23:06:17 UTC (rev 29085)
+++ core3/api/trunk/app-api/src/main/java/org/cytoscape/app/CyAppAdapter.java
2012-05-02 23:43:23 UTC (rev 29086)
@@ -96,11 +96,15 @@
/**
* A Java-only api providing access to Cytoscape functionality.
- * This class will provide access the various Manager and
+ * This class will provide access the various core Manager and
* Factory interfaces defined in different API jars that are
- * normally made available to apps as OSGi services. Through
+ * normally made available to apps as OSGi services.
+ * Through
* these interfaces developers will have access to most management
- * and creational facilities defined in the Cytoscape API.
+ * and creational facilities defined in the Cytoscape API, however
+ * this interface omits all Swing or GUI specific services so that
+ * apps may be written to be independent of the UI. For Swing
+ * and GUI related services see CySwingAppAdapter.
* This is a convenience interface intended make app development
* as simple as possible.
* @CyAPI.Api.Interface
Modified:
core3/api/trunk/swing-app-api/src/main/java/org/cytoscape/app/swing/AbstractCySwingApp.java
===================================================================
---
core3/api/trunk/swing-app-api/src/main/java/org/cytoscape/app/swing/AbstractCySwingApp.java
2012-05-02 23:06:17 UTC (rev 29085)
+++
core3/api/trunk/swing-app-api/src/main/java/org/cytoscape/app/swing/AbstractCySwingApp.java
2012-05-02 23:43:23 UTC (rev 29086)
@@ -3,15 +3,11 @@
import org.cytoscape.app.AbstractCyApp;
/**
- * The primary app interface for Cytoscape that all
- * apps must extend. App developers will have access
- * to all Cytoscape 3.X services, but are not required to
- * know about or use Maven, OSGi, or Spring.
- * However, there are limitations on which packages may
- * be included in the app jar based on those already loaded in the classpath.
- * To load alternative versions of the same library used by other apps or
- * Cytoscape itself, it will be necessary to write your app using OSGi
- * and Spring.
+ * 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.
* @CyAPI.Abstract.Class
*/
public abstract class AbstractCySwingApp extends AbstractCyApp {
@@ -24,20 +20,20 @@
/**
* The constructor that all apps must call using "super(adapter);" where
- * the "adapter" is a {@link CyAppAdapter} reference provided as an
+ * the "adapter" is a {@link CySwingAppAdapter} reference provided as an
* argument to the constructor. Cytoscape's app loader will execute
- * the constructor and provide the proper CyAppAdapter reference.
+ * the constructor and provide the proper CySwingAppAdapter reference.
* <br/>
*
* <blockquote><pre>
- * public class MyApp extends CyApp {
- * public MyApp(CyAppAdapter adapter) {
+ * public class MySwingApp extends AbstractCySwingApp {
+ * public MySwingApp(CySwingAppAdapter adapter) {
* super(adapter);
* // app code here
* }
* }
* </pre></blockquote>
- * @param adapter a {@link CyAppAdapter} reference provided as an
+ * @param adapter a {@link CySwingAppAdapter} reference provided as an
* argument to the constructor.
*/
public AbstractCySwingApp(final CySwingAppAdapter swingAdapter) {
Modified:
core3/api/trunk/swing-app-api/src/main/java/org/cytoscape/app/swing/CySwingAppAdapter.java
===================================================================
---
core3/api/trunk/swing-app-api/src/main/java/org/cytoscape/app/swing/CySwingAppAdapter.java
2012-05-02 23:06:17 UTC (rev 29085)
+++
core3/api/trunk/swing-app-api/src/main/java/org/cytoscape/app/swing/CySwingAppAdapter.java
2012-05-02 23:43:23 UTC (rev 29086)
@@ -8,11 +8,13 @@
/**
- * A Java-only api providing access to Cytoscape functionality.
- * This class will provide access the various Manager and
- * Factory interfaces defined in different API jars that are
- * normally made available to apps as OSGi services. Through
- * these interfaces developers will have access to most management
+ * A Swing-specific extension of {@link CyAppAdapter} that
+ * serves as a Java-only api providing access to core
+ * Cytoscape functionality.
+ * This class will provide access the various Swing-specific
+ * Manager and Factory interfaces in addition to those defined in
+ * {@link CyAppAdapter}.
+ * Through these interfaces developers will have access to most management
* and creational facilities defined in the Cytoscape API.
* This is a convenience interface intended make app development
* as simple as possible.
Modified:
core3/api/trunk/swing-app-api/src/main/java/org/cytoscape/app/swing/package-info.java
===================================================================
---
core3/api/trunk/swing-app-api/src/main/java/org/cytoscape/app/swing/package-info.java
2012-05-02 23:06:17 UTC (rev 29085)
+++
core3/api/trunk/swing-app-api/src/main/java/org/cytoscape/app/swing/package-info.java
2012-05-02 23:43:23 UTC (rev 29086)
@@ -2,6 +2,6 @@
* This is the Cytoscape Swing App API, which supports development of
Cytoscape 3.X
* apps in a manner similar to apps developed in Cytoscape 2.X and provides
full
* access to the Swing specific services of the Cytoscape API in addition
- * to all of the existing services.
+ * to all other services provided in Cytoscape App API.
*/
package org.cytoscape.app.swing;
--
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en.
