Author: mkirby
Date: 2011-10-12 23:36:36 -0700 (Wed, 12 Oct 2011)
New Revision: 27157
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/ValueEditor.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/VisualPropertyEditor.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/util/DiscreteMappingGenerator.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/ValueEditor.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/ValueEditor.java
2011-10-13 06:34:15 UTC (rev 27156)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/ValueEditor.java
2011-10-13 06:36:36 UTC (rev 27157)
@@ -12,11 +12,16 @@
/**
* Display the editor and get a new value.
+ * @param parent the parent Component of this editor.
+ * @param initialValue the initial value for the value editor dialogue.
*
- * @return
+ * @return the value generated from the value editor dialogue or null.
*/
<S extends V> V showEditor(Component parent, S initialValue);
+ /**
+ * @return the type of value returned by the value editor.
+ */
Class<V> getType();
}
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/VisualPropertyEditor.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/VisualPropertyEditor.java
2011-10-13 06:34:15 UTC (rev 27156)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/VisualPropertyEditor.java
2011-10-13 06:36:36 UTC (rev 27157)
@@ -75,7 +75,7 @@
* type (String, Number, Color...), so we do not need to provide
* VisualProperty as parameter.
*
- * @return
+ * @return the user input or null.
*/
T showVisualPropertyValueEditor();
@@ -83,7 +83,7 @@
* Provide Cell renderer for JTable or JList. Developers can implement
* custom cell renderers by using returned component.
*
- * @return
+ * @return a TableCellRenderer for JTable or JList.
*/
TableCellRenderer getDiscreteTableCellRenderer();
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/util/DiscreteMappingGenerator.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/util/DiscreteMappingGenerator.java
2011-10-13 06:34:15 UTC (rev 27156)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/util/DiscreteMappingGenerator.java
2011-10-13 06:36:36 UTC (rev 27157)
@@ -3,6 +3,8 @@
import java.util.Map;
import java.util.Set;
+/** Generates Discrete mappings for sets of attribute values and a visual
property type.
+ * @param <V> the type of the visual property. */
public interface DiscreteMappingGenerator<V> {
/**
@@ -10,9 +12,12 @@
*
* @param <T>
* @param attributeSet
- * @return
+ * @return a map between an attribute type and a visual property type.
*/
public <T> Map<T, V> generateMap(final Set<T> attributeSet);
+ /**
+ * @return the type of the visual property.
+ */
public Class<V> getDataType();
}
--
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.
