Author: mes
Date: 2010-11-15 12:28:54 -0800 (Mon, 15 Nov 2010)
New Revision: 22852
Added:
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/package-info.java
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/package-info.java
Removed:
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/util/
Modified:
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/CytoscapeAction.java
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/CytoscapeShutdown.java
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/ViewUpdater.java
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedEvent.java
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedListener.java
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedEvent.java
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedListener.java
Log:
javadoc clean up
Modified:
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/CytoscapeAction.java
===================================================================
---
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/CytoscapeAction.java
2010-11-15 20:03:17 UTC (rev 22851)
+++
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/CytoscapeAction.java
2010-11-15 20:28:54 UTC (rev 22852)
@@ -50,7 +50,7 @@
/**
* An abstract implementation of the CyAction interface. Instead of using this
* class directly you should (strongly) consider implementing a
- * {...@link org.cytoscape.application.swing.work.TaskFactory}/{...@link
org.cytoscape.application.swing.work.Task} pair. Doing
+ * org.cytoscape.work.TaskFactory/org.cytoscape.work.Task pair. Doing
* so will allow your action to be used outside of a Swing specific
application
* (which the CyAction interface binds you to)!
*/
@@ -142,7 +142,7 @@
}
/**
- * @inheritdoc
+ * {...@inheritdoc}
*/
public String getName() {
return name;
@@ -175,7 +175,7 @@
}
/**
- * @inheritdoc
+ * {...@inheritdoc}
*/
public float getMenuGravity() {
return menuGravity;
@@ -190,7 +190,7 @@
}
/**
- * @inheritdoc
+ * {...@inheritdoc}
*/
public float getToolbarGravity() {
return toolbarGravity;
@@ -206,14 +206,14 @@
}
/**
- * @inheritdoc
+ * {...@inheritdoc}
*/
public KeyStroke getAcceleratorKeyStroke() {
return acceleratorKeyStroke;
}
/**
- * @inheritdoc
+ * {...@inheritdoc}
*/
public String getPreferredMenu() {
return preferredMenu;
@@ -229,7 +229,7 @@
}
/**
- * @inheritdoc
+ * {...@inheritdoc}
*/
public String getPreferredButtonGroup() {
return preferredButtonGroup;
@@ -244,7 +244,7 @@
}
/**
- * @inheritdoc
+ * {...@inheritdoc}
*/
public boolean useCheckBoxMenuItem() {
return useCheckBoxMenuItem;
Modified:
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/CytoscapeShutdown.java
===================================================================
---
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/CytoscapeShutdown.java
2010-11-15 20:03:17 UTC (rev 22851)
+++
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/CytoscapeShutdown.java
2010-11-15 20:28:54 UTC (rev 22852)
@@ -46,7 +46,7 @@
/**
* Calling this method indicates that the application should shutdown.
* @param retVal The return value with which to (eventually)
- * call {...@link System.exit} with.
+ * call {...@link System#exit} with.
*/
void exit(int retVal);
}
Modified:
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/ViewUpdater.java
===================================================================
---
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/ViewUpdater.java
2010-11-15 20:03:17 UTC (rev 22851)
+++
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/ViewUpdater.java
2010-11-15 20:28:54 UTC (rev 22852)
@@ -67,7 +67,8 @@
}
/**
- * @inheritdoc
+ * Returns the source of the event.
+ * @return the source of the event.
*/
public Object getEventSource() {
return row;
Modified:
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedEvent.java
===================================================================
---
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedEvent.java
2010-11-15 20:03:17 UTC (rev 22851)
+++
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedEvent.java
2010-11-15 20:28:54 UTC (rev 22852)
@@ -6,23 +6,37 @@
import org.cytoscape.event.AbstractCyEvent;
/**
- *
+ * The event fired to indicate that a CytoPanelComponent has been selected.
*/
public final class CytoPanelComponentSelectedEvent extends
AbstractCyEvent<Object> {
private final CytoPanel cp;
private final int index;
+ /**
+ * Constructor.
+ * @param source The object firing the event.
+ * @param cp The CytoPanel on which a component was selected.
+ * @param index The index of the CytoPanelComponent selected.
+ */
public CytoPanelComponentSelectedEvent(final Object source, final
CytoPanel cp, int index) {
super(source, CytoPanelComponentSelectedListener.class);
this.cp = cp;
this.index = index;
}
+ /**
+ * Returns the CytoPanel on which a component was selected.
+ * @return the CytoPanel on which a component was selected.
+ */
public CytoPanel getCytoPanel() {
return cp;
}
+ /**
+ * Returns the index of the CytoPanelComponent selected.
+ * @return the index of the CytoPanelComponent selected.
+ */
public int getSelectedIndex() {
return index;
}
Modified:
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedListener.java
===================================================================
---
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedListener.java
2010-11-15 20:03:17 UTC (rev 22851)
+++
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedListener.java
2010-11-15 20:28:54 UTC (rev 22852)
@@ -4,8 +4,13 @@
import org.cytoscape.event.CyListener;
/**
- *
+ * The listener for handling CytoPanelComponentSelectedEvent.
*/
public interface CytoPanelComponentSelectedListener extends CyListener {
+
+ /**
+ * Handles specified event.
+ * @param e The event to be handled.
+ */
public void handleEvent(CytoPanelComponentSelectedEvent e);
}
Modified:
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedEvent.java
===================================================================
---
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedEvent.java
2010-11-15 20:03:17 UTC (rev 22851)
+++
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedEvent.java
2010-11-15 20:28:54 UTC (rev 22852)
@@ -6,23 +6,37 @@
import org.cytoscape.event.AbstractCyEvent;
/**
- *
+ * An event to indicate that a CytoPanel has changed state.
*/
public final class CytoPanelStateChangedEvent extends AbstractCyEvent<Object> {
private final CytoPanel cp;
private final CytoPanelState newState;
+ /**
+ * Constructor.
+ * @param source The object firing the event.
+ * @param cp The CytoPanel whose state has changed.
+ * @param index The new state of the CytoPanel.
+ */
public CytoPanelStateChangedEvent(final Object source, final CytoPanel
cp, final CytoPanelState newState) {
super(source, CytoPanelStateChangedListener.class);
this.cp = cp;
this.newState = newState;
}
+ /**
+ * Returns the CytoPanel whose state has changed.
+ * @return the CytoPanel whose state has changed.
+ */
public CytoPanel getCytoPanel() {
return cp;
}
+ /**
+ * Returns the new state of the CytoPanel.
+ * @return The new state of the CytoPanel.
+ */
public CytoPanelState getNewState() {
return newState;
}
Modified:
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedListener.java
===================================================================
---
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedListener.java
2010-11-15 20:03:17 UTC (rev 22851)
+++
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedListener.java
2010-11-15 20:28:54 UTC (rev 22852)
@@ -4,8 +4,13 @@
import org.cytoscape.event.CyListener;
/**
- *
+ * A listener for handling CytoPanelStateChangedEvents.
*/
public interface CytoPanelStateChangedListener extends CyListener {
+
+ /**
+ * Handles specified event.
+ * @param e The event to be handled.
+ */
public void handleEvent(CytoPanelStateChangedEvent e);
}
Added:
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/package-info.java
===================================================================
---
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/package-info.java
(rev 0)
+++
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/events/package-info.java
2010-11-15 20:28:54 UTC (rev 22852)
@@ -0,0 +1,6 @@
+
+/**
+ * This package defines the various events fired by
+ * the Cytoscape Swing Application API.
+ */
+package org.cytoscape.application.swing.events;
Added:
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/package-info.java
===================================================================
---
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/package-info.java
(rev 0)
+++
core3/swing-application-api/trunk/src/main/java/org/cytoscape/application/swing/package-info.java
2010-11-15 20:28:54 UTC (rev 22852)
@@ -0,0 +1,6 @@
+
+/**
+ * This package defines the various interfaces, abstract classes, and enums
+ * that represent the Cytoscape Swing Application API.
+ */
+package org.cytoscape.application.swing;
--
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.
