Class TreeLayoutAlgorithm.Zest1

java.lang.Object
org.eclipse.zest.layouts.algorithms.AbstractLayoutAlgorithm.Zest1
org.eclipse.zest.layouts.algorithms.TreeLayoutAlgorithm.Zest1
All Implemented Interfaces:
LayoutAlgorithm, LayoutAlgorithm.Zest1, Stoppable
Direct Known Subclasses:
HorizontalTreeLayoutAlgorithm, RadialLayoutAlgorithm.Zest1
Enclosing class:
TreeLayoutAlgorithm

@Deprecated(since="2.0", forRemoval=true) public static class TreeLayoutAlgorithm.Zest1 extends AbstractLayoutAlgorithm.Zest1
Deprecated, for removal: This API element is subject to removal in a future version.
Use TreeLayoutAlgorithm instead. This class will be removed in a future release.
Collection of Zest 1.x methods. Used for backwards compatibility.
Since:
2.0
@noextend
This class is not intended to be subclassed by clients.
@noreference
This class is not intended to be referenced by clients.
@noinstantiate
This class is not intended to be instantiated by clients.
  • Constructor Details

    • Zest1

      public Zest1(int styles)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructs a new TreeLayoutAlgorithm object.
    • Zest1

      public Zest1()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Tree layout algorithm Constructor with NO Style
  • Method Details

    • setLayoutArea

      public void setLayoutArea(double x, double y, double width, double height)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      setLayoutArea in class AbstractLayoutAlgorithm.Zest1
    • getCurrentLayoutStep

      protected int getCurrentLayoutStep()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: AbstractLayoutAlgorithm.Zest1
      Gets the current layout step
      Specified by:
      getCurrentLayoutStep in class AbstractLayoutAlgorithm.Zest1
    • getTotalNumberOfLayoutSteps

      protected int getTotalNumberOfLayoutSteps()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: AbstractLayoutAlgorithm.Zest1
      Gets the total number of steps in this layout
      Specified by:
      getTotalNumberOfLayoutSteps in class AbstractLayoutAlgorithm.Zest1
    • preLayoutAlgorithm

      protected void preLayoutAlgorithm(InternalNode[] entitiesToLayout, InternalRelationship[] relationshipsToConsider, double x, double y, double width, double height)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Executes this TreeLayoutAlgorithm layout algorithm by referencing the data stored in the repository system. Once done, the result will be saved to the data repository.
      Specified by:
      preLayoutAlgorithm in class AbstractLayoutAlgorithm.Zest1
      Parameters:
      entitiesToLayout - Apply the algorithm to these entities
      relationshipsToConsider - Only consider these relationships when applying the algorithm.
      x - The left side of the bounds in which the layout can place the entities.
      y - The top side of the bounds in which the layout can place the entities.
      width - The width of the bounds in which the layout can place the entities.
      height - The height of the bounds in which the layout can place the entities.
      Throws:
      RuntimeException - Thrown if entitiesToLayout doesn't contain all of the endpoints for each relationship in relationshipsToConsider
    • applyLayoutInternal

      protected void applyLayoutInternal(InternalNode[] entitiesToLayout, InternalRelationship[] relationshipsToConsider, double boundsX, double boundsY, double boundsWidth, double boundsHeight)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: AbstractLayoutAlgorithm.Zest1
      Apply the layout to the given entities. The entities will be moved and resized based on the algorithm.
      Specified by:
      applyLayoutInternal in class AbstractLayoutAlgorithm.Zest1
      Parameters:
      entitiesToLayout - Apply the algorithm to these entities
      relationshipsToConsider - Only consider these relationships when applying the algorithm.
      boundsX - The left side of the bounds in which the layout can place the entities.
      boundsY - The top side of the bounds in which the layout can place the entities.
      boundsWidth - The width of the bounds in which the layout can place the entities.
      boundsHeight - The height of the bounds in which the layout can place the entities.
    • postLayoutAlgorithm

      protected void postLayoutAlgorithm(InternalNode[] entitiesToLayout, InternalRelationship[] relationshipsToConsider)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: AbstractLayoutAlgorithm.Zest1
      Code called after the layout algorithm ends
      Specified by:
      postLayoutAlgorithm in class AbstractLayoutAlgorithm.Zest1
    • getRoots

      public List getRoots()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the last found roots
    • isValidConfiguration

      protected boolean isValidConfiguration(boolean asynchronous, boolean continueous)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: AbstractLayoutAlgorithm.Zest1
      Determines if the configuration is valid for this layout
      Specified by:
      isValidConfiguration in class AbstractLayoutAlgorithm.Zest1
      Parameters:
      asynchronous -
      continueous -