Package org.cytoscape.work
Annotation Type ContainsTunables
-
@Retention(RUNTIME) @Target(FIELD) public @interface ContainsTunables
An annotation designed to signal that the annotated field contains fields and methods that are annotated with theTunable
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:
When class B is evaluated for Tunables, it should display a tunable for both the "name" and "value" fields.public class A { @Tunable public int value = 5; } public class B { @ContainsTunable public A a = new A(); @Tunable public String name = "homer"; }
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>
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.
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description double
offset
Returns the offset to the gravity used to place the tunable in the panel.
-
-
-
Element Detail
-
offset
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.Tunable
s are sorted in ascending order based on their gravity values. The firstTunable
to show will be the one with lowest value.- Returns:
- The gravity of the
Tunable
- Default:
- 999.0
-
-