Package org.cytoscape.view.vizmap.events

Class VisualStyleAboutToBeRemovedEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<VisualMappingManager>

org.cytoscape.view.vizmap.events.VisualStyleAboutToBeRemovedEvent

All Implemented Interfaces:

CyEvent<VisualMappingManager>

public final class VisualStyleAboutToBeRemovedEvent
extends AbstractCyEvent<VisualMappingManager>

This event will be fired when VisualStyle object is removed from VisualMappingManager.

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>

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.

Constructor Summary

Constructors

Constructor	Description
VisualStyleAboutToBeRemovedEvent(VisualMappingManager source, VisualStyle style)	Create an event for the removed VisualStyle.

Method Summary

Modifier and Type	Method	Description
VisualStyle	getVisualStyleToBeRemoved()	Returns target VisualStyle to be removed from manager.

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

VisualStyleAboutToBeRemovedEvent

public VisualStyleAboutToBeRemovedEvent(VisualMappingManager source,
                                        VisualStyle style)

Create an event for the removed VisualStyle.

Parameters:

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

style - VisualStyle to be deleted.

Method Detail

getVisualStyleToBeRemoved

public VisualStyle getVisualStyleToBeRemoved()

Returns target VisualStyle to be removed from manager.

Returns:

VisualStyle to be removed from manager.