cytoscape.layout
Class LayoutProperties

java.lang.Object
  cytoscape.util.ModulePropertiesImpl
      cytoscape.layout.LayoutProperties

All Implemented Interfaces:

ModuleProperties

public class LayoutProperties
extends ModulePropertiesImpl

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.

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