org.cytoscape.work

Annotation Type ContainsTunables

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface ContainsTunables

An annotation designed to signal that the annotated field contains fields and methods that are annotated with the Tunable annotation. The goal is to allow rich tunable collections to be created by combining the tunables found in fields annotated with ContainsTunables.
For example, given classes A and B:

 public class A {
    @Tunable
    public int value = 5;
 }

 public class B {
    @ContainsTunable
    public A a = new A(); 
    @Tunable
    public String name = "homer";
 }

 

When class B is evaluated for Tunables, it should display a tunable for both the "name" and "value" fields.

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: work-api

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

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>work-api</artifactId>
</dependency>

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
double	offset Returns the offset to the gravity used to place the tunable in the panel.

Element Detail

offset

public abstract double offset

Returns the offset to the gravity used to place the tunable in the panel. Gravity is a numeric value associated with each tunable item. Tunables are sorted in ascending order based on their gravity values. The first Tunable to show will be the one with lowest value.

Returns:

The gravity of the Tunable

Default:

999.0