Author: mkirby
Date: 2011-10-05 14:25:56 -0700 (Wed, 05 Oct 2011)
New Revision: 27073
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/AbstractVisualProperty.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexicon.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualProperty.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveEdgeViewsEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveEdgeViewsListener.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveNodeViewsEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveNodeViewsListener.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedEdgeViewsEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedEdgeViewsListener.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedNodeViewsEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedNodeViewsListener.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/EdgeViewsChangedListener.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/FitContentEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/FitSelectedEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAboutToBeDestroyedEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAboutToBeDestroyedListener.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAddedEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAddedListener.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewChangedListener.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewDestroyedEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewDestroyedListener.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NodeViewsChangedListener.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/UpdateNetworkPresentationEvent.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/AbstractVisualProperty.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/AbstractVisualProperty.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/AbstractVisualProperty.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -38,6 +38,7 @@
/**
* An abstract implementation of VisualProperty that omits the methods dealing
* with serializing data.
+ * @param <T> the generic type for this AbstractVisualProperty.
*
*/
public abstract class AbstractVisualProperty<T> implements VisualProperty<T> {
@@ -64,7 +65,7 @@
*
* @param defaultValue default value for this visual property.
* @param id unique string for serialization.
- * @param name human-readable name for this visual property.
+ * @param displayName human-readable name for this visual property.
*
*/
@SuppressWarnings("unchecked")
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexicon.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexicon.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexicon.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -39,9 +39,9 @@
/**
*
- * A {@linkplain RenderingEngine} should provide <strong>one,
immutable</strong> lexicon implementing this interface.
+ * A {@linkplain org.cytoscape.view.presentation.RenderingEngine} should
provide <strong>one, immutable</strong> lexicon implementing this interface.
*
- * This is a pre-defined tree of VisualProperties designed by the {@linkplain
RenderingEngine} developer.
+ * This is a pre-defined tree of VisualProperties designed by the {@linkplain
org.cytoscape.view.presentation.RenderingEngine} developer.
*
* @since Cytoscape 3.0
*
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualProperty.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualProperty.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualProperty.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -78,6 +78,9 @@
/**
* Returns a string of the specified value suitable for serializing to
XML
* other text output.
+ * @param value the specified value.
+ * @return a string of the specified value suitable for serializing to
XML
+ * other text output.
*/
String toSerializableString(final T value);
@@ -85,6 +88,8 @@
/**
* Returns an object of type T given a string serialized from the
getSerializableString(T value)
* method.
+ * @return an object of type T given a string serialized from the
getSerializableString(T value)
+ * method.
*/
T parseSerializableString(final String value);
@@ -100,7 +105,7 @@
/**
* VisualProperty is always associated with a data type. For example,
EDGE_COLOR is associated with
- * {@link CyEdge} data object. In that case, this returns
Class<CyEdge>.
+ * {@link org.cytoscape.model.CyEdge} data object. In that case, this
returns Class<CyEdge>.
* For now, return data types are CyNode, CyEdge, and CyNetwork.
*
* @return target data type of this visual property. CyNode, CyEdge,
or CyNetwork.
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveEdgeViewsEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveEdgeViewsEvent.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveEdgeViewsEvent.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -8,10 +8,20 @@
import org.cytoscape.view.model.View;
import org.cytoscape.model.CyEdge;
+/**
+ * When edge {@link View}s are about to be removed from a {@linkplain
CyNetworkView}, this event will be fired.
+ */
public class AboutToRemoveEdgeViewsEvent extends
AbstractCyEvent<CyNetworkView> {
private final Collection<View<CyEdge>> payload;
+ /**
+ * Creates the event for about to be removed edge views.
+ *
+ * @param source network view which includes the edge views about to be
removed.
+ * @param payload Collection of edge view objects about to be removed.
+ *
+ */
public AboutToRemoveEdgeViewsEvent(CyNetworkView source,
Collection<View<CyEdge>> payload) {
super(source,AboutToRemoveEdgeViewsListener.class);
if ( payload == null )
@@ -19,6 +29,10 @@
this.payload = payload;
}
+ /**
+ * Returns the Collection of Views of type CyEdge that are about to be
removed.
+ * @return the Collection of Views of type CyEdge that are about to be
removed.
+ * */
public Collection<View<CyEdge>> getEdgeViews() {
return payload;
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveEdgeViewsListener.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveEdgeViewsListener.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveEdgeViewsListener.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -2,7 +2,16 @@
import org.cytoscape.event.CyListener;
+/**
+ * Listener for {@linkplain AboutToRemoveEdgeViewsEvent}.
+ *
+ */
public interface AboutToRemoveEdgeViewsListener extends CyListener {
+ /**
+ * Process event
+ *
+ * @param e the {@link AboutToRemoveEdgeViewsEvent} to be handled.
+ */
void handleEvent(AboutToRemoveEdgeViewsEvent e);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveNodeViewsEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveNodeViewsEvent.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveNodeViewsEvent.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -7,15 +7,29 @@
import org.cytoscape.view.model.View;
import org.cytoscape.model.CyNode;
+/**
+ * When node {@link View}s are about to be removed from a {@linkplain
CyNetworkView}, this event will be fired.
+ */
public class AboutToRemoveNodeViewsEvent extends
AbstractCyEvent<CyNetworkView> {
private final Collection<View<CyNode>> payload;
+ /**
+ * Creates the event for about to be removed node views.
+ *
+ * @param source network view which includes the node views about to be
removed.
+ * @param payload Collection of node view objects about to be removed.
+ *
+ */
public AboutToRemoveNodeViewsEvent(CyNetworkView source,
Collection<View<CyNode>> payload) {
super(source,AboutToRemoveNodeViewsListener.class);
this.payload = payload;
}
+ /**
+ * Returns a Collection of Views of type CyNode that are about to be
removed.
+ * @return a Collection of Views of type CyNode that are about to be
removed.
+ * */
public Collection<View<CyNode>> getNodeViews() {
return payload;
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveNodeViewsListener.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveNodeViewsListener.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveNodeViewsListener.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -2,6 +2,16 @@
import org.cytoscape.event.CyListener;
+/**
+ * Listener for {@linkplain AboutToRemoveNodeViewsEvent}.
+ *
+ */
public interface AboutToRemoveNodeViewsListener extends CyListener{
+
+ /**
+ * Process event
+ *
+ * @param e the {@link AboutToRemoveNodeViewsEvent} to be handled.
+ */
void handleEvent(AboutToRemoveNodeViewsEvent e);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedEdgeViewsEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedEdgeViewsEvent.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedEdgeViewsEvent.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -16,10 +16,10 @@
/**
- * Creates the event for a new edge view.
+ * Creates the event for new edge views.
*
* @param source network view which includes the new edge view.
- * @param edgeView Newly created view object for an edge.
+ * @param edgeViews Collection of newly created view object for an edge.
*
*/
public AddedEdgeViewsEvent(final CyNetworkView source, final
Collection<View<CyEdge>> edgeViews) {
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedEdgeViewsListener.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedEdgeViewsListener.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedEdgeViewsListener.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -12,7 +12,7 @@
/**
* Process event
*
- * @param e
+ * @param e the {@link AddedEdgeViewsEvent} to be handled.
*/
public void handleEvent(AddedEdgeViewsEvent e);
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedNodeViewsEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedNodeViewsEvent.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedNodeViewsEvent.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -18,7 +18,7 @@
* Creates the event for a new node view.
*
* @param source network view which includes the new node view.
- * @param nodeView Newly created view object for a node.
+ * @param nodeViews Collection of newly created view object for a node.
*
*/
public AddedNodeViewsEvent(final CyNetworkView source, final
Collection<View<CyNode>> nodeViews) {
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedNodeViewsListener.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedNodeViewsListener.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedNodeViewsListener.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -10,9 +10,9 @@
public interface AddedNodeViewsListener extends CyListener {
/**
- * Process event.
+ * Process event
*
- * @param e
+ * @param e the {@link AddedNodeViewsEvent} to be handled.
*/
public void handleEvent(AddedNodeViewsEvent e);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/EdgeViewsChangedListener.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/EdgeViewsChangedListener.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/EdgeViewsChangedListener.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -2,6 +2,16 @@
import org.cytoscape.event.CyListener;
+/**
+ * Listener for {@linkplain EdgeViewsChangedEvent}.
+ *
+ */
public interface EdgeViewsChangedListener extends CyListener {
+
+ /**
+ * Process event
+ *
+ * @param e the {@link EdgeViewsChangedEvent} to be handled.
+ */
void handleEvent(EdgeViewsChangedEvent e);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/FitContentEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/FitContentEvent.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/FitContentEvent.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -8,7 +8,7 @@
* <p>
* This event should
* be created and fired by the view being updated and not anyone else,
- * instead call the {@link CyNetworkView.fitContent()} method.
+ * instead call the {@link CyNetworkView#fitContent()} method.
*/
public final class FitContentEvent extends AbstractCyEvent<CyNetworkView> {
@@ -17,7 +17,7 @@
* <p>
* This event should
* be created and fired by the view being updated and not anyone else,
- * instead call the {@link CyNetworkView.fitContent()} method.
+ * instead call the {@link CyNetworkView#fitContent()} method.
*
* @param source network view to be fitted to the container.
*/
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/FitSelectedEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/FitSelectedEvent.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/FitSelectedEvent.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -9,7 +9,7 @@
* <p>
* This event should
* be created and fired by the view being updated and not anyone else,
- * instead call the {@link CyNetworkView.fitSelected()} method.
+ * instead call the {@link CyNetworkView#fitSelected()} method.
*/
public final class FitSelectedEvent extends AbstractCyEvent<CyNetworkView> {
@@ -19,7 +19,7 @@
* <p>
* This event should
* be created and fired by the view being updated and not anyone else,
- * instead call the {@link CyNetworkView.fitSelected()} method.
+ * instead call the {@link CyNetworkView#fitSelected()} method.
*
* @param source target network view for fitting.
*/
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAboutToBeDestroyedEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAboutToBeDestroyedEvent.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAboutToBeDestroyedEvent.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -3,12 +3,19 @@
import org.cytoscape.view.model.CyNetworkViewManager;
import org.cytoscape.view.model.CyNetworkView;
+import org.cytoscape.view.model.View;
/**
- *
+ * When a {@link CyNetworkView} is about to be destroyed, this event will be
fired.
*/
public final class NetworkViewAboutToBeDestroyedEvent extends
AbstractNetworkViewEvent {
+ /**
+ * Creates the event for network views that are about to be destroyed.
+ *
+ * @param source the {@link CyNetworkViewManager} of the CyNetworkView
about to be destroyed.
+ * @param view the {@link CyNetworkView} about to be destroyed.
+ */
public NetworkViewAboutToBeDestroyedEvent(final CyNetworkViewManager
source, final CyNetworkView view) {
super(source, NetworkViewAboutToBeDestroyedListener.class,
view);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAboutToBeDestroyedListener.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAboutToBeDestroyedListener.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAboutToBeDestroyedListener.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -5,8 +5,15 @@
/**
- *
+ * Listener for {@linkplain NetworkViewAboutToBeDestroyedEvent}.
+ *
*/
public interface NetworkViewAboutToBeDestroyedListener extends CyListener {
+
+ /**
+ * Process event
+ *
+ * @param e the {@link NetworkViewAboutToBeDestroyedEvent} to be
handled.
+ */
public void handleEvent(NetworkViewAboutToBeDestroyedEvent e);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAddedEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAddedEvent.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAddedEvent.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -3,12 +3,19 @@
import org.cytoscape.view.model.CyNetworkViewManager;
import org.cytoscape.view.model.CyNetworkView;
+import org.cytoscape.view.model.View;
/**
- *
+ * When a {@link CyNetworkView} is added to a {@linkplain
CyNetworkViewManager}, this event will be fired.
*/
public final class NetworkViewAddedEvent extends AbstractNetworkViewEvent {
+ /**
+ * Creates the event for network views that are added.
+ *
+ * @param source the {@link CyNetworkViewManager} that the
CyNetworkView was added to.
+ * @param view the {@link CyNetworkView} that was added.
+ */
public NetworkViewAddedEvent(final CyNetworkViewManager source, final
CyNetworkView view) {
super(source, NetworkViewAddedListener.class, view);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAddedListener.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAddedListener.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewAddedListener.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -5,8 +5,15 @@
/**
- *
+ * Listener for {@linkplain NetworkViewAddedEvent}.
+ *
*/
public interface NetworkViewAddedListener extends CyListener {
+
+ /**
+ * Process event
+ *
+ * @param e the {@link NetworkViewAddedEvent} to be handled.
+ */
public void handleEvent(NetworkViewAddedEvent e);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewChangedListener.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewChangedListener.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewChangedListener.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -2,6 +2,16 @@
import org.cytoscape.event.CyListener;
+/**
+ * Listener for {@linkplain NetworkViewChangedEvent}.
+ *
+ */
public interface NetworkViewChangedListener extends CyListener {
+
+ /**
+ * Process event
+ *
+ * @param e the {@link NetworkViewChangedEvent} to be handled.
+ */
void handleEvent(NetworkViewChangedEvent e);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewDestroyedEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewDestroyedEvent.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewDestroyedEvent.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -1,14 +1,20 @@
package org.cytoscape.view.model.events;
+import org.cytoscape.view.model.CyNetworkView;
import org.cytoscape.view.model.CyNetworkViewManager;
import org.cytoscape.event.AbstractCyEvent;
/**
- *
+ * When a {@link CyNetworkView} is destroyed, this event will be fired.
*/
public final class NetworkViewDestroyedEvent extends
AbstractCyEvent<CyNetworkViewManager> {
+ /**
+ * Creates the event for network views that are destroyed.
+ *
+ * @param source the {@link CyNetworkViewManager} of the CyNetworkView
that was destroyed.
+ */
public NetworkViewDestroyedEvent(final CyNetworkViewManager source) {
super(source, NetworkViewDestroyedListener.class);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewDestroyedListener.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewDestroyedListener.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewDestroyedListener.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -5,8 +5,15 @@
/**
- *
+ * Listener for {@linkplain NetworkViewDestroyedEvent}.
+ *
*/
public interface NetworkViewDestroyedListener extends CyListener {
+
+ /**
+ * Process event
+ *
+ * @param e the {@link NetworkViewDestroyedEvent} to be handled.
+ */
public void handleEvent(NetworkViewDestroyedEvent e);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NodeViewsChangedListener.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NodeViewsChangedListener.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NodeViewsChangedListener.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -2,6 +2,16 @@
import org.cytoscape.event.CyListener;
+/**
+ * Listener for {@linkplain NodeViewsChangedEvent}.
+ *
+ */
public interface NodeViewsChangedListener extends CyListener {
+
+ /**
+ * Process event
+ *
+ * @param e the {@link NodeViewsChangedEvent} to be handled.
+ */
void handleEvent(NodeViewsChangedEvent e);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/UpdateNetworkPresentationEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/UpdateNetworkPresentationEvent.java
2011-10-05 21:23:57 UTC (rev 27072)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/UpdateNetworkPresentationEvent.java
2011-10-05 21:25:56 UTC (rev 27073)
@@ -12,7 +12,7 @@
* <p>
* This event should
* be created and fired by the view being updated and not anyone else,
- * instead call the {@link CyNetworkView.updateView()} method.
+ * instead call the {@link CyNetworkView#updateView()} method.
*/
public final class UpdateNetworkPresentationEvent extends
AbstractCyEvent<CyNetworkView> {
@@ -22,7 +22,7 @@
* <p>
* This event should
* be created and fired by the view being updated and not anyone else,
- * instead call the {@link CyNetworkView.updateView()} method.
+ * instead call the {@link CyNetworkView#updateView()} method.
*
* @param source source network view-model. Presentations
* associated with this view-model use this event.
--
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.
