Explorar o código

work on javadoc

(cherry picked from commit 0f2564b)
Eren Yilmaz %!s(int64=6) %!d(string=hai) anos
pai
achega
30acb68e00
Modificáronse 1 ficheiros con 44 adicións e 4 borrados
  1. 44 4
      src/graph/LayeredGraphNode.java

+ 44 - 4
src/graph/LayeredGraphNode.java

@@ -25,7 +25,8 @@ public interface LayeredGraphNode {
   public ElkNode getOriginalNode();
 
   /**
-   * set the shift of this node in the given layout to the given value
+   * set the shift of this node to the given value in the given layout
+   * or in all layouts if the argument is null.
    * 
    * @param shift
    *          the value to set to
@@ -45,6 +46,7 @@ public interface LayeredGraphNode {
 
   /**
    * set the sink of this node in the given layout
+   * or in all layouts if the argument is null.
    * 
    * @param sink
    *          the sink
@@ -63,7 +65,7 @@ public interface LayeredGraphNode {
   public LayeredGraphNode getSink(LayoutType layout);
 
   /**
-   * checks if the x coordinate of the node is defined
+   * checks if the x coordinate of the node is defined in the given layout
    * 
    * @param layout
    *          the layout
@@ -73,6 +75,7 @@ public interface LayeredGraphNode {
 
   /**
    * sets the align-attribute (the next node in the block) in the given layout
+   * or in all layouts if the argument is null.
    * 
    * @param align
    *          the next node in the block
@@ -92,7 +95,8 @@ public interface LayeredGraphNode {
 
   /**
    * sets the root node of this node in the given layout which identifies the
-   * block that it belongs to
+   * block that it belongs to 
+   * or in all layouts if the argument is null.
    * 
    * @param root
    *          the new root node
@@ -128,6 +132,7 @@ public interface LayeredGraphNode {
 
   /**
    * set the display color of this node in the given layout
+   * or in all layouts if the argument is null.
    * 
    * @param c
    *          the color
@@ -136,16 +141,51 @@ public interface LayeredGraphNode {
    */
   public void setColor(Color c, LayoutType layout);
 
+  /**
+   * check the display color of this node in the given layout.
+   * @param layout the layout
+   * @return the color
+   */
   public Color getColor(LayoutType layout);
+  
+  /**
+   * check the color of this nodes class in the given layout
+   * or in all layouts if the argument is null.
+   * @param layout the layout
+   * @return the color
+   */
   public Color getClassColor( LayoutType layout );
-  public void setSelected(LayoutType layoutType);
+  
+  /**
+   * mark the node as "selected" in the given layout
+   * or in all layouts if the argument is null.
+   * @param layout
+   */
+  public void setSelected(LayoutType layout);
 
+  /**
+   * checks if the node is selected in the given layout
+   * @param layout
+   * @return
+   */
   public boolean isSelected(LayoutType layout);
 
+  /**
+   * sets whether this node is a dummy node
+   * @param dummy is it?
+   */
   public void setDummyNode(boolean dummy);
 
+
+  /**
+   * checks whether this node is a dummy node
+   * @param dummy is it?
+   */
   public boolean isDummyNode();
 
+  /**
+   * unselects the subgraph of this node
+   */
   public void unselectGraph();
 
   /**