Author: mes
Date: 2010-10-27 16:02:41 -0700 (Wed, 27 Oct 2010)
New Revision: 22531
Modified:
core3/work-swing-api/trunk/src/main/java/org/cytoscape/work/swing/GUITaskManager.java
core3/work-swing-api/trunk/src/main/java/org/cytoscape/work/swing/GUITunableHandler.java
core3/work-swing-api/trunk/src/main/java/org/cytoscape/work/swing/GUITunableInterceptor.java
Log:
javadoc updates
Modified:
core3/work-swing-api/trunk/src/main/java/org/cytoscape/work/swing/GUITaskManager.java
===================================================================
---
core3/work-swing-api/trunk/src/main/java/org/cytoscape/work/swing/GUITaskManager.java
2010-10-27 22:45:33 UTC (rev 22530)
+++
core3/work-swing-api/trunk/src/main/java/org/cytoscape/work/swing/GUITaskManager.java
2010-10-27 23:02:41 UTC (rev 22531)
@@ -7,6 +7,10 @@
import org.cytoscape.work.TaskFactory;
+/**
+ * A Swing specific extension of {...@link TaskManager} that allows a
+ * JPanels to be used to present the {...@link org.cytoscape.work.Tunable}s.
+ */
public interface GUITaskManager extends TaskManager {
/**
* Sets the parent panel on the TunableInterceptor that it manages.
@@ -15,8 +19,10 @@
void setParent(final JPanel parent);
/**
- * @param taskFactory a non-null task factory
- * @return the panel generated from the tunables annotating
"taskFactory" or null if "taskFactory" has no tunables
+ * Returns the configuration panel for the specified task factory.
+ * @param taskFactory a non-null task factory
+ * @return the panel generated from the tunables annotating
"taskFactory"
+ * or null if "taskFactory" has no tunables
*/
JPanel getConfigurationPanel(final TaskFactory taskFactory);
-}
\ No newline at end of file
+}
Modified:
core3/work-swing-api/trunk/src/main/java/org/cytoscape/work/swing/GUITunableHandler.java
===================================================================
---
core3/work-swing-api/trunk/src/main/java/org/cytoscape/work/swing/GUITunableHandler.java
2010-10-27 22:45:33 UTC (rev 22530)
+++
core3/work-swing-api/trunk/src/main/java/org/cytoscape/work/swing/GUITunableHandler.java
2010-10-27 23:02:41 UTC (rev 22531)
@@ -7,23 +7,22 @@
/**
- * Specific <code>Handler</code> for construction of GUI
- *
- * Access to the <code>Handler</code> for any type of <code>Tunable</code>
will be provided by using this interface
- *
- * @author pasteur
- *
+ * Specific <code>Handler</code> for construction of GUI.
+ * Access to the <code>Handler</code> for any type of <code>Tunable</code>
+ * will be provided by using this interface
*/
public interface GUITunableHandler extends TunableHandler {
/**
- * to get the panel that contains the GUI representation
(<code>JTextField, JFileChooser, JLabel, JList ...</code>)
+ * to get the panel that contains the GUI representation
+ * (<code>JTextField, JFileChooser, JLabel, JList ...</code>)
*
* @return the panel containing GUI
*/
JPanel getJPanel();
/**
- * To get the current value of a <code>Handler</code> (or path for a
<code>FileHandler</code>, or selected item(s)
+ * To get the current value of a <code>Handler</code>
+ * (or path for a <code>FileHandler</code>, or selected item(s)
* for <code>ListMultipleSelection ListSingleSelection</code>, ...)
*
* @return string representing the state
@@ -32,7 +31,8 @@
/**
- * Use to set the intercepted object (with <code>Tunable</code>
annotation) with the new <i>"value"</i> that has been chosen or entered by the
user through GUI
+ * Use to set the intercepted object (with <code>Tunable</code>
annotation)
+ * with the new <i>"value"</i> that has been chosen or entered by the
user through GUI.
*/
void handle();
@@ -50,15 +50,16 @@
void addDependent(GUITunableHandler gh);
/**
- * Check if the dependency matches with the rule provided on the other
<code>GUITunableHandler</code>
+ * Check if the dependency matches with the rule provided on the
+ * other <code>GUITunableHandler</code>
* <p>
- * <pre>
- * the checking is dynamically done.
+ * The checking is done dynamically.
+ * <p>
*
- * If it matches : the GUI for this <code>GUITunableHandler</code> is
available, or not if it doesn't match
- *
- * the dependency can me made on String, a boolean value, a specific
value for an Integer,Double..., a selected item of a list ...
- * </pre>
+ * If it matches : the GUI for this <code>GUITunableHandler</code> is
available,
+ * or not if it doesn't match the dependency can me made on String,
+ * a boolean value, a specific value for
+ * an Integer,Double..., a selected item of a list ...
* </p>
*
* @param name of the <code>GUITunableHandler</code> on which it depends
@@ -67,7 +68,8 @@
void checkDependency(String name, String state);
/**
- * Get the new "values" for the <code>Tunables</code> object that have
been modified if their JPanel is enabled : if the dependencies are matching
+ * Get the new "values" for the <code>Tunables</code> object that have
+ * been modified if their JPanel is enabled : if the dependencies are
matching
*/
void handleDependents();
Modified:
core3/work-swing-api/trunk/src/main/java/org/cytoscape/work/swing/GUITunableInterceptor.java
===================================================================
---
core3/work-swing-api/trunk/src/main/java/org/cytoscape/work/swing/GUITunableInterceptor.java
2010-10-27 22:45:33 UTC (rev 22530)
+++
core3/work-swing-api/trunk/src/main/java/org/cytoscape/work/swing/GUITunableInterceptor.java
2010-10-27 23:02:41 UTC (rev 22531)
@@ -9,21 +9,27 @@
/**
- * Provides methods to intercept the Objects annotated as
<code>@Tunable</code>, use, and display them.
- * Intended to be used as an OSGi server.
- * @param <TH> <code>TunableHandler</code>s that will be detected. It will
contain the information provided
+ * Provides methods to intercept the Objects annotated as
<code>@Tunable</code>,
+ * use, and display them.
+ * Intended to be used as an OSGi service.
+ * @param <TH> <code>TunableHandler</code>s that will be detected.
+ * It will contain the information provided
* by the <code>@Tunable</code> annotations and the Object itself.
* @author Pasteur
*/
public interface GUITunableInterceptor<TH extends TunableHandler> extends
TunableInterceptor<TH> {
/**
- * Identify Tunables of an Object o and assign a <code>Handler</code>
to each <code>Tunable</code>.
+ * Identify Tunables of an Object o and assign a <code>Handler</code>
to
+ * each <code>Tunable</code>.
*
- * This method detects the fields and the methods of the object o, then
searches for <code>@Tunable</code> annotations, and finally creates a
+ * This method detects the fields and the methods of the object o, then
searches
+ * for <code>@Tunable</code> annotations, and finally creates a
* <code>Handler</code> for each type of Object by using the
<code>HandlerFactory</code>.
- * The handlers are stored in a HashMap and can then be retrieved by
their key (i.e name of the field or method).
+ * The handlers are stored in a HashMap and can then be retrieved by
their key
+ * (i.e name of the field or method).
*
- * @param o This has to be an instance of a class that contains at
least one <code>@Tunable</code> annotation.
+ * @param o This has to be an instance of a class that contains at
least
+ * one <code>@Tunable</code> annotation.
*/
void loadTunables(Object o);
@@ -31,13 +37,16 @@
* Returns the Map that contains all the <code>Handler</code>s for the
Object <code>o</code>.
*
* @param o An Object on which the loadTunable() method has previously
been executed.
- * @return The Map with all the <code>Handlers</code> that have been
previously assigned to <code>o</code>.
+ * @return The Map with all the <code>Handlers</code> that have been
previously assigned
+ * to <code>o</code>.
*/
Map<String, TH> getHandlers(Object o);
/**
- * @param obs objects which are instances classes with
<code>Tunables</code> that need to be displayed to a user.
- * @return a panel that contains a visual representation of the
tunables and is appropriate for embedding in a dialog or another panel
+ * @param obs objects which are instances classes with
<code>Tunables</code> that need
+ * to be displayed to a user.
+ * @return a panel that contains a visual representation of the
tunables and is
+ * appropriate for embedding in a dialog or another panel
*/
JPanel getUI(Object... obs);
--
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.
