Class GridLayoutAlgorithm.Zest1

java.lang.Object
org.eclipse.zest.layouts.algorithms.AbstractLayoutAlgorithm.Zest1
org.eclipse.zest.layouts.algorithms.GridLayoutAlgorithm.Zest1
All Implemented Interfaces:
LayoutAlgorithm, LayoutAlgorithm.Zest1, Stoppable
Direct Known Subclasses:
HorizontalLayoutAlgorithm, VerticalLayoutAlgorithm
Enclosing class:
GridLayoutAlgorithm

@Deprecated(since="2.0", forRemoval=true) public static class GridLayoutAlgorithm.Zest1 extends AbstractLayoutAlgorithm.Zest1
Deprecated, for removal: This API element is subject to removal in a future version.
Use GridLayoutAlgorithm 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.
  • Field Details

    • rowPadding

      protected int rowPadding
      Deprecated, for removal: This API element is subject to removal in a future version.
  • Constructor Details

    • Zest1

      public Zest1(int styles)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Initializes the grid layout.
      Parameters:
      styles -
      See Also:
    • Zest1

      public Zest1()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Inititalizes the grid layout 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.
      Description copied from class: AbstractLayoutAlgorithm.Zest1
      Code called before the layout algorithm starts
      Specified by:
      preLayoutAlgorithm in class AbstractLayoutAlgorithm.Zest1
    • 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.
      Use this algorithm to layout the given entities, using the given relationships and bounds. The entities will be placed in the same order as they are passed in, unless a comparator is supplied.
      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.
      Throws:
      RuntimeException - Thrown if entitiesToLayout doesn't contain all of the endpoints for each relationship in relationshipsToConsider
    • 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
    • calculateNumberOfRowsAndCols

      protected int[] calculateNumberOfRowsAndCols(int numChildren, double boundX, double boundY, double boundWidth, double boundHeight)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Calculates and returns an array containing the number of columns, followed by the number of rows
    • calculateNumberOfRowsAndCols_square

      protected int[] calculateNumberOfRowsAndCols_square(int numChildren, double boundX, double boundY, double boundWidth, double boundHeight)
      Deprecated, for removal: This API element is subject to removal in a future version.
    • calculateNumberOfRowsAndCols_rectangular

      protected int[] calculateNumberOfRowsAndCols_rectangular(int numChildren)
      Deprecated, for removal: This API element is subject to removal in a future version.
    • calculateNodeSize

      protected double[] calculateNodeSize(double colWidth, double rowHeight)
      Deprecated, for removal: This API element is subject to removal in a future version.
    • setRowPadding

      public void setRowPadding(int rowPadding)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Increases the padding between rows in the grid
      Parameters:
      rowPadding - Value will not be set if less than 0.
    • 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 -