cytoscape.layout
Class LayoutProperties

java.lang.Object
  cytoscape.layout.LayoutProperties

public class LayoutProperties
extends Object

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

void	add(Tunable tunable) This method is used to add a new Tunable to the LayoutProperties list.
Tunable	get(String name) This method is used to get the Tunable named name from this LayoutProperties.
HashMap	getProperties() getProperties is used to extract properties from the Cytoscape properties file.
JPanel	getTunablePanel() This method returns a JPanel that represents the all of the Tunables associated with this LayoutProperties object.
String	getValue(String name) This method is used to get the value from the Tunable named name from this LayoutProperties.
void	initializeProperties() This method is used to read the properties from the Cytoscape properties file and set the values for that property in the appropriate Tunable.
void	revertProperties() revertProperties is used primarily by the settings dialog mechanism when the user does a "Cancel".
void	saveProperties() saveProperties is used to add modified properties to the Cytoscape properties so they can be saved in the properties file.
void	setProperty(String property, String value) DOCUMENT ME!
void	setSavedProperty(String property, String value) DOCUMENT ME!
void	updateValues() This method calls the updateValues method of each Tunable that is part of this LayoutProperty.

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

add

public void add(Tunable tunable)

This method is used to add a new Tunable to the LayoutProperties list. The Tunable can later be retrieved by name using the get method.

Parameters:

tunable - The Tunable to add to this LayoutProperties

get

public Tunable get(String name)

This method is used to get the Tunable named name from this LayoutProperties. In general, the name of a Tunable should correspond to the last component of the property that it is associated with.

Parameters:

name - The name of the Tunable to retrieve.

Returns:

Tunable associated with name or null if there is no Tunable with that name.

getValue

public String getValue(String name)

This method is used to get the value from the Tunable named name from this LayoutProperties. The value is always returned as a String.

Parameters:

name - The name of the Tunable whose value you want to retrieve.

Returns:

String value from the Tunable or null if there is no Tunable with that name.

updateValues

public void updateValues()

This method calls the updateValues method of each Tunable that is part of this LayoutProperty.

getProperties

public HashMap getProperties()

getProperties is used to extract properties from the Cytoscape properties file. getProperties should always be called first to initialize the property maps.

Returns:

HashMap containing the resulting properties

saveProperties

public void saveProperties()

saveProperties is used to add modified properties to the Cytoscape properties so they can be saved in the properties file.

setProperty

public void setProperty(String property,
                        String value)

DOCUMENT ME!

Parameters:

property - DOCUMENT ME!

value - DOCUMENT ME!

setSavedProperty

public void setSavedProperty(String property,
                             String value)

DOCUMENT ME!

Parameters:

property - DOCUMENT ME!

value - DOCUMENT ME!

revertProperties

public void revertProperties()

revertProperties is used primarily by the settings dialog mechanism when the user does a "Cancel".

initializeProperties

public void initializeProperties()

This method is used to read the properties from the Cytoscape properties file and set the values for that property in the appropriate Tunable. If there is no value for the property, then the default value in the Tunable is used to initialize the property.

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