Cytoscape 2.6.2 (c) 2006,2007 ISB, MSKCC, UCSD

cytoscape.layout
Class LayoutProperties

java.lang.Object
  extended by cytoscape.util.ModulePropertiesImpl
      extended by cytoscape.layout.LayoutProperties
All Implemented Interfaces:
TunableListener, ModuleProperties

public class LayoutProperties
extends ModulePropertiesImpl
implements TunableListener

The LayoutProperties class is a helper class to support the management of settings and properties for layout algorithms that implement CyLayoutAlgorithm or extend AbstractLayout. LayoutProperties objects maintain a list of Tunables that are supplied by the individual algorithms. Each Tunable represents a value that should be loaded from the Cytoscape properties file, and made available as a setting in the LayoutSettingsDialog. Tunables are added to the LayoutProperties using the add method and are retrieved with the get method.


Constructor Summary
LayoutProperties(String propertyPrefix)
          Constructor.
 
Method Summary
 JPanel getTunablePanel()
          This method returns a JPanel that represents the all of the Tunables associated with this LayoutProperties object.
 void tunableChanged(Tunable tunable)
          The tunableChanged method is called whenever a tunable value has been changed by the user (as opposed to programmatically).
 void updateTunablePanel()
          This method is called to update the panel for this property sheet.
 
Methods inherited from class cytoscape.util.ModulePropertiesImpl
add, get, getProperties, getTunableList, getTunables, getValue, initializeProperties, revertProperties, saveProperties, setProperty, setSavedProperty, updateValues
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LayoutProperties

public LayoutProperties(String propertyPrefix)
Constructor.

Parameters:
propertyPrefix - String representing the prefix to be used when pulling properties from the property list.
Method Detail

getTunablePanel

public JPanel getTunablePanel()
This method returns a JPanel that represents the all of the Tunables associated with this LayoutProperties object.

Returns:
JPanel that contains all of the Tunable widgets

updateTunablePanel

public void updateTunablePanel()
This method is called to update the panel for this property sheet.


tunableChanged

public void tunableChanged(Tunable tunable)
Description copied from interface: TunableListener
The tunableChanged method is called whenever a tunable value has been changed by the user (as opposed to programmatically). It can be used by systems to react to user input to improve interactivity or user feedback.

Specified by:
tunableChanged in interface TunableListener
Parameters:
tunable - the Tunable that was changed

www.cytoscape.org