Package org.cytoscape.view.vizmap

Class VisualPropertyDependency<T>

java.lang.Object

org.cytoscape.view.vizmap.VisualPropertyDependency<T>

Type Parameters:

T - type of VisualProperty value in this group.

public final class VisualPropertyDependency<T>
extends Object

Represents a set of Visual Properties to be set by their parent value if dependency is enabled.

Module: vizmap-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>vizmap-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.

Constructor Summary

Constructors

Constructor	Description
VisualPropertyDependency(String id, String displayName, Set<VisualProperty<T>> vpSet, VisualLexicon lexicon)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDisplayName()	Provides human-readable name of this dependency.
String	getIdString()	Provides serializable string of this dependency.
VisualProperty<T>	getParentVisualProperty()	Returns the parent visual property for this dependency.
Set<VisualProperty<?>>	getVisualProperties()	A set of Visual Properties to be set by the parent if locked.
int	hashCode()
boolean	isDependencyEnabled()	Returns whether or not this dependency is enabled.
void	setDependency(boolean enable)	Enables or disables the dependency based on the boolean parameter.
void	setEventHelper(CyEventHelper eventHelper)	The VisualStyle implementation should use this method to pass a valid CyEventHelper after this dependency is added to the visual style object.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VisualPropertyDependency

public VisualPropertyDependency(String id,
                                String displayName,
                                Set<VisualProperty<T>> vpSet,
                                VisualLexicon lexicon)

Constructor.

Parameters:

displayName - A human readable name for use in user interfaces.

vpSet - The set of visual properties.

lexicon - The visual lexicon used by this dependency. The lexicon determines the parent visual property for this dependency.

Method Detail

getDisplayName

public String getDisplayName()

Provides human-readable name of this dependency. For example, "Synchronize edge color to arrow head color," or "Fit Custom Graphics to node"

Returns:

name of this dependency.

getIdString

public String getIdString()

Provides serializable string of this dependency. Will be used for saving and loading this dependency.

Returns:

ID of this dependency.

getVisualProperties

public Set<VisualProperty<?>> getVisualProperties()

A set of Visual Properties to be set by the parent if locked.

Returns:

set of visual properties to be set by parent value.

setDependency

public void setDependency(boolean enable)

Enables or disables the dependency based on the boolean parameter.

Parameters:

enable - Whether to enable (true) or disable (false) this dependency.

isDependencyEnabled

public boolean isDependencyEnabled()

Returns whether or not this dependency is enabled.

Returns:

whether or not this dependency is enabled.

getParentVisualProperty

public VisualProperty<T> getParentVisualProperty()

Returns the parent visual property for this dependency.

Returns:

the parent visual property for this dependency.

setEventHelper

public void setEventHelper(CyEventHelper eventHelper)

The VisualStyle implementation should use this method to pass a valid CyEventHelper after this dependency is added to the visual style object.

Parameters:

eventHelper -

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object