|
Search this API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object y.layout.hierarchic.incremental.ColumnDescriptor
public class ColumnDescriptor
This class represents a column of a PartitionGrid
.
The results of the calculation of the geometry of the column will be placed
into the instances of this class after the layout.
PartitionGrid
Method Summary | |
---|---|
int |
compareTo(Object o)
|
double |
getComputedPosition()
Returns the computed position (smaller x-coordinate) of the column after the layout has been calculated. |
double |
getComputedWidth()
Returns the computed width of the column after the layout has been calculated. |
int |
getIndex()
Returns the index of the column within the partition grid. |
double |
getLeftInset()
Returns the left column insets where no element will lie in the resulting drawing. |
double |
getMinimumWidth()
Returns the minimum column width. |
double |
getOriginalPosition()
Returns the original position (smaller x-coordinate) of the column. |
double |
getOriginalWidth()
Returns the original width of the column. |
double |
getRightInset()
Returns the right column insets where no element will lie in the resulting drawing. |
double |
getTightness()
Returns the tightness factor of the column. |
boolean |
isIndexFixed()
Returns whether the index of this column is fixed or whether the algorithm should try to find the best possible position. |
void |
setComputedPosition(double computedPosition)
Used to set the computed position (smaller x-coordinate) of the column after the layout has been calculated. |
void |
setComputedWidth(double computedWidth)
Used to set the computed width of the column after the layout has been calculated. |
void |
setIndexFixed(boolean indexFixed)
Specifies whether a column's index is fixed or whether the index should be chosen automatically in order to minimize edge lengths. |
void |
setLeftInset(double leftInset)
Sets the left column insets where no element will lie in the resulting drawing. |
void |
setMinimumWidth(double minimumWidth)
Sets the minimum width of the column. |
void |
setOriginalPosition(double originalPosition)
Sets the original position (smaller x-coordinate) of the column. |
void |
setOriginalWidth(double originalWidth)
Sets the original width of the column. |
void |
setRightInset(double rightInset)
Sets the right column insets where no element will lie in the resulting drawing. |
void |
setTightness(double tightness)
Sets the tightness factor of the column. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public int getIndex()
public int compareTo(Object o)
compareTo
in interface Comparable
public double getMinimumWidth()
0.0d
.
public void setMinimumWidth(double minimumWidth)
IllegalArgumentException
- if minimumWidth is negativeminimumWidth
- the new widthpublic double getLeftInset()
0.0d
.
public void setLeftInset(double leftInset)
IllegalArgumentException
- if leftInset is negativeleftInset
- the new insetspublic double getRightInset()
0.0d
.
public void setRightInset(double rightInset)
IllegalArgumentException
- if rightInset is negativerightInset
- the new insetspublic double getComputedWidth()
public void setComputedWidth(double computedWidth)
public double getOriginalWidth()
public void setOriginalWidth(double originalWidth)
public double getOriginalPosition()
public void setOriginalPosition(double originalPosition)
public double getComputedPosition()
public void setComputedPosition(double computedPosition)
public double getTightness()
0.0d
.
setTightness(double)
public void setTightness(double tightness)
0.0d
will disable compression of the column.
A value of 1.0d
will try to force the column to be of
its minimum width
.
IllegalArgumentException
- if tightness is out of the valid rangetightness
- the tightness of the column [0.0d .. 1.0d]public boolean isIndexFixed()
true
true
iff the column's index should not be determined automatically.setIndexFixed(boolean)
public void setIndexFixed(boolean indexFixed)
For all columns where this property is set to true
, the relative ordering given by the indices
is preserved. The remaining columns may be resorted so that the overall edge lengths are minimized.
By default, this feature is enabled.
indexFixed
- true
iff the column index should not be determined automatically.isIndexFixed()
|
© Copyright 2000-2013, yWorks GmbH. All rights reserved. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |