idare.imagenode.internal.VisualStyle

Class StyleManager

java.lang.Object

idare.imagenode.internal.VisualStyle.StyleManager

All Implemented Interfaces:

GraphicsChangedListener, org.cytoscape.event.CyListener, org.cytoscape.session.events.SessionAboutToBeSavedListener, org.cytoscape.session.events.SessionLoadedListener

public class StyleManager
extends Object
implements org.cytoscape.session.events.SessionAboutToBeSavedListener, org.cytoscape.session.events.SessionLoadedListener, GraphicsChangedListener

The StyleManager handles the availability of Images in a given Style. It will save properties of the original style and restore them, if the nodes are removed. During save/load only earlier mappings used by the style will not be recovered and only the default properties will be used.

Author:

Thomas Pfau

Constructor Summary

Constructors

Constructor and Description
StyleManager(ImageStorage imf, org.cytoscape.view.vizmap.VisualMappingManager vmmServiceRef, org.cytoscape.view.model.CyNetworkViewManager cyNetViewMgr, org.cytoscape.event.CyEventHelper eventHelper, NodeManager nm, org.cytoscape.application.CyApplicationManager cyAppMgr, ActiveNodeManager anm) Default Constructor.

Method Summary

Modifier and Type	Method and Description
void	addNodes(org.cytoscape.work.TaskMonitor monitor) Add nodes to the currently used Style, and update the TaskMonitor to indicate the current activity.
void	addNodesToStyleDuringLoad(org.cytoscape.work.TaskMonitor monitor, org.cytoscape.view.vizmap.VisualStyle styleToModify) Add nodes to the defined Style, and update the TaskMonitor to indicate the current activity.
void	handleEvent(org.cytoscape.session.events.SessionAboutToBeSavedEvent e)
void	handleEvent(org.cytoscape.session.events.SessionLoadedEvent e)
void	imageUpdated(GraphicsChangedEvent e) Update according to the updated images provided in this event.
void	removeNodes(org.cytoscape.work.TaskMonitor monitor) Remove the IDARE Ndoes from the current Visualstyle (if they were added) and restore default values.
void	setAddNodesTaskFactory(AddNodesToStyleTaskFactory factory) set the AddNodesTaskFactory
void	shutDown() Restore the stored values to all styles.
boolean	styleUsed(String StyleName) Test whether a given Style uses IDARE Image Nodes.
boolean	viewUsesStyleWithNodes(org.cytoscape.view.model.CyNetworkView view) Test whether a given NetworkView uses a Style containing ImageNodes.

Methods inherited from class java.lang.Object

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

Constructor Detail

StyleManager

public StyleManager(ImageStorage imf,
                    org.cytoscape.view.vizmap.VisualMappingManager vmmServiceRef,
                    org.cytoscape.view.model.CyNetworkViewManager cyNetViewMgr,
                    org.cytoscape.event.CyEventHelper eventHelper,
                    NodeManager nm,
                    org.cytoscape.application.CyApplicationManager cyAppMgr,
                    ActiveNodeManager anm)

Default Constructor.

Parameters:

imf - The ImageStore for the Manager

vmmServiceRef - the VisualMappingManager to use

cyNetViewMgr - The CyNetworkViewManager to use

eventHelper - the CyEventHelper to use

nm - the NodeManager to use

cyAppMgr - the CyApplicationManager to use

anm - the ActiveNodeManager to use

Method Detail

setAddNodesTaskFactory

public void setAddNodesTaskFactory(AddNodesToStyleTaskFactory factory)

set the AddNodesTaskFactory

Parameters:

factory - The Factory to use

addNodes

public void addNodes(org.cytoscape.work.TaskMonitor monitor)

Add nodes to the currently used Style, and update the TaskMonitor to indicate the current activity.

Parameters:

monitor - the TaskMonitor to use

addNodesToStyleDuringLoad

public void addNodesToStyleDuringLoad(org.cytoscape.work.TaskMonitor monitor,
                                      org.cytoscape.view.vizmap.VisualStyle styleToModify)

Add nodes to the defined Style, and update the TaskMonitor to indicate the current activity. Add the Nodes to the style assuming this is happening during a session load (i.e. we only store the default values).

Parameters:

monitor - the TaskMonitor to use

styleToModify - the style to add nodes to

removeNodes

public void removeNodes(org.cytoscape.work.TaskMonitor monitor)

Remove the IDARE Ndoes from the current Visualstyle (if they were added) and restore default values.

Parameters:

monitor - the TaskMonitor to use

shutDown

public void shutDown()

Restore the stored values to all styles.

handleEvent

public void handleEvent(org.cytoscape.session.events.SessionLoadedEvent e)

Specified by:

handleEvent in interface org.cytoscape.session.events.SessionLoadedListener

handleEvent

public void handleEvent(org.cytoscape.session.events.SessionAboutToBeSavedEvent e)

Specified by:

handleEvent in interface org.cytoscape.session.events.SessionAboutToBeSavedListener

styleUsed

public boolean styleUsed(String StyleName)

Test whether a given Style uses IDARE Image Nodes.

Parameters:

StyleName - The Style to test

Returns:

whether the provided StyleName is one of the names of styles using image nodes

viewUsesStyleWithNodes

public boolean viewUsesStyleWithNodes(org.cytoscape.view.model.CyNetworkView view)

Test whether a given NetworkView uses a Style containing ImageNodes.

Parameters:

view - - the view to check

Returns:

whether the provided CyNetworkView uses a style that contains image nodes.

imageUpdated

public void imageUpdated(GraphicsChangedEvent e)

Description copied from interface: GraphicsChangedListener

Update according to the updated images provided in this event.

Specified by:

imageUpdated in interface GraphicsChangedListener

Parameters:

e - the GraphicsChangedEvent to process