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.
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.
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.eclipse.zest.layouts.LayoutAlgorithmLayoutAlgorithm.Zest1
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected intDeprecated, for removal: This API element is subject to removal in a future version.Fields inherited from class org.eclipse.zest.layouts.algorithms.AbstractLayoutAlgorithm.Zest1comparator, filter, internalAsynchronous, internalContinuous, layout_styles, layoutStopped, MIN_ENTITY_SIZE, resizeEntitiesAfterLayout
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidapplyLayoutInternal(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.protected double[]calculateNodeSize(double colWidth, double rowHeight) Deprecated, for removal: This API element is subject to removal in a future version.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 rowsprotected int[]calculateNumberOfRowsAndCols_rectangular(int numChildren) Deprecated, for removal: This API element is subject to removal in a future version.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.protected intDeprecated, for removal: This API element is subject to removal in a future version.Gets the current layout stepprotected intDeprecated, for removal: This API element is subject to removal in a future version.Gets the total number of steps in this layoutprotected booleanisValidConfiguration(boolean asynchronous, boolean continueous) Deprecated, for removal: This API element is subject to removal in a future version.Determines if the configuration is valid for this layoutprotected voidpostLayoutAlgorithm(InternalNode[] entitiesToLayout, InternalRelationship[] relationshipsToConsider) Deprecated, for removal: This API element is subject to removal in a future version.Code called after the layout algorithm endsprotected voidpreLayoutAlgorithm(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.Code called before the layout algorithm startsvoidsetLayoutArea(double x, double y, double width, double height) Deprecated, for removal: This API element is subject to removal in a future version.voidsetRowPadding(int rowPadding) Deprecated, for removal: This API element is subject to removal in a future version.Increases the padding between rows in the gridMethods inherited from class org.eclipse.zest.layouts.algorithms.AbstractLayoutAlgorithm.Zest1addEntity, addProgressListener, addRelationship, applyLayout, applyLayout, defaultFitWithinBounds, defaultFitWithinBounds, fireProgressEnded, fireProgressEvent, fireProgressStarted, fireProgressUpdated, getEntityAspectRatio, getLayoutBounds, getLocalLocation, getNumberOfProgressListeners, getStyle, isRunning, removeEntity, removeProgressListener, removeRelationship, removeRelationships, removeRelationships, setComparator, setEntityAspectRatio, setFilter, setLayoutContext, setStyle, stop, updateBendPoints, updateEntities, updateLayoutLocations, updateRelationships, verifyInput
- 
Field Details- 
rowPaddingprotected int rowPaddingDeprecated, for removal: This API element is subject to removal in a future version.
 
- 
- 
Constructor Details- 
Zest1public 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:
 
- 
Zest1public Zest1()Deprecated, for removal: This API element is subject to removal in a future version.Inititalizes the grid layout with no style.
 
- 
- 
Method Details- 
setLayoutAreapublic 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:
- setLayoutAreain class- AbstractLayoutAlgorithm.Zest1
 
- 
getCurrentLayoutStepprotected int getCurrentLayoutStep()Deprecated, for removal: This API element is subject to removal in a future version.Description copied from class:AbstractLayoutAlgorithm.Zest1Gets the current layout step- Specified by:
- getCurrentLayoutStepin class- AbstractLayoutAlgorithm.Zest1
 
- 
getTotalNumberOfLayoutStepsprotected int getTotalNumberOfLayoutSteps()Deprecated, for removal: This API element is subject to removal in a future version.Description copied from class:AbstractLayoutAlgorithm.Zest1Gets the total number of steps in this layout- Specified by:
- getTotalNumberOfLayoutStepsin class- AbstractLayoutAlgorithm.Zest1
 
- 
preLayoutAlgorithmprotected 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.Zest1Code called before the layout algorithm starts- Specified by:
- preLayoutAlgorithmin class- AbstractLayoutAlgorithm.Zest1
 
- 
applyLayoutInternalprotected 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:
- applyLayoutInternalin 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
 
- 
postLayoutAlgorithmprotected 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.Zest1Code called after the layout algorithm ends- Specified by:
- postLayoutAlgorithmin class- AbstractLayoutAlgorithm.Zest1
 
- 
calculateNumberOfRowsAndColsprotected 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_squareprotected 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_rectangularprotected int[] calculateNumberOfRowsAndCols_rectangular(int numChildren) Deprecated, for removal: This API element is subject to removal in a future version.
- 
calculateNodeSizeprotected double[] calculateNodeSize(double colWidth, double rowHeight) Deprecated, for removal: This API element is subject to removal in a future version.
- 
setRowPaddingpublic 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.
 
- 
isValidConfigurationprotected 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.Zest1Determines if the configuration is valid for this layout- Specified by:
- isValidConfigurationin class- AbstractLayoutAlgorithm.Zest1
- Parameters:
- asynchronous-
- continueous-
 
 
- 
GridLayoutAlgorithminstead. This class will be removed in a future release.