Cytoscape 3.0.1 API

org.cytoscape.view.presentation.property.values
Interface Bend


public interface Bend

Definition of Edge Bends. Bend is an ordered List of Handles.


Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

Method Summary
 List<Handle> getAllHandles()
          Get List of all handles on this edge
 int getIndex(Handle handle)
          Get index of a Handle
 String getSerializableString()
          Create string representation of this object for parsing.
 void insertHandleAt(int index, Handle handle)
          Insert a Handle to the specified position in the Bend
 void removeAllHandles()
          Remove all Handles on this Bend
 void removeHandleAt(int handleIndex)
          Remove a Handle at the given index.
 

Method Detail

getAllHandles

List<Handle> getAllHandles()
Get List of all handles on this edge

Returns:
All Handles belong to this Bend.

insertHandleAt

void insertHandleAt(int index,
                    Handle handle)
Insert a Handle to the specified position in the Bend

Parameters:
index - Position of the new Handle
handle - Handle to be added

removeHandleAt

void removeHandleAt(int handleIndex)
Remove a Handle at the given index.

Parameters:
handleIndex - Index of the Handle to be removed

removeAllHandles

void removeAllHandles()
Remove all Handles on this Bend


getIndex

int getIndex(Handle handle)
Get index of a Handle

Parameters:
handle -
Returns:
Index of the given Handle

getSerializableString

String getSerializableString()
Create string representation of this object for parsing.

Returns:
serializable string.

Cytoscape 3.0.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.