public interface LayoutAlgorithm
Modifier and Type | Method and Description |
---|---|
void |
addEntity(LayoutEntity entity) |
void |
addProgressListener(ProgressListener listener)
A layout algorithm could take an uncomfortable amout of time to complete.
|
void |
addRelationship(LayoutRelationship relationship) |
void |
applyLayout(LayoutEntity[] entitiesToLayout,
LayoutRelationship[] relationshipsToConsider,
double x,
double y,
double width,
double height,
boolean asynchronous,
boolean continuous)
Apply the layout to the given entities.
|
double |
getEntityAspectRatio()
Returns the width to height ratio this layout will use to set the size of the entities.
|
int |
getStyle() |
boolean |
isRunning()
Returns whether or not the algorithm is currenly running
|
void |
removeEntity(LayoutEntity entity) |
void |
removeProgressListener(ProgressListener listener)
Removes the given progress listener, preventing it from receiving any more updates.
|
void |
removeRelationship(LayoutRelationship relationship) |
void |
removeRelationships(java.util.List relationships) |
void |
setComparator(java.util.Comparator comparator)
Determines the order in which the objects should be displayed.
|
void |
setEntityAspectRatio(double ratio)
Set the width to height ratio you want the entities to use
Note: Each layout is responsible for ensuring this ratio is used.
|
void |
setFilter(Filter filter)
Filters the entities and relationships to apply the layout on
|
void |
setStyle(int style)
Sets the style for this layout algorithm.
|
void |
stop()
Makes a request to this layout algorithm to stop running.
|
void applyLayout(LayoutEntity[] entitiesToLayout, LayoutRelationship[] relationshipsToConsider, double x, double y, double width, double height, boolean asynchronous, boolean continuous) throws InvalidLayoutConfiguration
entitiesToLayout
- Apply the algorithm to these entitiesrelationshipsToConsider
- 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.asynchronous
- Should the algorithm run AsynchronouslyInvalidLayoutConfiguration
boolean isRunning()
void setComparator(java.util.Comparator comparator)
void setFilter(Filter filter)
void setEntityAspectRatio(double ratio)
double getEntityAspectRatio()
void addProgressListener(ProgressListener listener)
void removeProgressListener(ProgressListener listener)
void stop()
void setStyle(int style)
style
- int getStyle()
void addEntity(LayoutEntity entity)
void addRelationship(LayoutRelationship relationship)
void removeEntity(LayoutEntity entity)
void removeRelationship(LayoutRelationship relationship)
void removeRelationships(java.util.List relationships)
Copyright (c) IBM Corp. and others 2000, 2011. All Rights Reserved.