Author: kono
Date: 2009-06-25 12:14:50 -0700 (Thu, 25 Jun 2009)
New Revision: 17098
Modified:
core3/presentation-api/trunk/src/main/java/org/cytoscape/view/presentation/NetworkRenderer.java
Log:
Comments added.
Modified:
core3/presentation-api/trunk/src/main/java/org/cytoscape/view/presentation/NetworkRenderer.java
===================================================================
---
core3/presentation-api/trunk/src/main/java/org/cytoscape/view/presentation/NetworkRenderer.java
2009-06-25 17:38:47 UTC (rev 17097)
+++
core3/presentation-api/trunk/src/main/java/org/cytoscape/view/presentation/NetworkRenderer.java
2009-06-25 19:14:50 UTC (rev 17098)
@@ -42,14 +42,17 @@
import org.cytoscape.model.CyNetwork;
import org.cytoscape.view.model.CyNetworkView;
-import org.cytoscape.view.model.View;
import org.cytoscape.view.model.VisualProperty;
/**
- * Represents an presentation, i.e., actual 2D/3D visualization.
+ * Represents a presentation, i.e., actual 2D/3D visualization.
*
* Rendering engines should implement this interface.
*
+ * In Cytoscape 3, presentation is a leaf of tree:
+ * Network model <--- view <--- presentation
+ *
+ *
* @author mes
* @author kono
*
@@ -57,10 +60,21 @@
*
*/
public interface NetworkRenderer extends Renderer {
-
+
+ /**
+ * Returns model used to create this presentaiton.
+ *
+ * @return model (CyNetwork).
+ */
public CyNetwork getSourceNetwork();
+
+ /**
+ * Returns backend view model of this presentation.
+ *
+ * @return view model of this presentation.
+ */
public CyNetworkView getSourceView();
-
+
/**
*
*
@@ -89,16 +103,18 @@
* @return Image object created from current window.
*/
public Image getImage(int width, int height);
-
+
/**
- * For a given Visual Property, render an Icon based on the default
value
- * of the Visual Property.
- *
- * @param vp Visual Property.
- *
- * @return DOCUMENT ME!
- *
- * @exception IllegalArgumentException if vp is not in the lexicon.
+ * For a given Visual Property, render an Icon based on the default
value of
+ * the Visual Property.
+ *
+ * @param vp
+ * Visual Property.
+ *
+ * @return DOCUMENT ME!
+ *
+ * @exception IllegalArgumentException
+ * if vp is not in the lexicon.
*/
public Icon getDefaultIcon(VisualProperty<?> vp);
}
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
