net.miginfocom.layout
Class DimConstraint

java.lang.Object
  extended by net.miginfocom.layout.DimConstraint
All Implemented Interfaces:
Externalizable, Serializable

public final class DimConstraint
extends Object
implements Externalizable

A simple value holder for a constraint for one dimension.

See Also:
Serialized Form

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.
 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.
 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)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DimConstraint

public DimConstraint()
Empty constructor.

Method Detail

getGrowPriority

public int getGrowPriority()
Returns the grow priority. Relative priority is used for determining which entities gets the extra space first.

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.

setGrowPriority

public void setGrowPriority(int p)
Sets the grow priority. Relative priority is used for determining which entities gets the extra space first.

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.

getGrow

public Float getGrow()
Returns the grow weight.

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.

setGrow

public 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. 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.

getShrinkPriority

public int getShrinkPriority()
Returns the shrink priority. Relative priority is used for determining which entities gets smaller first when space is scarce.

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.

setShrinkPriority

public void setShrinkPriority(int p)
Sets the shrink priority. Relative priority is used for determining which entities gets smaller first when space is scarce.

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.

getShrink

public Float getShrink()
Returns the shrink priority. Relative priority is used for determining which entities gets smaller first when space is scarce. Shrink weight is how flexible the entity should be, relative to other entities, when it comes to shrinking. 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.

setShrink

public void setShrink(Float weight)
Sets the shrink priority. Relative priority is used for determining which entities gets smaller first when space is scarce. Shrink weight is how flexible the entity should be, relative to other entities, when it comes to shrinking. 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.

getAlignOrDefault

public UnitValue getAlignOrDefault(boolean isCols)

getAlign

public UnitValue getAlign()
Returns the alignment used either as a default value for sub-entities or for 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 alignment.

setAlign

public void setAlign(UnitValue uv)
Sets the alignment used wither as a default value for sub-entities or for this entity.

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. UnitValue.CENTER or UnitValue.LEADING.

getGapAfter

public BoundSize getGapAfter()
Returns the gap after this entity. The gap is an empty space and can have a min/preferred/maximum size so that it can shrink and grow depending on available space. Gaps are against other entities' edges and not against other entities' gaps.

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

setGapAfter

public void setGapAfter(BoundSize size)
Sets the gap after this entity. The gap is an empty space and can have a min/preferred/maximum size so that it can shrink and grow depending on available space. Gaps are against other entities' edges and not against other entities' gaps.

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:
ConstraintParser.parseBoundSize(String, boolean, boolean).

getGapBefore

public BoundSize getGapBefore()
Returns the gap before this entity. The gap is an empty space and can have a min/preferred/maximum size so that it can shrink and grow depending on available space. Gaps are against other entities' edges and not against other entities' gaps.

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

setGapBefore

public void setGapBefore(BoundSize size)
Sets the gap before this entity. The gap is an empty space and can have a min/preferred/maximum size so that it can shrink and grow depending on available space. Gaps are against other entities' edges and not against other entities' gaps.

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:
ConstraintParser.parseBoundSize(String, boolean, boolean).

getSize

public BoundSize getSize()
Returns the min/preferred/max size for the entity in the dimension that this object describes.

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:
ConstraintParser.parseBoundSize(String, boolean, boolean).

setSize

public void setSize(BoundSize size)
Sets the min/preferred/max size for the entity in the dimension that this object describes.

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.

getSizeGroup

public String getSizeGroup()
Returns the size group that this entity should be in for the dimension that this object is describing. If this constraint is in a size group that is specified here. 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.

setSizeGroup

public void setSizeGroup(String s)
Sets the size group that this entity should be in for the dimension that this object is describing. If this constraint is in a size group that is specified here. 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.

getEndGroup

public String getEndGroup()
Returns the end group that this entity should be in for the demension that this object is describing. If this constraint is in an end group that is specified here. 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.

setEndGroup

public void setEndGroup(String s)
Sets the end group that this entity should be in for the demension that this object is describing. If this constraint is in an end group that is specified here. 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.

isFill

public 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).

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.

setFill

public 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).

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.

isNoGrid

public boolean isNoGrid()
Returns if the row/column should default to flow and not to grid behaviour. This means that the whole row/column will be one cell and all components will end up in that cell.

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.

setNoGrid

public void setNoGrid(boolean b)
Sets if the row/column should default to flow and not to grid behaviour. This means that the whole row/column will be one cell and all components will end up in that cell.

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.

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException


Copyright © 2007-2011. All Rights Reserved.