All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.SizeRequirements 

java.lang.Object
   |
   +----com.sun.java.swing.SizeRequirements
public class SizeRequirements
extends Object
implements Serializable
For the convenience of layout managers, calculates information about the size and position of components. All size and position calculation methods are class methods that take arrays of SizeRequirements as arguments. The SizeRequirements class supports two types of layout:
tiled
The components are placed end-to-end, starting at coordinate 0 (the leftmost or topmost position).
aligned
The components are aligned as specified by each component's X or Y alignment value.

Each SizeRequirements object contains information about either the width (and X alignment) or height (and Y alignment) of a single component or a group of components:

minimum
The smallest reasonable width/height of the component or component group, in pixels.
preferred
The natural width/height of the component or component group, in pixels.
maximum
The largest reasonable width/height of the component or component group, in pixels.
alignment
The X/Y alignment of the component or component group.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:
getMinimumSize, getPreferredSize, getMaximumSize, getAlignmentX, getAlignmentY

Variable Index

o alignment
The alignment, specified as a value between 0.0 and 1.0, inclusive.
o maximum
The maximum size allowed.
o minimum
The minimum size required.
o preferred
The preferred (natural) size.

Constructor Index

o SizeRequirements()
Creates a SizeRequirements object with the minimum, preferred, and maximum sizes set to zero and an alignment value of 0.5 (centered).
o SizeRequirements(int, int, int, float)
Creates a SizeRequirements object with the specified minimum, preferred, and maximum sizes and the specified alignment.

Method Index

o calculateAlignedPositions(int, SizeRequirements, SizeRequirements[], int[], int[])
Creates a bunch of offset/span pairs specifying how to lay out a set of components with the specified alignments.
o calculateTiledPositions(int, SizeRequirements, SizeRequirements[], int[], int[])
Creates a bunch of offset/span pairs representing how to lay out a set of components end-to-end.
o getAlignedSizeRequirements(SizeRequirements[])
Determines the total space necessary to align a set of components.
o getTiledSizeRequirements(SizeRequirements[])
Determines the total space necessary to place a set of components end-to-end.
o toString()
Returns a string describing the minimum, preferred, and maximum size requirements, along with the alignment.

Variables

o minimum 
 public int minimum
The minimum size required. For a component comp, this should be equal to either comp.getMinimumSize().width or comp.getMinimumSize().height.

o preferred 
 public int preferred
The preferred (natural) size. For a component comp, this should be equal to either comp.getPreferredSize().width or comp.getPreferredSize().height.

o maximum 
 public int maximum
The maximum size allowed. For a component comp, this should be equal to either comp.getMaximumSize().width or comp.getMaximumSize().height.

o alignment 
 public float alignment
The alignment, specified as a value between 0.0 and 1.0, inclusive. To specify centering, the alignment should be 0.5.

Constructors

o SizeRequirements 
 public SizeRequirements()
Creates a SizeRequirements object with the minimum, preferred, and maximum sizes set to zero and an alignment value of 0.5 (centered).

o SizeRequirements 
 public SizeRequirements(int min,
                         int pref,
                         int max,
                         float a)
Creates a SizeRequirements object with the specified minimum, preferred, and maximum sizes and the specified alignment.

Parameters:
min - the minimum size >= 0
pref - the preferred size >= 0
max - the maximum size >= 0
a - the alignment >= 0.0f && <= 1.0f

Methods

o toString 
 public String toString()
Returns a string describing the minimum, preferred, and maximum size requirements, along with the alignment.

Returns:
the string
Overrides:
toString in class Object
o getTiledSizeRequirements 
 public static SizeRequirements getTiledSizeRequirements(SizeRequirements children[])
Determines the total space necessary to place a set of components end-to-end. The needs of each component in the set are represented by an entry in the passed-in SizeRequirements array. The returned SizeRequirements object has an alignment of 0.5 (centered). The space requirement is never more than Integer.MAX_VALUE.

Parameters:
children - the space requirements for a set of components. The vector may be of zero length, which will result in a default SizeRequirements object instance being passed back.
Returns:
the total space requirements.
o getAlignedSizeRequirements 
 public static SizeRequirements getAlignedSizeRequirements(SizeRequirements children[])
Determines the total space necessary to align a set of components. The needs of each component in the set are represented by an entry in the passed-in SizeRequirements array. The total space required will never be more than Integer.MAX_VALUE.

Parameters:
children - the set of child requirements. If of zero length, the returns result will be a default instance of SizeRequirements.
Returns:
the total space requirements.
o calculateTiledPositions 
 public static void calculateTiledPositions(int allocated,
                                            SizeRequirements total,
                                            SizeRequirements children[],
                                            int offsets[],
                                            int spans[])
Creates a bunch of offset/span pairs representing how to lay out a set of components end-to-end. This method requires that you specify the total amount of space to be allocated, the size requirements for each component to be placed (specified as an array of SizeRequirements), and the total size requirement of the set of components. You can get the total size requirement by invoking the getTiledSizeRequirements method.

Parameters:
allocated - the total span to be allocated >= 0.
total - the total of the children requests.
children - the size requirements for each component.
offsets - the offset from 0 for each child where the spans were allocated (determines placement of the span).
spans - the span allocated for each child to make the total target span.
o calculateAlignedPositions 
 public static void calculateAlignedPositions(int allocated,
                                              SizeRequirements total,
                                              SizeRequirements children[],
                                              int offsets[],
                                              int spans[])
Creates a bunch of offset/span pairs specifying how to lay out a set of components with the specified alignments. The resulting span allocations will overlap, with each one fitting as well as possible into the given total allocation. This method requires that you specify the total amount of space to be allocated, the size requirements for each component to be placed (specified as an array of SizeRequirements), and the total size requirements of the set of components (only the alignment field of which is actually used). You can get the total size requirement by invoking getAlignedSizeRequirements.

Parameters:
allocated - the total span to be allocated >= 0.
total - the total of the children requests.
children - the size requirements for each component.
offsets - the offset from 0 for each child where the spans were allocated (determines placement of the span).
spans - the span allocated for each child to make the total target span. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index