Author: mes
Date: 2012-04-23 11:57:38 -0700 (Mon, 23 Apr 2012)
New Revision: 28949
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualPropertyDependency.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualStyle.java
Log:
updated javadoc
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualPropertyDependency.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualPropertyDependency.java
2012-04-23 18:49:07 UTC (rev 28948)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualPropertyDependency.java
2012-04-23 18:57:38 UTC (rev 28949)
@@ -12,7 +12,7 @@
* dependency is enabled.
*
* @param <T> type of {@linkplain VisualProperty} value in this group.
- *
+ * @CyAPI.Api.Interface
*/
public final class VisualPropertyDependency<T> {
@@ -22,7 +22,14 @@
private final VisualProperty<T> parentVisualProperty;
private boolean enabled;
-
+
+ /**
+ * Constructor.
+ * @param displayName A human readable name for use in user interfaces.
+ * @param vpSet The set of visual properties.
+ * @param lexicon The visual lexicon used by this dependency. The
lexicon determines
+ * the parent visual property for this dependency.
+ */
public VisualPropertyDependency(final String displayName, final
Set<VisualProperty<T>> vpSet, final VisualLexicon lexicon) {
this.displayName = displayName;
this.vpSet = vpSet;
@@ -73,15 +80,27 @@
public Set<VisualProperty<?>> getVisualProperties() {
return Collections.<VisualProperty<?>>unmodifiableSet(vpSet);
}
-
+
+ /**
+ * Enables or disables the dependency based on the boolean parameter.
+ * @param enable Whether to enable (true) or disable (false) this
dependency.
+ */
public void setDependency(boolean enable) {
this.enabled = enable;
}
-
+
+ /**
+ * Returns whether or not this dependency is enabled.
+ * @return whether or not this dependency is enabled.
+ */
public boolean isDependencyEnabled() {
return enabled;
}
+ /**
+ * Returns the parent visual property for this dependency.
+ * @return the parent visual property for this dependency.
+ */
public VisualProperty<T> getParentVisualProperty() {
return parentVisualProperty;
}
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualStyle.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualStyle.java
2012-04-23 18:49:07 UTC (rev 28948)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualStyle.java
2012-04-23 18:57:38 UTC (rev 28949)
@@ -140,7 +140,7 @@
* Apply visual only to a individual View Object (node/edge),
* not the entire network view.
*
- * @param viewObject
+ * @param view The view that the visual property should be applied to.
*/
void apply(final View<? extends CyIdentifiable> view);
--
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.
