|
Cytoscape 3.0.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TunableHandler
Interface for classes that deal with reading out and writing back
Tunable
s and their properties. TunableHandler classes
are provided to the system via TunableHandlerFactory
services.
Different presentation mediums (e.g. Swing GUI, command line, etc.)
will demand different TunableHandler and TunableHandlerFactory
implementations to display, parse, get, and set the necessary
Tunable
values. Each different type of object (String, Double,
ListSingleSelection
will need its own
TunableHandler/TunableHandlerFactory
pair to process
fields/methods of that type.
Method Summary | |
---|---|
boolean |
controlsMutuallyExclusiveNestedChildren()
Returns true if the associated Tunable allows switching
of mutually exclusive nested children, else false. |
String |
dependsOn()
Returns the dependsOn property of the associated Tunable . |
String |
getChildKey()
Returns the name of the key that determines the selection of which controlled nested child is currently presented, or the empty string if controlsMutuallyExclusiveNestedChildren() returns false. |
String |
getDescription()
Returns the associated Tunable 's description. |
String[] |
getGroups()
Returns the associated Tunable 's groups or nesting hierarchy. |
String |
getName()
Returns a name representing a tunable property. |
Properties |
getParams()
Returns the parsed result from Tunable.getParams() . |
String |
getQualifiedName()
Returns the name of the underlying class of the tunable followed by a dot and the name of the tunable field or getter/setter root name. |
Class<?> |
getType()
Returns the class type of the field or method annotated by Tunable . |
Object |
getValue()
Returns an object describing a field / get method annotated with Tunable or null if no field / get method has been associated with this handler. |
void |
handle()
Updates an annotated object with the current value as retrieved from the the user interface generated by this handler. |
String[] |
listenForChange()
Returns the listenForChange property of the associated Tunable . |
void |
setValue(Object newValue)
Attempts to set the value of the associated field or set method that has been annotated with Tunable . |
Method Detail |
---|
Object getValue() throws IllegalAccessException, InvocationTargetException
Tunable
or null if no field / get method has been associated with this handler.
IllegalAccessException
InvocationTargetException
void setValue(Object newValue) throws IllegalAccessException, InvocationTargetException
Tunable
.
newValue
- the value to be written into field or set method annotated with Tunable
IllegalAccessException
InvocationTargetException
String getDescription()
Tunable
's description.
Tunable
's descriptionString[] getGroups()
Tunable
's groups or nesting hierarchy.
Tunable
's groups or nesting hierarchyboolean controlsMutuallyExclusiveNestedChildren()
Tunable
allows switching
of mutually exclusive nested children, else false.
Tunable
allows switching
of mutually exclusive nested children, else falseString getChildKey()
String dependsOn()
Tunable
.
String getName()
String getQualifiedName()
Properties getParams()
Tunable.getParams()
.
Tunable.getParams()
void handle()
String[] listenForChange()
Tunable
.
Class<?> getType()
Tunable
.
Tunable
.
|
Cytoscape 3.0.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |