Uses of Interface
org.cytoscape.view.model.View
Package
Description
This package defines the various interfaces, abstract classes, and enums
that represent the Cytoscape Swing Application API.
This package provides factory interfaces to be used by anyone wishing to provide
export or writing capabilities to the rest of Cytoscape.
This package provides base classes for common task factory types as well as their associated task types found in Cytoscape.
This package provides access to the available layout algorithms, as well as provides abstract layout
classes and layout information containers for the convenience of implementing other layout algorithms.
Module for View Models and Visual Properties.
Definitions for View-Model related events and their listeners.
API set for rendering engines (visualizers).
This package provides support for graphical annotations associated with a Cytoscape
CyNetworkView
.This package provides an API for augmenting a
RenderingEngine
s
node rendering with custom graphics.Interfaces for VisualPropertyValues -- ArrowShape, LineType and NodeShape
Visual Mapping basic API module.
APIs for different mapping functions -- continuous mapping, discrete mapping and pass through mapping.
-
Uses of View in org.cytoscape.application.swing
Modifier and TypeMethodDescriptionCyEdgeViewContextMenuFactory.createMenuItem(CyNetworkView netView, View<CyEdge> edgeView)
This method should return a CyMenuItem to be added to the context menu of the specified edge view.CyNodeViewContextMenuFactory.createMenuItem(CyNetworkView netView, View<CyNode> nodeView)
This method should return a CyMenuItem to be added to the context menu of the specified node view.ModifierConstructorDescriptionAbstractViewUpdater(VisualProperty<S> vp, String columnName, Map<CyRow,View<?>> rowViewMap)
Constructor. -
Uses of View in org.cytoscape.io.write
Modifier and TypeMethodDescriptionPresentationWriterManager.getWriter(View<?> view, RenderingEngine<?> re, CyFileFilter filter, File file)
Returns theCyWriter
Task that will attempt to write the specified view to the specified file of the specified file type.PresentationWriterManager.getWriter(View<?> view, RenderingEngine<?> re, CyFileFilter filter, OutputStream os)
Returns theCyWriter
Task that will attempt to write the specified view to the specified output stream of the specified file type. -
Uses of View in org.cytoscape.task
Modifier and TypeFieldDescriptionAbstractEdgeViewTask.edgeView
The edge view that descendant tasks will operate on.AbstractNodeViewTask.nodeView
The node view that descendants of this class will operate on.Modifier and TypeMethodDescriptionEdgeViewTaskFactory.createTaskIterator(View<CyEdge> edgeView, CyNetworkView networkView)
Creates a new TaskIterator using the given edge view and network view.NodeViewTaskFactory.createTaskIterator(View<CyNode> nodeView, CyNetworkView networkView)
Provisions this factory with the node view and its associated network view, both of which will be passed into any task that will be created by this factory.default boolean
EdgeViewTaskFactory.isOn(View<CyEdge> edgeView, CyNetworkView networkView)
If this task factory implements theTogglable
interface then this method determines if the button or check box is on or off.default boolean
NodeViewTaskFactory.isOn(View<CyNode> nodeView, CyNetworkView networkView)
If this task factory implements theTogglable
interface then this method determines if the button or check box is on or off.boolean
AbstractEdgeViewTaskFactory.isReady(View<CyEdge> edgeView, CyNetworkView networkView)
Returns true if the supplied edge and network views are not null.boolean
AbstractNodeViewTaskFactory.isReady(View<CyNode> nodeView, CyNetworkView networkView)
Returns true of the supplied network and node views are not null.boolean
EdgeViewTaskFactory.isReady(View<CyEdge> edgeView, CyNetworkView networkView)
Returns true if this task factory is ready to produce a TaskIterator.boolean
NodeViewTaskFactory.isReady(View<CyNode> nodeView, CyNetworkView networkView)
Returns true if the node view and network view are in a state that is ready to be processed by the generated tasks and false otherwise.ModifierConstructorDescriptionAbstractEdgeViewTask(View<CyEdge> edgeView, CyNetworkView netView)
Base constructor for all tasks that need an edge view to operate on.AbstractNodeViewTask(View<CyNode> nodeView, CyNetworkView netView)
Base class constructor for all tasks that need to operate on a node view and possibly its associated network view. -
Uses of View in org.cytoscape.view.layout
Modifier and TypeFieldDescriptionCyLayoutAlgorithm.ALL_NODE_VIEWS
A convenience declaration for an empty set signifying that all node views should be laid out when creating the task iterator.AbstractLayoutTask.nodesToLayOut
The node views that will be laid out by the algorithm.Modifier and TypeMethodDescriptionLayoutNode.getNodeView()
Accessor function to return the Viewassociated with this LayoutNode. Modifier and TypeMethodDescriptionprotected void
Add a node to this partition.Modifier and TypeMethodDescriptionCyLayoutAlgorithm.createTaskIterator(CyNetworkView networkView, Object layoutContext, Set<View<CyNode>> nodesToLayOut, String layoutAttribute)
Creates a task iterator containing the layout tasks.boolean
AbstractLayoutAlgorithm.isReady(CyNetworkView view, Object tunableContext, Set<View<CyNode>> nodesToLayout, String attributeName)
boolean
CyLayoutAlgorithm.isReady(CyNetworkView networkView, Object layoutContext, Set<View<CyNode>> nodesToLayOut, String layoutAttribute)
Returns true if the task factory is ready to produce a task iterator.ModifierConstructorDescriptionLayoutNode(View<CyNode> nodeView, int index, CyRow row)
The main constructor for a LayoutNode.ModifierConstructorDescriptionAbstractLayoutTask(String displayName, CyNetworkView networkView, Set<View<CyNode>> nodesToLayOut, String layoutAttribute, UndoSupport undo)
Constructor.AbstractParallelPartitionLayoutTask(String displayName, boolean singlePartition, CyNetworkView networkView, Set<View<CyNode>> nodesToLayOut, String layoutAttribute, UndoSupport undo)
Creates a new AbstractPartitionLayoutTask object.AbstractPartitionLayoutTask(String displayName, boolean singlePartition, CyNetworkView networkView, Set<View<CyNode>> nodesToLayOut, String layoutAttribute, UndoSupport undo)
Creates a new AbstractPartitionLayoutTask object.LayoutPartition(CyNetworkView networkView, Collection<View<CyNode>> nodeSet, EdgeWeighter edgeWeighter)
LayoutPartition: use this constructor to create a LayoutPartition that includes the entire network. -
Uses of View in org.cytoscape.view.model
Modifier and TypeInterfaceDescriptioninterface
Additional methods for CyNetworkView.interface
An immutable snapshot of aCyNetworkView
created using theCyNetworkView.createSnapshot()
method.interface
A CyNetwork with no corresponding view.Modifier and TypeMethodDescriptionCyNetworkView.getEdgeView(CyEdge edge)
Returns a View for a specified Edge.CyNetworkViewSnapshot.getEdgeView(long suid)
Returns the immutable edge View for the given view SUID.CyNetworkViewSnapshot.getMutableEdgeView(long suid)
Returns the mutable edge View for the given view SUID, or null if the edge view no longer exists in the mutable network view.CyNetworkViewSnapshot.getMutableNodeView(long suid)
Returns the mutable node View for the given view SUID, or null if the node view no longer exists in the mutable network view.CyNetworkView.getNodeView(CyNode node)
Returns a View for a specified Node.CyNetworkViewSnapshot.getNodeView(long suid)
Returns the immutable node View for the given view SUID.SnapshotEdgeInfo.getSourceNodeView()
Returns the source node view;SnapshotEdgeInfo.getTargetNodeView()
Returns the target node view;Modifier and TypeMethodDescriptionstatic <T, V extends Comparable<V>>
Comparator<View<T>>VisualProperty.comparing(VisualProperty<V> vp)
Utility method for sorting collections of Views according to the value of a VisualProperty.CyNetworkViewSnapshot.getAdjacentEdgeIterable(long nodeSuid)
Returns an Iterable that contains the edges that are adjacent (connected) to the given node.CyNetworkViewSnapshot.getAdjacentEdgeIterable(View<CyNode> node)
Returns an Iterable that contains the edges that are adjacent (connected) to the given node.Collection<View<? extends CyIdentifiable>>
CyNetworkView.getAllViews()
Returns a list of all View including those for Nodes, Edges, and Network.CyNetworkView.getEdgeViews()
Returns a list of Views for all CyEdges in the network.CyNetworkView.getEdgeViewsIterable()
Returns an Iterable for all edge views in the network.CyNetworkView.getNodeViews()
Returns a list of Views for all CyNodes in the network.CyNetworkView.getNodeViewsIterable()
Returns an Iterable for all node views in the network.CyNetworkViewSnapshot.getTrackedEdges(Object key)
Returns edges that were configured to have their VisualProperties tracked usingCyNetworkViewFactoryConfig.addTrackedVisualProperty(Object, VisualProperty, java.util.function.Predicate)
and pass the predicate.CyNetworkViewSnapshot.getTrackedNodes(Object key)
Returns nodes that were configured to have their VisualProperties tracked usingCyNetworkViewFactoryConfig.addTrackedVisualProperty(Object, VisualProperty, java.util.function.Predicate)
and pass the predicate.Modifier and TypeMethodDescriptionCyNetworkViewSnapshot.getAdjacentEdgeIterable(View<CyNode> node)
Returns an Iterable that contains the edges that are adjacent (connected) to the given node.CyNetworkViewSnapshot.getEdgeInfo(View<CyEdge> edge)
Returns an object that provides more information about the given edge.CyNetworkViewSnapshot.getNodeInfo(View<CyNode> node)
Returns an object that provides more information about the given node. -
Uses of View in org.cytoscape.view.model.events
Modifier and TypeMethodDescriptionAboutToRemoveColumnViewEvent.getColumnView()
AddedColumnViewEvent.getColumnView()
ViewChangeRecord.getView()
Returns the view that has been changed.Modifier and TypeMethodDescriptionAddedEdgeViewsEvent.getEdgeViews()
Returns new edge view added to the source network view object.AddedNodeViewsEvent.getNodeViews()
Returns new node view object.ModifierConstructorDescriptionAboutToRemoveColumnViewEvent(CyTableView source, View<CyColumn> columnView)
AddedColumnViewEvent(CyTableView source, View<CyColumn> columnView)
ViewChangeRecord(View<T> view, VisualProperty<?> vp, Object value)
Constructor.ViewChangeRecord(View<T> view, VisualProperty<?> vp, Object value, boolean lockedValue)
ModifierConstructorDescriptionAboutToRemoveEdgeViewsEvent(CyNetworkView source, Collection<View<CyEdge>> payload)
Creates the event for about to be removed edge views.AboutToRemoveNodeViewsEvent(CyNetworkView source, Collection<View<CyNode>> payload)
Creates the event for about to be removed node views.AboutToRemoveRowViewsEvent(CyTableView source, Collection<View<CyRow>> payload)
AddedEdgeViewsEvent(CyNetworkView source, Collection<View<CyEdge>> edgeViews)
Creates the event for new edge views.AddedNodeViewsEvent(CyNetworkView source, Collection<View<CyNode>> nodeViews)
Creates the event for a new node view.AddedRowViewsEvent(CyTableView source, Collection<View<CyRow>> payload)
-
Uses of View in org.cytoscape.view.model.spacial
Modifier and TypeMethodDescriptionEdgeSpacialIndex2DEnumerator.nextEdge()
Returns the next edge.EdgeSpacialIndex2DEnumerator.nextEdgeWithNodeExtents(float[] sourceExtents, float[] targetExtents, View<CyNode>[] nodes)
Returns the next edge.NodeSpacialIndex2DEnumerator.nextNode()
Returns the next node.NodeSpacialIndex2DEnumerator.nextNodeExtents(float[] extents)
Returns the next node.Modifier and TypeMethodDescriptionEdgeSpacialIndex2DEnumerator.nextEdgeWithNodeExtents(float[] sourceExtents, float[] targetExtents, View<CyNode>[] nodes)
Returns the next edge. -
Uses of View in org.cytoscape.view.model.table
Modifier and TypeInterfaceDescriptioninterface
This interface is meant for internal use, it should not be used by Apps.interface
Additional methods for table views.Modifier and TypeMethodDescriptionCyTableView.getColumnView(long viewSuid)
Returns the View for the specified column using its view SUID as key.CyTableView.getColumnView(String fullyQualifiedName)
Returns the View for a specified column.CyTableView.getColumnView(CyColumn column)
Returns the View for a specified column.CyTableView.getRowView(CyRow row)
Returns the View for the specified row.Modifier and TypeMethodDescriptionCyTableView.getColumnViews()
Returns all column views in this table view, in the same order asCyTable.getColumns()
.CyTableView.getRowViews()
Returns all row views in the table view. -
Uses of View in org.cytoscape.view.presentation
Modifier and TypeMethodDescriptionRenderingEngineFactory.createRenderingEngine(Object visualizationContainer, View<T> viewModel)
A view model can have multiple presentations.RenderingEngineManager.getRenderingEngines(View<?> viewModel)
Get rendering engines for the given view model. -
Uses of View in org.cytoscape.view.presentation.annotations
Modifier and TypeMethodDescriptionvoid
ArrowAnnotation.setTarget(View<? extends CyIdentifiable> target)
Set the target for this arrow assuming the target is aView
object. -
Uses of View in org.cytoscape.view.presentation.customgraphics
Modifier and TypeMethodDescriptionvoid
Cy2DGraphicLayer.draw(Graphics2D g, Shape shape, CyNetworkView networkView, View<? extends CyIdentifiable> view)
This method is called by Cytoscape when aCyNetworkView
is being updated in order to let the custom graphics draw onto itsGraphics2D
object.CyCustomGraphics.getLayers(CyNetworkView networkView, View<? extends CyIdentifiable> grView)
Get layers that belong to this object. -
Uses of View in org.cytoscape.view.presentation.property.values
Modifier and TypeMethodDescriptionHandle.calculateHandleLocation(CyNetworkView netView, View<CyEdge> edgeView)
Calculate absolute position of this handle for the given edge view.HandleFactory.createHandle(CyNetworkView graphView, View<CyEdge> view, double x, double y)
Creates a new instance of the Handle.void
Handle.defineHandle(CyNetworkView netView, View<CyEdge> edgeView, double x, double y)
Define this handle. -
Uses of View in org.cytoscape.view.vizmap
Modifier and TypeMethodDescriptionvoid
VisualMappingFunction.apply(CyRow row, View<? extends CyIdentifiable> view)
Apply mapping to the view model.void
VisualStyle.apply(CyRow row, View<? extends CyIdentifiable> view)
Apply Visual Property values only to the given View Object (node or edge).void
Apply Visual Style to the entire table view.TableVisualMappingManager.getVisualStyle(View<CyColumn> viewModel)
Returns theVisualStyle
associated with the target column view model.void
TableVisualMappingManager.setVisualStyle(View<CyColumn> viewModel, VisualStyle visualStyle)
Set aVisualStyle
to the target column view model. -
Uses of View in org.cytoscape.view.vizmap.events.table
Modifier and TypeMethodDescriptionColumnVisualStyleSetEvent.getColumnView()
Get the The target column view model.ModifierConstructorDescriptionColumnVisualStyleSetEvent(TableVisualMappingManager source, VisualStyle style, View<CyColumn> view)
Creates the event. -
Uses of View in org.cytoscape.view.vizmap.mappings
Modifier and TypeMethodDescriptionvoid
AbstractVisualMappingFunction.apply(CyRow row, View<? extends CyIdentifiable> view)