org.cytoscape.view.vizmap.events

Class VisualStyleSetEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<VisualMappingManager>

org.cytoscape.view.vizmap.events.VisualStyleSetEvent

All Implemented Interfaces:

CyEvent<VisualMappingManager>

public final class VisualStyleSetEvent
extends AbstractCyEvent<VisualMappingManager>

Event fired when a VisualStyle is set to a network view through VisualMappingManager.setVisualStyle(VisualStyle, org.cytoscape.view.model.CyNetworkView).

Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Module: vizmap-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>vizmap-api</artifactId>
</dependency>

Constructor Summary

Constructors

Constructor and Description
VisualStyleSetEvent(VisualMappingManager source, VisualStyle style, CyNetworkView view) Creates the event.

Method Summary

Modifier and Type	Method and Description
CyNetworkView	getNetworkView() Get the The target network view model.
VisualStyle	getVisualStyle() Get the VisualStyle that was set to the network view.

Methods inherited from class org.cytoscape.event.AbstractCyEvent

getListenerClass, getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VisualStyleSetEvent

public VisualStyleSetEvent(VisualMappingManager source,
                           VisualStyle style,
                           CyNetworkView view)

Creates the event.

Parameters:

source - Source of this event. This is always VisualMappingManager.

style - The VisualStyle that was set to the network view.

view - The target CyNetworkView.

Method Detail

getVisualStyle

public VisualStyle getVisualStyle()

Get the VisualStyle that was set to the network view.

Returns:

The VisualStyle that was set to the network view.

getNetworkView

public CyNetworkView getNetworkView()

Get the The target network view model.

Returns:

The target CyNetworkView.