Author: mes
Date: 2012-04-23 10:54:18 -0700 (Mon, 23 Apr 2012)
New Revision: 28945
Removed:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/EdgeViewsChangedEvent.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/NodeViewsChangedEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NodeViewsChangedListener.java
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/events/NetworkViewChangedEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/ViewChangeRecord.java
Log:
removed unused events and cleaned up javadoc
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
2012-04-23 02:17:43 UTC (rev 28944)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexicon.java
2012-04-23 17:54:18 UTC (rev 28945)
@@ -38,12 +38,8 @@
import java.util.Set;
/**
- *
- * 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
org.cytoscape.view.presentation.RenderingEngine} developer.
- *
- * @since Cytoscape 3.0
+ * A RenderingEngine should provide <strong>one, immutable</strong> lexicon
implementing this interface.
+ * This is a pre-defined tree of VisualProperties designed by the
RenderingEngine developer.
* @CyAPI.Api.Interface
*/
public interface VisualLexicon {
Deleted:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/EdgeViewsChangedEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/EdgeViewsChangedEvent.java
2012-04-23 02:17:43 UTC (rev 28944)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/EdgeViewsChangedEvent.java
2012-04-23 17:54:18 UTC (rev 28945)
@@ -1,24 +0,0 @@
-package org.cytoscape.view.model.events;
-
-import java.util.Collection;
-
-import org.cytoscape.event.AbstractCyPayloadEvent;
-import org.cytoscape.model.CyEdge;
-import org.cytoscape.view.model.CyNetworkView;
-
-/**
- * #ASKMIKE
- * @CyAPI.Final.Class
- */
-public final class EdgeViewsChangedEvent extends
AbstractCyPayloadEvent<CyNetworkView, ViewChangeRecord<CyEdge>> {
-
- /**
- * #ASKMIKE
- * @param source
- * @param edgeViewChanges
- */
- public EdgeViewsChangedEvent(CyNetworkView source,
Collection<ViewChangeRecord<CyEdge>> edgeViewChanges) {
- super(source, EdgeViewsChangedListener.class, edgeViewChanges);
- }
-
-}
Deleted:
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
2012-04-23 02:17:43 UTC (rev 28944)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/EdgeViewsChangedListener.java
2012-04-23 17:54:18 UTC (rev 28945)
@@ -1,17 +0,0 @@
-package org.cytoscape.view.model.events;
-
-import org.cytoscape.event.CyListener;
-
-/**
- * Listener for {@linkplain EdgeViewsChangedEvent}.
- * @CyAPI.Spi.Interface
- */
-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/NetworkViewChangedEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewChangedEvent.java
2012-04-23 02:17:43 UTC (rev 28944)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewChangedEvent.java
2012-04-23 17:54:18 UTC (rev 28945)
@@ -7,15 +7,16 @@
import org.cytoscape.view.model.CyNetworkView;
/**
- * #ASKMIKE
+ * Fired to indicated that a {@link CyNetworkView} has been modified in some
way.
* @CyAPI.Final.Class
*/
public final class NetworkViewChangedEvent extends
AbstractCyPayloadEvent<CyNetworkView, ViewChangeRecord<CyNetwork>> {
/**
- * #ASKMIKE
- * @param source
- * @param networkViewChanges
+ * Constructor.
+ * @param source The network view that has changed.
+ * @param networkViewChanges A collection of view change records that
describe the changes made to the
+ * network view.
*/
public NetworkViewChangedEvent(CyNetworkView source,
Collection<ViewChangeRecord<CyNetwork>> networkViewChanges) {
super(source, NetworkViewChangedListener.class,
networkViewChanges);
Deleted:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NodeViewsChangedEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NodeViewsChangedEvent.java
2012-04-23 02:17:43 UTC (rev 28944)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NodeViewsChangedEvent.java
2012-04-23 17:54:18 UTC (rev 28945)
@@ -1,24 +0,0 @@
-package org.cytoscape.view.model.events;
-
-import java.util.Collection;
-
-import org.cytoscape.event.AbstractCyPayloadEvent;
-import org.cytoscape.model.CyNode;
-import org.cytoscape.view.model.CyNetworkView;
-
-/**
- * #ASKMIKE
- * @CyAPI.Final.Class
- */
-public final class NodeViewsChangedEvent extends
AbstractCyPayloadEvent<CyNetworkView, ViewChangeRecord<CyNode>> {
-
- /**
- * #ASKMIKE
- * @param source
- * @param nodeViewChanges
- */
- public NodeViewsChangedEvent(CyNetworkView source,
Collection<ViewChangeRecord<CyNode>> nodeViewChanges) {
- super(source, NodeViewsChangedListener.class, nodeViewChanges);
- }
-}
-
Deleted:
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
2012-04-23 02:17:43 UTC (rev 28944)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NodeViewsChangedListener.java
2012-04-23 17:54:18 UTC (rev 28945)
@@ -1,17 +0,0 @@
-package org.cytoscape.view.model.events;
-
-import org.cytoscape.event.CyListener;
-
-/**
- * Listener for {@linkplain NodeViewsChangedEvent}.
- * @CyAPI.Spi.Interface
- */
-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/ViewChangeRecord.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/ViewChangeRecord.java
2012-04-23 02:17:43 UTC (rev 28944)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/ViewChangeRecord.java
2012-04-23 17:54:18 UTC (rev 28945)
@@ -4,7 +4,7 @@
import org.cytoscape.view.model.VisualProperty;
/**
- * #ASKMIKE Needs class description and method descriptions.
+ * A utility class used to describe one change to a {@link View}.
* @CyAPI.Final.Class
*/
public final class ViewChangeRecord<T> {
@@ -12,6 +12,12 @@
private final VisualProperty<?> vp;
private final Object value;
+ /**
+ * Constructor.
+ * @param view The View that has changed.
+ * @param vp The VisualProperty that has changed.
+ * @param value The value to which the visual property has been set.
+ */
public ViewChangeRecord(View<T> view, VisualProperty<?> vp, Object
value) {
if ( view == null || vp == null )
throw new NullPointerException("View and/or
VisualProperty may not be null");
@@ -19,15 +25,27 @@
this.vp = vp;
this.value = value;
}
-
+
+ /**
+ * Returns the view that has been changed.
+ * @return the view that has been changed.
+ */
public View<T> getView() {
return view;
}
+ /**
+ * Returns the visual property that has been changed.
+ * @return the visual property that has been changed.
+ */
public VisualProperty<?> getVisualProperty() {
return vp;
}
+ /**
+ * Returns the value that the visual property has been changed to.
+ * @return the value that the visual property has been changed to.
+ */
public Object getValue() {
return value;
}
--
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.
