CytoscapeEditorFramework - Cytoscape Wiki

DRAFT -- STILL BEING WRITTEN -- EXPECT COMPLETION BY 15th DECEMBER 2005

Cytoscape version 2.2 has a set of editors that enable the user to build and modify networks interactively by dragging and dropping nodes and edges from a palette onto the main network view window. The palette contains a set of shapes (for nodes) and arrows (for edges). The shapes on the palette are defined by the current Visual Style, with Node Shape and Node Color mapping into the shape and color of a node, and Edge Target Arrow mapping into the target arrow of an edge.

In Cytoscape version 2.3, the set of classes for the CytoscapeEditor is will be extensible by both developers and end users. End users will be able to extend the editor by defining a new visual style in which Node Shape, Node Color, and Edge Target Arrow are associated with a controlling attribute, defaulting to NODE_TYPE and EDGE_TYPE, respectively. Developers will be able to extend the editor framework by plugging in semantic callback methods that are invoked when editor operations, such as adding and deleting Nodes and Edges, are performed. Such semantic methods might include * restricting the kinds of Nodes that can be connected by a particular type of edge * prompting the user, when adding a Node, to select an entity from a database

Developers may also provide new editors, palette shapes, and event handlers by extending the classes in the editor framework.

The packages, interfaces and classes that exist in the CytoscapeEditor in Cytoscape version 2.2. are:

Package	Class or Interface	Description
cytoscape.editor		top-level classes and interfaces
	CytoscapeEditor	interface for common methods that all editors must implement, such as adding/deleting nodes and edges, handling palette controls
	CytoscapeEditorFactory	Interface used for building new instances of editors. Before an editor can be built, it first needs to be registered with the CytoscapeEditorManager
	CytoscapeEditorManager	Static routines for managing editors, views, event handlers, global variables
	CytoscapeEditorPlugin	encapsulating plugin class that builds the initial set of editor (may be separated out into a separate jar)
	GraphicalEntity	Interface for defining draggable/droppable visual components. Graphical entities are associated with semantic objects, i.e. nodes and edges, that are created when the graphical entities are dropped onto the canvas.
	InvalidEditorException	Creates a new exception when there is no registered editor corresponding to the editor type suppied to the CytoscapeEditorFactory.getEditor() method
cytoscape.editor.editors		classes for editors provided with Cytoscape 2.2
	BasicCytoscapeEditor	provides base-level functionality present in all editors, such as adding and deleting nodes and edges, building palettes
	DefaultCytoscapeEditor	An example editor that extends the Basic'CytoscapeEditor and contains one default node and one default edge on its palette. This editor definesthe nodes and shapes on its palette using the current Visual Style
	SimpleBioMoleculeEditor	an example editor that defines the nodes and shapes on its palette using the SimpleBioMolecule Visual Style, which contains a simple set of colored shapes that represent biological entities
	MapBioMoleculeToVisualStyle	Creates the SimpleBioMolecule Visual Style
	SimpleBioPAX_Editor	an example editor that defines the nodes and shapes on its palette using a Visual Style that maps node shapes and colors according to the value of the "BIOPAX_NODE_TYPE" attribute and maps edge target arrows according to the value of the "BIOPAX_EDGE_TYPE" attribute. (Note that, this is not a fully functional BioPAX editor)
cytoscape.editor.event		event handlers used by the different editors
	NetworkEditEventAdapter	contains stub methods for handling mouse actions, drag/drop actions, attribute value change events
	BasicNetworkEditEventHandler	extends NetworkEditEventAdapter, implementing methods for handling mouse actions, drag/drop actions, attribute value change events, as well as three core methods for creating Nodes and beginning and finishing Edges
	PaletteNetworkEditEventHandler	extends the BasicNetworkEditEventHandler with the capability to drag and drop shapes from a palette onto the canvas
	BioPAXNetworkEditEventHandler	extends the PaletteNetworkEditEventHandler with methods for setting BioPAX-related attributes on Nodes and Edges
cytoscape.editor.impl		implementation and utility classes
	BasicCytoShapeEntity	base class for draggable/droppable shapes on the palette
	CytoShapeIcon	Specialized Icon for Cytoscape editor palette entry. Renders icon based upon input shape, size, color, as defined by the Visual Style that is used by the current editor.
	ShapePalette	methods for building, displaying the palette, adding shapes to the palette, rendering shapes, and handling drag/drop events. (Should this be an Interface with extending classes?)
	CytoscapeEditorFactoryImpl	implementation of CytoscapeEditorFactory Interface, builds new instances of editors and network edit event adapters
	CytoscapeEditorManagerSupport	provides non-static methods needed by the CytoscapeEditorManager, such as listeners for Swing property changes, graph perspective changes, and visual style changes
	StringTransferHandler	base class for the TransferHandler used by the ShapePalette for drag operations
cytoscape.editor.actions		actions associated with buttons and other UI components (some of this has been deferred to Cytoscape version 2.3)
	SetEditorAction	sets up the selected editor from the File -> SetEditor menu. Disables controls for any previously assigned editors. Initializes controls for the new editor. Assigns editor to the current network view
	NewNetworkAction	creates a new network and associates an editor with it
	RestoreAction	Restores any Nodes and/or Edges that have been hidden (removed) from the current network
	DeleteAction	context menu item for deleting selected Nodes and Edges (not used in Cytoscape version 2.2)
	EdgeAction	button action for adding an Edge(not used in Cytoscape version 2.2)
	NodeAction	button action for adding a Node (not used in Cytoscape version 2.2)
	UndoAction	action for undoing an edit (not used in Cytoscape version 2.2)
	RedoAction	action for redoing an edit (not used in Cytoscape version 2.2)

Add a comment about these ideas: ["/Editor_Framework_Comment"]

==Open Issues

How much can be made user-extensible? It would be straightforward to enable the user to define a new palette by building a visual style for it. Could event handling and semantics be made user-extensible as well? Should it be?
Where best to put hooks for semantic processing? Should they be at the point of adding a node and starting and finishing an edge? Should it be more fine-grained, e.g. place a hook in all events that are responded to, such as mousePressed().

More to follow...