org.cytoscape.task.edit

Interface EditNetworkTitleTaskFactory

All Superinterfaces:

NetworkTaskFactory

public interface EditNetworkTitleTaskFactory
extends NetworkTaskFactory

This interface provides a task iterator for editing a network's title.

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.

Module: core-task-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>core-task-api</artifactId>
</dependency>

Method Summary

Modifier and Type	Method and Description
TaskIterator	createTaskIterator(CyNetwork network, String title) Creates a task iterator for editing a network's title.

Methods inherited from interface org.cytoscape.task.NetworkTaskFactory

createTaskIterator, isReady

Method Detail

createTaskIterator

TaskIterator createTaskIterator(CyNetwork network,
                                String title)

Creates a task iterator for editing a network's title.

Parameters:

network - The network to edit the name of.

title - The new network title.

Returns:

a task ietrator of type TaskIterator.