Class 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:


    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 Detail

      • VisualPropertyDependency

        public VisualPropertyDependency​(String id,
                                        String displayName,
                                        Set<VisualProperty<T>> vpSet,
                                        VisualLexicon lexicon)
        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"
        name of this dependency.
      • getIdString

        public String getIdString()
        Provides serializable string of this dependency. Will be used for saving and loading this dependency.
        ID of this dependency.
      • getVisualProperties

        public Set<VisualProperty<?>> getVisualProperties()
        A set of Visual Properties to be set by the parent if locked.
        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.
        enable - Whether to enable (true) or disable (false) this dependency.
      • isDependencyEnabled

        public boolean isDependencyEnabled()
        Returns whether or not this dependency is enabled.
        whether or not this dependency is enabled.
      • getParentVisualProperty

        public VisualProperty<T> getParentVisualProperty()
        Returns the parent visual property for this dependency.
        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.
        eventHelper -
      • hashCode

        public int hashCode()
        hashCode in class Object