Author: paperwing
Date: 2012-02-13 16:12:00 -0800 (Mon, 13 Feb 2012)
New Revision: 28253
Modified:
csplugins/trunk/toronto/yuedong/multi_renderer/api/presentation-api/src/main/java/org/cytoscape/view/presentation/ExternalRenderer.java
Log:
Updated ExternalRenderer javadoc, added method to notify for disposal
Modified:
csplugins/trunk/toronto/yuedong/multi_renderer/api/presentation-api/src/main/java/org/cytoscape/view/presentation/ExternalRenderer.java
===================================================================
---
csplugins/trunk/toronto/yuedong/multi_renderer/api/presentation-api/src/main/java/org/cytoscape/view/presentation/ExternalRenderer.java
2012-02-14 00:03:00 UTC (rev 28252)
+++
csplugins/trunk/toronto/yuedong/multi_renderer/api/presentation-api/src/main/java/org/cytoscape/view/presentation/ExternalRenderer.java
2012-02-14 00:12:00 UTC (rev 28253)
@@ -1,6 +1,7 @@
package org.cytoscape.view.presentation;
import org.cytoscape.model.CyNetwork;
+import org.cytoscape.view.model.CyNetworkView;
import org.cytoscape.view.model.CyNetworkViewFactory;
import org.cytoscape.view.model.View;
import org.cytoscape.view.model.VisualLexicon;
@@ -11,8 +12,11 @@
*/
public interface ExternalRenderer {
- String rendererID = null;
-
+ /**
+ * An enumeration encoding rendering purposes that may be intended for
certain {@link RenderingEngine} objects. For example,
+ * this could be used to differentiate between a {@link
RenderingEngine} that renders for the bird's eye view versus
+ * a {@link RenderingEngine} that is designed for the main network view.
+ */
enum RenderPurpose {
BIRDS_EYE_VIEW,
DETAIL_VIEW,
@@ -34,11 +38,22 @@
// Allow returning different CyNetworkView factories. This could be
helpful for efficiency. For example, a bird's eye RenderingEngine may not
// need some visual properties of the main view.
+ /**
+ * Return the {@link CyNetworkViewFactory} used for creating {@link
CyNetworkView} objects for the given rendering purpose.
+ */
CyNetworkViewFactory getNetworkViewFactory(RenderPurpose renderPurpose);
// Allow returning different VisualLexicons; a bird's eye
RenderingEngine may not need some visual properties of the main view.
+ /**
+ * Return the {@link VisualLexicon} for this renderer associated with
the given rendering purpose.
+ */
VisualLexicon getVisualLexicon(RenderPurpose renderPurpose);
+ // Prepares the renderer to be removed.
+ /**
+ * Notifies this renderer to release all its resources and prepare for
removal.
+ */
+ public void dispose();
// TODO: Determine how RenderingEngine instances will be obtained: via
returning RenderingEngineFactory objects or directly
// creating RenderingEngine objects
--
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.
