Cytoscape 3.1.1 API

org.cytoscape.application.swing
Interface CyNetworkViewDesktopMgr


public interface CyNetworkViewDesktopMgr

Interface for managing CyNetworkViews within the desktop where they reside.


Nested Class Summary
static class CyNetworkViewDesktopMgr.ArrangeType
           
 
Method Summary
 void arrangeWindows(CyNetworkViewDesktopMgr.ArrangeType arrangeType)
          Request the desktop view manager to tile (or untile) the current network windows.
 Rectangle getBounds(CyNetworkView view)
          Get the existing bounds of a given CyNetworkView within the desktop view area.
 Dimension getDesktopViewAreaSize()
          Return the size of the desktop view area where all CyNetworkViews reside.
 void setBounds(CyNetworkView view, Rectangle bounds)
          Set the bounds of a given CyNetworkView within the desktop view area.
 

Method Detail

getDesktopViewAreaSize

Dimension getDesktopViewAreaSize()
Return the size of the desktop view area where all CyNetworkViews reside.

Returns:
Dimension of the width x height (pixels) of the desktop view area.

getBounds

Rectangle getBounds(CyNetworkView view)
Get the existing bounds of a given CyNetworkView within the desktop view area.

Parameters:
view - the CyNetworkView for which to obtain the bounds.
Returns:
a Rectangle whose x,y position is the upper left corner of view and whose width and height are the dimensions of view.

setBounds

void setBounds(CyNetworkView view,
               Rectangle bounds)
Set the bounds of a given CyNetworkView within the desktop view area.

Parameters:
view - the CyNetworkView for which to set the bounds.
bounds - a Rectangle whose x,y position is the desired upper left corner of view and whose width and height are the desired dimensions of view.

arrangeWindows

void arrangeWindows(CyNetworkViewDesktopMgr.ArrangeType arrangeType)
Request the desktop view manager to tile (or untile) the current network windows.

Parameters:
arrangeType - the type of tiling to use. A ArrangeTYpe of CASCADE will revert to cascade (i.e. non-tiled) windows

Cytoscape 3.1.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.