home *** CD-ROM | disk | FTP | other *** search
/ Chip 1998 November / Chip_1998-11_cd.bin / tema / Cafe / jfc.bin / SizeRequirements.java < prev    next >
Text File  |  1998-02-26  |  13KB  |  335 lines
  1. /*
  2.  * @(#)SizeRequirements.java    1.12 98/02/06
  3.  * 
  4.  * Copyright (c) 1997 Sun Microsystems, Inc. All Rights Reserved.
  5.  * 
  6.  * This software is the confidential and proprietary information of Sun
  7.  * Microsystems, Inc. ("Confidential Information").  You shall not
  8.  * disclose such Confidential Information and shall use it only in
  9.  * accordance with the terms of the license agreement you entered into
  10.  * with Sun.
  11.  * 
  12.  * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
  13.  * SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  14.  * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  15.  * PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR ANY DAMAGES
  16.  * SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
  17.  * THIS SOFTWARE OR ITS DERIVATIVES.
  18.  * 
  19.  */
  20. package com.sun.java.swing;
  21.  
  22.  
  23. import java.awt.*;
  24. import java.io.Serializable;
  25.  
  26. /**
  27.  * For the convenience of layout managers,
  28.  * calculates information about the size and position of components.
  29.  * All size and position calculation methods are class methods
  30.  * that take arrays of SizeRequirements as arguments.
  31.  * The SizeRequirements class supports two types of layout:
  32.  *
  33.  * <blockquote>
  34.  * <dl>
  35.  * <dt> tiled
  36.  * <dd> The components are placed end-to-end,
  37.  *      starting at coordinate 0
  38.  *      (the leftmost or topmost position).
  39.  *
  40.  * <dt> aligned
  41.  * <dd> The components are aligned as specified 
  42.  *      by each component's X or Y alignment value.
  43.  * </dl>
  44.  * </blockquote>
  45.  *
  46.  * <p>
  47.  *
  48.  * Each SizeRequirements object contains information
  49.  * about either the width (and X alignment)
  50.  * or height (and Y alignment)
  51.  * of a single component or a group of components:
  52.  * 
  53.  * <blockquote>
  54.  * <dl>
  55.  * <dt> <code>minimum</code>
  56.  * <dd> The smallest reasonable width/height of the component
  57.  *      or component group, in pixels.
  58.  *
  59.  * <dt> <code>preferred</code>
  60.  * <dd> The natural width/height of the component
  61.  *      or component group, in pixels.
  62.  *
  63.  * <dt> <code>maximum</code>
  64.  * <dd> The largest reasonable width/height of the component
  65.  *      or component group, in pixels.
  66.  *
  67.  * <dt> <code>alignment</code>
  68.  * <dd> The X/Y alignment of the component
  69.  *      or component group.
  70.  * </dl>
  71.  * </blockquote>
  72.  * <p>
  73.  * Warning: serialized objects of this class will not be compatible with
  74.  * future swing releases.  The current serialization support is appropriate 
  75.  * for short term storage or RMI between Swing1.0 applications.  It will
  76.  * not be possible to load serialized Swing1.0 objects with future releases
  77.  * of Swing.  The JDK1.2 release of Swing will be the compatibility
  78.  * baseline for the serialized form of Swing objects.
  79.  *
  80.  * @see Component#getMinimumSize
  81.  * @see Component#getPreferredSize
  82.  * @see Component#getMaximumSize
  83.  * @see Component#getAlignmentX
  84.  * @see Component#getAlignmentY
  85.  *
  86.  * @version 1.12 02/06/98
  87.  * @author Timothy Prinzing
  88.  */
  89. public class SizeRequirements implements Serializable {
  90.  
  91.     /** 
  92.      * The minimum size required. 
  93.      * For a component <code>comp</code>, this should be equal to either
  94.      * <code>comp.getMinimumSize().width</code> or
  95.      * <code>comp.getMinimumSize().height</code>.
  96.      */
  97.     public int minimum;
  98.  
  99.     /** 
  100.      * The preferred (natural) size. 
  101.      * For a component <code>comp</code>, this should be equal to either
  102.      * <code>comp.getPreferredSize().width</code> or
  103.      * <code>comp.getPreferredSize().height</code>.
  104.      */
  105.     public int preferred;
  106.  
  107.     /** 
  108.      * The maximum size allowed. 
  109.      * For a component <code>comp</code>, this should be equal to either
  110.      * <code>comp.getMaximumSize().width</code> or
  111.      * <code>comp.getMaximumSize().height</code>.
  112.      */
  113.     public int maximum;
  114.  
  115.     /** 
  116.      * The alignment, specified as a value between 0.0 and 1.0,
  117.      * inclusive.
  118.      * To specify centering, the alignment should be 0.5.
  119.      */
  120.     public float alignment;
  121.  
  122.     /**
  123.      * Creates a SizeRequirements object with the minimum, preferred,
  124.      * and maximum sizes set to zero and an alignment value of 0.5
  125.      * (centered).
  126.      */
  127.     public SizeRequirements() {
  128.     minimum = 0;
  129.     preferred = 0;
  130.     maximum = 0;
  131.     alignment = 0.5f;
  132.     }
  133.  
  134.     /**
  135.      * Creates a SizeRequirements object with the specified minimum, preferred,
  136.      * and maximum sizes and the specified alignment.
  137.      */
  138.     public SizeRequirements(int min, int pref, int max, float a) {
  139.     minimum = min;
  140.     preferred = pref;
  141.     maximum = max;
  142.     alignment = a > 1.0f ? 1.0f : a < 0.0f ? 0.0f : a;
  143.     }
  144.  
  145.     /**
  146.      * Returns a string describing the minimum, preferred, and maximum
  147.      * size requirements, along with the alignment.
  148.      */
  149.     public String toString() {
  150.     return "[" + minimum + "," + preferred + "," + maximum + "]@" + alignment;
  151.     }
  152.  
  153.     /**
  154.      * Determines the total space necessary to
  155.      * place a set of components end-to-end.  The needs
  156.      * of each component in the set are represented by an entry in the
  157.      * passed-in SizeRequirements array.
  158.      * The returned SizeRequirements object has an alignment of 0.5
  159.      * (centered).
  160.      *
  161.      * @return  the total space requirements.
  162.      *
  163.      * @param children  the space requirements for a set of components.
  164.      */
  165.     public static SizeRequirements getTiledSizeRequirements(SizeRequirements[] 
  166.                                 children) {
  167.     SizeRequirements total = new SizeRequirements();
  168.     for (int i = 0; i < children.length; i++) {
  169.         SizeRequirements req = children[i];
  170.         total.minimum = (int) Math.min((long) total.minimum + (long) req.minimum, Integer.MAX_VALUE);
  171.         total.preferred = (int) Math.min((long) total.preferred + (long) req.preferred, Integer.MAX_VALUE);
  172.         total.maximum = (int) Math.min((long) total.maximum + (long) req.maximum, Integer.MAX_VALUE);
  173.     }
  174.     return total;
  175.     }
  176.  
  177.     /**
  178.      * Determines the total space necessary to
  179.      * align a set of components.  The needs
  180.      * of each component in the set are represented by an entry in the
  181.      * passed-in SizeRequirements array.
  182.      *
  183.      * @return  the total space requirements.
  184.      *
  185.      * @param children  the set of child requirements.
  186.      */
  187.     public static SizeRequirements getAlignedSizeRequirements(SizeRequirements[] 
  188.                                   children) {
  189.     SizeRequirements totalAscent = new SizeRequirements();
  190.     SizeRequirements totalDescent = new SizeRequirements();
  191.     for (int i = 0; i < children.length; i++) {
  192.         SizeRequirements req = children[i];
  193.  
  194.         int ascent = (int) (req.alignment * req.minimum);
  195.         int descent = req.minimum - ascent;
  196.         totalAscent.minimum = Math.max(ascent, totalAscent.minimum);
  197.         totalDescent.minimum = Math.max(descent, totalDescent.minimum);
  198.  
  199.         ascent = (int) (req.alignment * req.preferred);
  200.         descent = req.preferred - ascent;
  201.         totalAscent.preferred = Math.max(ascent, totalAscent.preferred);
  202.         totalDescent.preferred = Math.max(descent, totalDescent.preferred);
  203.  
  204.         ascent = (int) (req.alignment * req.maximum);
  205.         descent = req.maximum - ascent;
  206.         totalAscent.maximum = Math.max(ascent, totalAscent.maximum);
  207.         totalDescent.maximum = Math.max(descent, totalDescent.maximum);
  208.     }
  209.     int min = (int) Math.min((long) totalAscent.minimum + (long) totalDescent.minimum, Integer.MAX_VALUE);
  210.     int pref = (int) Math.min((long) totalAscent.preferred + (long) totalDescent.preferred, Integer.MAX_VALUE);
  211.     int max = (int) Math.min((long) totalAscent.maximum + (long) totalDescent.maximum, Integer.MAX_VALUE);
  212.     float alignment = 0.0f;
  213.     if (min > 0) {
  214.         alignment = (float) totalAscent.minimum / min;
  215.         alignment = alignment > 1.0f ? 1.0f : alignment < 0.0f ? 0.0f : alignment;
  216.     }
  217.     return new SizeRequirements(min, pref, max, alignment);
  218.     }
  219.  
  220.     /**
  221.      * Creates a bunch of offset/span pairs representing how to
  222.      * lay out a set of components end-to-end.  
  223.      * This method requires that you specify
  224.      * the total amount of space to be allocated,
  225.      * the size requirements for each component to be placed
  226.      * (specified as an array of SizeRequirements), and
  227.      * the total size requirement of the set of components.
  228.      * You can get the total size requirement
  229.      * by invoking the getTiledSizeRequirements method.
  230.      * 
  231.      * @param allocated the total span to be allocated.
  232.      * @param total     the total of the children requests.
  233.      * @param children  the size requirements for each component.
  234.      * @param offset    the offset from 0 for each child where 
  235.      *   the spans were allocated (determines placement of the span).
  236.      * @param spans     the span allocated for each child to make the
  237.      *   total target span.
  238.      */
  239.     public static void calculateTiledPositions(int allocated,
  240.                            SizeRequirements total,
  241.                                SizeRequirements[] children,
  242.                                int[] offsets,
  243.                            int[] spans) {
  244.     if (allocated > total.preferred) {
  245.         expandedTile(allocated, total, children, offsets, spans);
  246.     } else {
  247.         compressedTile(allocated, total, children, offsets, spans);
  248.     }
  249.     }
  250.  
  251.     /**
  252.      * Creates a bunch of offset/span pairs specifying how to
  253.      * lay out a set of components with the specified alignments.
  254.      * The resulting span allocations will overlap, with each one
  255.      * fitting as well as possible into the given total allocation.
  256.      * This method requires that you specify
  257.      * the total amount of space to be allocated,
  258.      * the size requirements for each component to be placed
  259.      * (specified as an array of SizeRequirements), and
  260.      * the total size requirements of the set of components
  261.      * (only the alignment field of which is actually used).
  262.      * You can get the total size requirement by invoking 
  263.      * getAlignedSizeRequirements.
  264.      * 
  265.      * @param allocated the total span to be allocated.
  266.      * @param total     the total of the children requests.
  267.      * @param children  the size requirements for each component.
  268.      * @param offset    the offset from 0 for each child where 
  269.      *   the spans were allocated (determines placement of the span).
  270.      * @param spans     the span allocated for each child to make the
  271.      *   total target span.
  272.      */
  273.     public static void calculateAlignedPositions(int allocated,
  274.                                                  SizeRequirements total,
  275.                                  SizeRequirements[] children,
  276.                                  int[] offsets,
  277.                          int[] spans) {
  278.     int totalAscent = (int) (allocated * total.alignment);
  279.     int totalDescent = allocated - totalAscent;
  280.     for (int i = 0; i < children.length; i++) {
  281.         SizeRequirements req = children[i];
  282.         int maxAscent = (int) (req.maximum * req.alignment);
  283.         int maxDescent = req.maximum - maxAscent;
  284.         int ascent = Math.min(totalAscent, maxAscent);
  285.         int descent = Math.min(totalDescent, maxDescent);
  286.         
  287.         offsets[i] = totalAscent - ascent;
  288.         spans[i] = (int) Math.min((long) ascent + (long) descent, Integer.MAX_VALUE);
  289.     }
  290.     }
  291.  
  292.     private static void compressedTile(int allocated, SizeRequirements total,
  293.                        SizeRequirements[] request,
  294.                        int[] offsets, int[] spans) {
  295.  
  296.     // ---- determine what we have to work with ----
  297.     int totalPlay = Math.min(total.preferred - allocated,
  298.                  total.preferred - total.minimum);
  299.     float factor = (total.preferred - total.minimum == 0) ? 0.0f :
  300.         (float) totalPlay / (total.preferred - total.minimum);
  301.  
  302.     // ---- make the adjustments ----
  303.     int totalOffset = 0;
  304.     for (int i = 0; i < spans.length; i++) {
  305.         offsets[i] = totalOffset;
  306.         SizeRequirements req = request[i];
  307.         int play = (int)(factor * (req.preferred - req.minimum));
  308.         spans[i] = req.preferred - play;
  309.         totalOffset = (int) Math.min((long) totalOffset + (long) spans[i], Integer.MAX_VALUE);
  310.     }
  311.     }
  312.  
  313.     private static void expandedTile(int allocated, SizeRequirements total,
  314.               SizeRequirements[] request,
  315.               int[] offsets, int[] spans) {
  316.  
  317.     // ---- determine what we have to work with ----
  318.     int totalPlay = Math.min(allocated - total.preferred,
  319.                  total.maximum - total.preferred);
  320.     float factor = (total.maximum - total.preferred == 0) ? 0.0f :
  321.         (float) totalPlay / (total.maximum - total.preferred);
  322.  
  323.     // ---- make the adjustments ----
  324.     int totalOffset = 0;
  325.     for (int i = 0; i < spans.length; i++) {
  326.         offsets[i] = totalOffset;
  327.         SizeRequirements req = request[i];
  328.         int play = (int)(factor * (req.maximum - req.preferred));
  329.         spans[i] = (int) Math.min((long) req.preferred + (long) play, Integer.MAX_VALUE);
  330.         totalOffset = (int) Math.min((long) totalOffset + (long) spans[i], Integer.MAX_VALUE);
  331.     }
  332.     }
  333.  
  334. }
  335.