Author: kono
Date: 2010-10-19 13:42:59 -0700 (Tue, 19 Oct 2010)
New Revision: 22298
Modified:
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/VisualLexicon.java
Log:
JavaDoc comments added.
Modified:
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/VisualLexicon.java
===================================================================
---
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/VisualLexicon.java
2010-10-19 20:38:16 UTC (rev 22297)
+++
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/VisualLexicon.java
2010-10-19 20:42:59 UTC (rev 22298)
@@ -38,12 +38,11 @@
import java.util.Set;
/**
- * Should be implemented as a service. 'Renderer' is simply anything that
- * provides VisualProperties. With a 'VisualProperties as annotations' this
- * won't be needed.
*
- * This is a pre-definded tree by rendering engine developer.
+ * A {...@linkplain RenderingEngine} should provide <strong>one,
immutable</strong> lexicon implementing this interface.
*
+ * This is a pre-defined tree of VisualProperties designed by the
{...@linkplain RenderingEngine} developer.
+ *
* @since Cytoscape 3.0
*
*/
@@ -67,6 +66,14 @@
Set<VisualProperty<?>> getAllVisualProperties();
+ /**
+ * Get a tree node in for the given VisualProperty.
+ *
+ * @param vp target VisualProperty in this lexicon.
+ * @return tree node for the VisualProperty in this lexicon.
+ *
+ * @throws IllegalArgumentException If vp does not exist in the lexicon.
+ */
VisualLexiconNode getVisualLexiconNode(final 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.
