Cytoscape 3.0.1 API

org.cytoscape.view.vizmap.events
Class VisualStyleAboutToBeRemovedEvent

java.lang.Object
  extended by org.cytoscape.event.AbstractCyEvent<VisualMappingManager>
      extended by 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.


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
VisualStyleAboutToBeRemovedEvent(VisualMappingManager source, VisualStyle style)
          Create an event for the removed VisualStyle.
 
Method Summary
 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.

Cytoscape 3.0.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.