Author: mkirby
Date: 2011-10-07 14:20:11 -0700 (Fri, 07 Oct 2011)
New Revision: 27088
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/VisualPropertyEditor.java
Log:
Fixed Javadoc.
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-07 21:19:27 UTC (rev 27087)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/VisualPropertyEditor.java
2011-10-07 21:20:11 UTC (rev 27088)
@@ -51,21 +51,22 @@
*/
public interface VisualPropertyEditor<T> {
+ /**
+ * Returns the type of object managed in the Visual property.
+ * @return the type of object managed in the Visual property.
+ */
Class<T> getType();
/**
* Returns continuous mapping editor for the Visual Property. Return
value
- * is null is Continuous Editor does not exist.
- *
- * @param parent
- * @param type
+ * is null is Continuous Editor does not exist. #ASKMIKE
+ * @return a continuous mapping editor for the Visual Property.
*/
PropertyEditor getContinuousMappingEditor();
/**
- * Returns Property Editor object for this data type.
- *
- * @return
+ * Returns {@link PropertyEditor} object for this data type.
+ * @return {@link PropertyEditor} object for this data type.
*/
PropertyEditor getPropertyEditor();
@@ -74,15 +75,14 @@
* type (String, Number, Color...), so we do not need to provide
* VisualProperty as parameter.
*
- * @param parent
- * parent component of this window
+ * @param parent parent component of this window
* @return
*/
T showVisualPropertyValueEditor();
/**
* Provide Cell renderer for JTable or JList. Developers can implement
- * custom cell renderers my using returned component.
+ * custom cell renderers by using returned component.
*
* @param type
* @param width
@@ -99,8 +99,6 @@
/**
* This is for default view editor.
*
- * @param vp
- * DOCUMENT ME!
* @param width
* DOCUMENT ME!
* @param height
--
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.
