Cytoscape 3.0.0-alpha8-SNAPSHOT API

org.cytoscape.view.model
Class VisualLexiconNode

java.lang.Object
  extended by org.cytoscape.view.model.VisualLexiconNode

public final class VisualLexiconNode
extends Object

A node in the visual property tree (lexicon).

Wrapping a VisualProperty and holding parent-child relationships.

All data fields are immutable.


Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Constructor Summary
VisualLexiconNode(VisualProperty<?> vp, VisualLexiconNode parent)
          Constructs this VisualLexiconNode.
 
Method Summary
 Collection<VisualLexiconNode> getChildren()
          Returns collection of all children of this node.
 VisualLexiconNode getParent()
          Get the parent of this VP node.
 VisualProperty<?> getVisualProperty()
          Returns wrapped VisualProperty object.
 boolean isDepend()
          Returns true if this VisualLexiconNode is dependent on its parent.
 void setDependency(boolean depend)
          Sets the dependency of this VisualLexiconNode.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VisualLexiconNode

public VisualLexiconNode(VisualProperty<?> vp,
                         VisualLexiconNode parent)
Constructs this VisualLexiconNode.

Parameters:
vp - the VisualProperty to wrap.
parent - this VisualLexiconNodes parent VisualLexiconNode.
Method Detail

setDependency

public void setDependency(boolean depend)
Sets the dependency of this VisualLexiconNode.

Parameters:
depend - True to make this VisualLexiconNode dependent on its parent, false otherwise.

isDepend

public boolean isDepend()
Returns true if this VisualLexiconNode is dependent on its parent.

Returns:
true if this VisualLexiconNode is dependent on its parent.

getVisualProperty

public VisualProperty<?> getVisualProperty()
Returns wrapped VisualProperty object. Since VisualProperty itself does not have any hierarchical structure, such relationship is implemented by this wrapper.

Returns:
wrapped VisualProperty object.

getParent

public VisualLexiconNode getParent()
Get the parent of this VP node. The relationship is immutable, i.e., cannot change parent/child relationship.

Returns:
parent VisualProperty object.

getChildren

public Collection<VisualLexiconNode> getChildren()
Returns collection of all children of this node.

Returns:
collection of all children of this node.

Cytoscape 3.0.0-alpha8-SNAPSHOT API

Copyright 2011 Cytoscape Consortium. All rights reserved.