Cytoscape 3.0.0-beta1 API

org.cytoscape.view.vizmap.gui.event
Class SelectedVisualStyleSwitchedEvent

java.lang.Object
  extended by org.cytoscape.event.AbstractCyEvent<Object>
      extended by org.cytoscape.view.vizmap.gui.event.SelectedVisualStyleSwitchedEvent
All Implemented Interfaces:
CyEvent<Object>

public final class SelectedVisualStyleSwitchedEvent
extends AbstractCyEvent<Object>

This event will be fired when current Visual Style is switched.

See Also:
SelectedVisualStyleManager
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
SelectedVisualStyleSwitchedEvent(Object source, VisualStyle lastVS, VisualStyle newVS)
          Constructor for this event.
 
Method Summary
 VisualStyle getLastVisualStyle()
          Returns current Visual Style
 VisualStyle getNewVisualStyle()
          Returns Visual Style to be switched to
 
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

SelectedVisualStyleSwitchedEvent

public SelectedVisualStyleSwitchedEvent(Object source,
                                        VisualStyle lastVS,
                                        VisualStyle newVS)
Constructor for this event.

Parameters:
source - event source object. This can be anything, but usually it is SelectedVisualStyleManager
lastVS - Visual Style currently selected.
newVS - Visual Style to be switched.
Method Detail

getLastVisualStyle

public VisualStyle getLastVisualStyle()
Returns current Visual Style

Returns:
current Visual Style

getNewVisualStyle

public VisualStyle getNewVisualStyle()
Returns Visual Style to be switched to

Returns:
Newly selected Visual Style

Cytoscape 3.0.0-beta1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.