Author: mes
Date: 2010-10-27 10:56:50 -0700 (Wed, 27 Oct 2010)
New Revision: 22500
Modified:
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/events/FitContentEvent.java
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/events/FitSelectedEvent.java
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/events/UpdateNetworkPresentationEvent.java
Log:
updated javadoc
Modified:
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/events/FitContentEvent.java
===================================================================
---
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/events/FitContentEvent.java
2010-10-27 00:02:42 UTC (rev 22499)
+++
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/events/FitContentEvent.java
2010-10-27 17:56:50 UTC (rev 22500)
@@ -4,19 +4,24 @@
import org.cytoscape.view.model.CyNetworkView;
/**
- * Fit network visualization to the given container.
- *
- * @author kono
- *
+ * Fit network visualization to the given container.
+ * <p>
+ * This event should
+ * be created and fired by the view being updated and not anyone else,
+ * instead call the {...@link CyNetworkView.fitContent()} method.
*/
public final class FitContentEvent extends AbstractCyEvent<CyNetworkView> {
/**
* Fit the size of network view to the current container.
+ * <p>
+ * This event should
+ * be created and fired by the view being updated and not anyone else,
+ * instead call the {...@link CyNetworkView.fitContent()} method.
*
* @param source network view to be fitted to the container.
*/
public FitContentEvent(final CyNetworkView source) {
super(source, FitContentEventListener.class);
}
-}
\ No newline at end of file
+}
Modified:
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/events/FitSelectedEvent.java
===================================================================
---
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/events/FitSelectedEvent.java
2010-10-27 00:02:42 UTC (rev 22499)
+++
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/events/FitSelectedEvent.java
2010-10-27 17:56:50 UTC (rev 22500)
@@ -5,17 +5,25 @@
/**
- * Fit only selected graph object views to the container.
- *
+ * Fit only selected graph object views to the container.
+ * <p>
+ * This event should
+ * be created and fired by the view being updated and not anyone else,
+ * instead call the {...@link CyNetworkView.fitSelected()} method.
*/
public final class FitSelectedEvent extends AbstractCyEvent<CyNetworkView> {
/**
- * Fit the selected part of network view to the container. Usually
this fires event to the presentation payer for redraw.
+ * Fit the selected part of network view to the container.
+ * Usually this fires event to the presentation payer for redraw.
+ * <p>
+ * This event should
+ * be created and fired by the view being updated and not anyone else,
+ * instead call the {...@link CyNetworkView.fitSelected()} method.
*
* @param source target network view for fitting.
*/
public FitSelectedEvent(final CyNetworkView source) {
super(source, FitSelectedEventListener.class);
}
-}
\ No newline at end of file
+}
Modified:
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/events/UpdateNetworkPresentationEvent.java
===================================================================
---
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/events/UpdateNetworkPresentationEvent.java
2010-10-27 00:02:42 UTC (rev 22499)
+++
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/events/UpdateNetworkPresentationEvent.java
2010-10-27 17:56:50 UTC (rev 22500)
@@ -9,15 +9,23 @@
* objects, mainly rendering engines, in the presentation layer. This means by
* firing this event, Cytoscape will invoke "redraw" method in the rendering
* engine.
- *
+ * <p>
+ * This event should
+ * be created and fired by the view being updated and not anyone else,
+ * instead call the {...@link CyNetworkView.updateView()} method.
*/
public final class UpdateNetworkPresentationEvent extends
AbstractCyEvent<CyNetworkView> {
/**
* Event for updating (redrawing) presentation.
+ * <p>
+ * This event should
+ * be created and fired by the view being updated and not anyone else,
+ * instead call the {...@link CyNetworkView.updateView()} method.
*
- * @param source source network view-model. Presentations associated
with this view-model use this event.
+ * @param source source network view-model. Presentations
+ * associated with this view-model use this event.
*/
public UpdateNetworkPresentationEvent(final CyNetworkView source) {
super(source, UpdateNetworkPresentationEventListener.class);
--
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.
