Cytoscape 2.6.2 (c) 2006,2007 ISB, MSKCC, UCSD

cytoscape.data.webservice.ui
Interface WebServiceClientGUI<U extends Container>

Type Parameters:
U - GUI component for this service.
All Known Implementing Classes:
WebServiceClientImplWithGUI

public interface WebServiceClientGUI<U extends Container>

Web service client which has custom component should implements this interface. Otherwise, default GUI will be used in the desktop. If this client will be used only through CLI or scripts, this is not required.


Nested Class Summary
static class WebServiceClientGUI.IconSize
          Defines icon type.
 
Method Summary
 List<JMenuItem> getEdgeContextMenuItems(EdgeView ev)
          Return edge context menu if available.
 U getGUI()
          Returns GUI for this client.
 Icon getIcon(WebServiceClientGUI.IconSize t)
          Returns icon for the GUI.
 List<JMenuItem> getNodeContextMenuItems(NodeView nv)
          Return node context menu item if available.
 void setGUI(U gui)
          Set GUI for this service.
 

Method Detail

getGUI

U getGUI()
Returns GUI for this client. Will be used only with Cytoscape Desktop. U is the Component for GUI. In many cases, this is a JPanel.

Returns:
GUI for this service.

setGUI

void setGUI(U gui)
Set GUI for this service.

Parameters:
gui - GUI for this service.

getIcon

Icon getIcon(WebServiceClientGUI.IconSize t)
Returns icon for the GUI. May be used for about page.

Parameters:
t -
Returns:

getNodeContextMenuItems

List<JMenuItem> getNodeContextMenuItems(NodeView nv)
Return node context menu item if available.

Returns:
Custom context menu.

getEdgeContextMenuItems

List<JMenuItem> getEdgeContextMenuItems(EdgeView ev)
Return edge context menu if available.

Returns:

www.cytoscape.org