com.jgoodies.forms.layout

Class BoundedSize

public final class BoundedSize extends Object implements Size, Serializable

Describes sizes that provide lower and upper bounds as used by the JGoodies FormLayout.

Version: $Revision: 1.17 $

Author: Karsten Lentzsch

See Also: Sizes ConstantSize

Constructor Summary
BoundedSize(Size basis, Size lowerBound, Size upperBound)
Constructs a BoundedSize for the given basis using the specified lower and upper bounds.
Method Summary
booleancompressible()
Describes if this Size can be compressed, if container space gets scarce.
Stringencode()
Returns a parseable string representation of this bounded size.
booleanequals(Object object)
Indicates whether some other BoundedSize is "equal to" this one.
SizegetBasis()
Returns the base size, which is not-null.
SizegetLowerBound()
Returns the optional lower bound.
SizegetUpperBound()
Returns the optional upper bound.
inthashCode()
Returns a hash code value for the object.
intmaximumSize(Container container, List components, FormLayout.Measure minMeasure, FormLayout.Measure prefMeasure, FormLayout.Measure defaultMeasure)
Returns this size as pixel size.
StringtoString()
Returns a string representation of this size object.

Note: This string representation may change at any time.

Constructor Detail

BoundedSize

public BoundedSize(Size basis, Size lowerBound, Size upperBound)
Constructs a BoundedSize for the given basis using the specified lower and upper bounds.

Parameters: basis the base size lowerBound the lower bound size upperBound the upper bound size

Throws: NullPointerException if the basis is {@code null} IllegalArgumentException of {@code lowerBound} and {@code upperBound} is {@code null}

Since: 1.1

Method Detail

compressible

public boolean compressible()
Describes if this Size can be compressed, if container space gets scarce. Used by the FormLayout size computations in #compressedSizes to check whether a column or row can be compressed or not.

BoundedSizes are compressible if the base Size is compressible.

Returns: true if and only if the basis is compressible

Since: 1.1

encode

public String encode()
Returns a parseable string representation of this bounded size.

Returns: a String that can be parsed by the Forms parser

Since: 1.2

equals

public boolean equals(Object object)
Indicates whether some other BoundedSize is "equal to" this one.

Parameters: object the object with which to compare

Returns: true if this object is the same as the object argument, false otherwise.

See Also: Object#hashCode() java.util.Hashtable

getBasis

public Size getBasis()
Returns the base size, which is not-null.

Returns: the base size

Since: 1.1

getLowerBound

public Size getLowerBound()
Returns the optional lower bound.

Returns: the optional lower bound

Since: 1.1

getUpperBound

public Size getUpperBound()
Returns the optional upper bound.

Returns: the optional upper bound

Since: 1.1

hashCode

public int hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

Returns: a hash code value for this object.

See Also: Object#equals(Object) java.util.Hashtable

maximumSize

public int maximumSize(Container container, List components, FormLayout.Measure minMeasure, FormLayout.Measure prefMeasure, FormLayout.Measure defaultMeasure)
Returns this size as pixel size. Neither requires the component list nor the specified measures. Honors the lower and upper bound.

Invoked by FormSpec to determine the size of a column or row.

Parameters: container the layout container components the list of components to measure minMeasure the measure used to determine the minimum size prefMeasure the measure used to determine the preferred size defaultMeasure the measure used to determine the default size

Returns: the maximum size in pixels

See Also: FormSpec

toString

public String toString()
Returns a string representation of this size object.

Note: This string representation may change at any time. It is intended for debugging purposes. For parsing, use {@link #encode()} instead.

Returns: a string representation of this bounded size

Copyright © 2002-2008 JGoodies Karsten Lentzsch. All Rights Reserved.