net.miginfocom.layout
public final class DimConstraint extends Object implements Externalizable
Constructor Summary | |
---|---|
DimConstraint() Empty constructor. |
Method Summary | |
---|---|
UnitValue | getAlign() Returns the alignment used either as a default value for sub-entities or for this entity.
|
UnitValue | getAlignOrDefault(boolean isCols) |
String | getEndGroup() Returns the end group that this entity should be in for the demension that this object is describing.
|
BoundSize | getGapAfter() Returns the gap after this entity. |
BoundSize | getGapBefore() Returns the gap before this entity. |
Float | getGrow() Returns the grow weight. Grow weight is how flexible the entity should be, relative to other entities, when it comes to growing. |
int | getGrowPriority() Returns the grow priority. |
Float | getShrink() Returns the shrink priority. |
int | getShrinkPriority() Returns the shrink priority. |
BoundSize | getSize() Returns the min/preferred/max size for the entity in the dimension that this object describes.
|
String | getSizeGroup() Returns the size group that this entity should be in for the dimension that this object is describing.
|
boolean | isFill() Returns if the component in the row/column that this constraint should default be grown in the same dimension that
this constraint represents (width for column and height for a row).
|
boolean | isNoGrid() Returns if the row/column should default to flow and not to grid behaviour. |
void | readExternal(ObjectInput in) |
void | setAlign(UnitValue uv) Sets the alignment used wither as a default value for sub-entities or for this entity.
|
void | setEndGroup(String s) Sets the end group that this entity should be in for the demension that this object is describing.
|
void | setFill(boolean b) Sets if the component in the row/column that this constraint should default be grown in the same dimension that
this constraint represents (width for column and height for a row).
|
void | setGapAfter(BoundSize size) Sets the gap after this entity. |
void | setGapBefore(BoundSize size) Sets the gap before this entity. |
void | setGrow(Float weight) Sets the grow weight. Grow weight is how flexible the entity should be, relative to other entities, when it comes to growing. |
void | setGrowPriority(int p) Sets the grow priority. |
void | setNoGrid(boolean b) Sets if the row/column should default to flow and not to grid behaviour. |
void | setShrink(Float weight) Sets the shrink priority. |
void | setShrinkPriority(int p) Sets the shrink priority. |
void | setSize(BoundSize size) Sets the min/preferred/max size for the entity in the dimension that this object describes.
|
void | setSizeGroup(String s) Sets the size group that this entity should be in for the dimension that this object is describing.
|
void | writeExternal(ObjectOutput out) |
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Returns: The alignment.
null
means no end group
and all other values are legal. Comparison with .equals(). Components in the same end group
will have the same end coordinate.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Returns: The current end group. null
may be returned.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Returns: The gap after this entity
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Returns: The gap before this entity
Grow weight is how flexible the entity should be, relative to other entities, when it comes to growing. null
or
zero mean it will never grow. An entity that has twice the grow weight compared to another entity will get twice
as much of available space.
GrowWeight are only compared within the same GrowPrio.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Returns: The current grow weight.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Returns: The grow priority.
null
or
zero mean it will never shrink (default). An entity that has twice the shrink weight compared to another entity will get twice
as much of available space.
Shrink(Weight) are only compared within the same ShrinkPrio.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Returns: The current shrink weight.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Returns: The shrink priority.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Returns: The current size. Never null
since v3.5.
See Also: .
null
means no size group
and all other values are legal. Comparison with .equals(). Components/columnss/rows in the same size group
will have the same min/preferred/max size; that of the largest in the group for the first two and the
smallest for max.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Returns: The current size group. May be null
.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Returns: code>true means that components should grow.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Returns: true
means that the whole row/column should be one cell.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Parameters: uv The new shrink priority. E.g. CENTER or LEADING.
null
means no end group
and all other values are legal. Comparison with .equals(). Components in the same end group
will have the same end coordinate.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Parameters: s The new end group. null
disables end grouping.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Parameters: b true
means that components should grow.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Parameters: size The new gap.
See Also: .
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Parameters: size The new gap.
See Also: .
Grow weight is how flexible the entity should be, relative to other entities, when it comes to growing. null
or
zero mean it will never grow. An entity that has twice the grow weight compared to another entity will get twice
as much of available space.
GrowWeight are only compared within the same GrowPrio.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Parameters: weight The new grow weight.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Parameters: p The new grow priority.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Parameters: b true
means that the whole row/column should be one cell.
null
or
zero mean it will never shrink (default). An entity that has twice the shrink weight compared to another entity will get twice
as much of available space.
Shrink(Weight) are only compared within the same ShrinkPrio.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Parameters: weight The new shrink weight.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Parameters: p The new shrink priority.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Parameters: size The new size. May be null
.
null
means no size group
and all other values are legal. Comparison with .equals(). Components/columnss/rows in the same size group
will have the same min/preferred/max size; that of the largest in the group for the first two and the
smallest for max.
For a more thorough explanation of what this constraint does see the white paper or cheat Sheet at www.migcomponents.com.
Parameters: s The new size group. null
disables size grouping.