net.miginfocom.layout

Class BoundSize

public class BoundSize extends Object implements Serializable

A size that contains minimum, preferred and maximum size of type UnitValue.

This class is a simple value container and it is immutable.

If a size is missing (i.e., null) that boundary should be considered "not in use".

You can create a BoundSize from a String with the use of ConstraintParser

Field Summary
static BoundSizeNULL_SIZE
static BoundSizeZERO_PIXEL
Constructor Summary
BoundSize(UnitValue minMaxPref, String createString)
Constructor that use the same value for min/preferred/max size.
BoundSize(UnitValue min, UnitValue preferred, UnitValue max, String createString)
Constructor.
BoundSize(UnitValue min, UnitValue preferred, UnitValue max, boolean gapPush, String createString)
Constructor.
Method Summary
intconstrain(int size, float refValue, ContainerWrapper parent)
Makes sure that size is within min and max of this size.
booleangetGapPush()
If the size should be hinted as "pushing" and thus want to occupy free space if noone else is claiming it.
UnitValuegetMax()
Returns the maximum size as sent into the constructor.
UnitValuegetMin()
Returns the minimum size as sent into the constructor.
UnitValuegetPreferred()
Returns the preferred size as sent into the constructor.
booleanisUnset()
Returns if this bound size has no min, preferred and maximum size set (they are all null)
protected ObjectreadResolve()

Field Detail

NULL_SIZE

public static final BoundSize NULL_SIZE

ZERO_PIXEL

public static final BoundSize ZERO_PIXEL

Constructor Detail

BoundSize

public BoundSize(UnitValue minMaxPref, String createString)
Constructor that use the same value for min/preferred/max size.

Parameters: minMaxPref The value to use for min/preferred/max size. createString The string used to create the BoundsSize.

BoundSize

public BoundSize(UnitValue min, UnitValue preferred, UnitValue max, String createString)
Constructor. This method is here for serilization only and should normally not be used. Use ConstraintParser instead.

Parameters: min The minimum size. May be null. preferred The preferred size. May be null. max The maximum size. May be null. createString The string used to create the BoundsSize.

BoundSize

public BoundSize(UnitValue min, UnitValue preferred, UnitValue max, boolean gapPush, String createString)
Constructor. This method is here for serilization only and should normally not be used. Use ConstraintParser instead.

Parameters: min The minimum size. May be null. preferred The preferred size. May be null. max The maximum size. May be null. gapPush If the size should be hinted as "pushing" and thus want to occupy free space if no one else is claiming it. createString The string used to create the BoundsSize.

Method Detail

constrain

public int constrain(int size, float refValue, ContainerWrapper parent)
Makes sure that size is within min and max of this size.

Parameters: size The size to constrain. refValue The reference to use for relative sizes. parent The parent container.

Returns: The size, constrained within min and max.

getGapPush

public boolean getGapPush()
If the size should be hinted as "pushing" and thus want to occupy free space if noone else is claiming it.

Returns: The value.

getMax

public final UnitValue getMax()
Returns the maximum size as sent into the constructor.

Returns: The maximum size as sent into the constructor. May be null.

getMin

public final UnitValue getMin()
Returns the minimum size as sent into the constructor.

Returns: The minimum size as sent into the constructor. May be null.

getPreferred

public final UnitValue getPreferred()
Returns the preferred size as sent into the constructor.

Returns: The preferred size as sent into the constructor. May be null.

isUnset

public boolean isUnset()
Returns if this bound size has no min, preferred and maximum size set (they are all null)

Returns: If unset.

readResolve

protected Object readResolve()