home *** CD-ROM | disk | FTP | other *** search
/ Chip 1998 November / Chip_1998-11_cd.bin / tema / Cafe / jfc.bin / OverlayLayout.java < prev    next >
Text File  |  1998-02-26  |  8KB  |  242 lines
  1. /*
  2.  * @(#)OverlayLayout.java    1.12 98/02/02
  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.  * A layout manager to arrange components over the top
  28.  * of each other.  The requested size of the container
  29.  * will be the largest requested size of the children, 
  30.  * taking alignment needs into consideration.  
  31.  *
  32.  * The alignment is based upon what is needed to properly
  33.  * fit the children in the allocation area.  The children
  34.  * will be placed such that their alignment points are all
  35.  * on top of each other.
  36.  * <p>
  37.  * Warning: serialized objects of this class will not be compatible with
  38.  * future swing releases.  The current serialization support is appropriate 
  39.  * for short term storage or RMI between Swing1.0 applications.  It will
  40.  * not be possible to load serialized Swing1.0 objects with future releases
  41.  * of Swing.  The JDK1.2 release of Swing will be the compatibility
  42.  * baseline for the serialized form of Swing objects.
  43.  *
  44.  * @version 1.12 02/02/98
  45.  * @author   Timothy Prinzing
  46.  */
  47. public class OverlayLayout implements LayoutManager2,Serializable {
  48.  
  49.     /**
  50.      * Construct a layout manager that performs overlay
  51.      * arrangment of the children.  The layout manager
  52.      * created is dedicated to the given container.
  53.      *
  54.      * @param target  The container to do layout against.
  55.      */
  56.     public OverlayLayout(Container target) {
  57.     this.target = target;
  58.     }
  59.  
  60.     /**
  61.      * Indicates a child has changed it's layout related information
  62.      * which causes any cached calculations to be flushed.
  63.      */
  64.     public void invalidateLayout(Container target) {
  65.     checkContainer(target);
  66.     xChildren = null;
  67.     yChildren = null;
  68.     xTotal = null;
  69.     yTotal = null;
  70.     }
  71.  
  72.     /**
  73.      * Adds the specified component to the layout. Not used by this class.
  74.      * @param name the name of the component
  75.      * @param comp the the component to be added
  76.      */
  77.     public void addLayoutComponent(String name, Component comp) {
  78.     }
  79.  
  80.     /**
  81.      * Removes the specified component from the layout. Not used by
  82.      * this class.  
  83.      * @param comp the component to remove
  84.      */
  85.     public void removeLayoutComponent(Component comp) {
  86.     }
  87.  
  88.     /**
  89.      * Adds the specified component to the layout, using the specified
  90.      * constraint object.
  91.      * @param comp the component to be added
  92.      * @param constraints  where/how the component is added to the layout.
  93.      */
  94.     public void addLayoutComponent(Component comp, Object constraints) {
  95.     }
  96.  
  97.     /**
  98.      * Returns the preferred dimensions for this layout given the components
  99.      * in the specified target container.
  100.      * @param target the component which needs to be laid out
  101.      * @see Container
  102.      * @see #minimumLayoutSize
  103.      */
  104.     public Dimension preferredLayoutSize(Container target) {
  105.     checkContainer(target);
  106.     checkRequests();
  107.  
  108.     Dimension size = new Dimension(xTotal.preferred, yTotal.preferred);
  109.     Insets insets = target.getInsets();
  110.     size.width += insets.left + insets.right;
  111.     size.height += insets.top + insets.bottom;
  112.     return size;
  113.     }
  114.  
  115.     /**
  116.      * Returns the minimum dimensions needed to layout the components
  117.      * contained in the specified target container.
  118.      * @param target the component which needs to be laid out 
  119.      * @see #preferredLayoutSize
  120.      */
  121.     public Dimension minimumLayoutSize(Container target) {
  122.     checkContainer(target);
  123.     checkRequests();
  124.  
  125.     Dimension size = new Dimension(xTotal.minimum, yTotal.minimum);
  126.     Insets insets = target.getInsets();
  127.     size.width += insets.left + insets.right;
  128.     size.height += insets.top + insets.bottom;
  129.     return size;
  130.     }
  131.  
  132.     /**
  133.      * Returns the minimum dimensions needed to layout the components
  134.      * contained in the specified target container.
  135.      * @param target the component which needs to be laid out 
  136.      * @see #preferredLayoutSize
  137.      */
  138.     public Dimension maximumLayoutSize(Container target) {
  139.     checkContainer(target);
  140.     checkRequests();
  141.  
  142.     Dimension size = new Dimension(xTotal.maximum, yTotal.maximum);
  143.     Insets insets = target.getInsets();
  144.     size.width += insets.left + insets.right;
  145.     size.height += insets.top + insets.bottom;
  146.     return size;
  147.     }
  148.  
  149.     /**
  150.      * Returns the alignment along the x axis for the container.
  151.      * If the major axis of the box is the x axis the default
  152.      * alignment will be returned, otherwise the alignment needed
  153.      * to place the children along the x axis will be returned.
  154.      */
  155.     public float getLayoutAlignmentX(Container target) {
  156.     checkContainer(target);
  157.     checkRequests();
  158.     return xTotal.alignment;
  159.     }
  160.  
  161.     /**
  162.      * Returns the alignment along the y axis for the container.
  163.      * If the major axis of the box is the y axis the default
  164.      * alignment will be returned, otherwise the alignment needed
  165.      * to place the children along the y axis will be returned.
  166.      */
  167.     public float getLayoutAlignmentY(Container target) {
  168.     checkContainer(target);
  169.     checkRequests();
  170.     return yTotal.alignment;
  171.     }
  172.  
  173.     public void layoutContainer(Container target) {
  174.     checkContainer(target);
  175.     checkRequests();
  176.     
  177.     int nChildren = target.getComponentCount();
  178.     int[] xOffsets = new int[nChildren];
  179.     int[] xSpans = new int[nChildren];
  180.     int[] yOffsets = new int[nChildren];
  181.     int[] ySpans = new int[nChildren];
  182.  
  183.     // determine the child placements
  184.     Dimension alloc = target.getSize();
  185.     Insets in = target.getInsets();
  186.     alloc.width -= in.left + in.right;
  187.     alloc.height -= in.top + in.bottom;
  188.     SizeRequirements.calculateAlignedPositions(alloc.width, xTotal, 
  189.                            xChildren, xOffsets,
  190.                            xSpans);
  191.     SizeRequirements.calculateAlignedPositions(alloc.height, yTotal,
  192.                            yChildren, yOffsets,
  193.                            ySpans);
  194.  
  195.     // flush changes to the container
  196.     for (int i = 0; i < nChildren; i++) {
  197.         Component c = target.getComponent(i);
  198.         c.setBounds(in.left + xOffsets[i], in.top + yOffsets[i],
  199.             xSpans[i], ySpans[i]);
  200.     }
  201.     }
  202.  
  203.     void checkContainer(Container target) {
  204.     if (this.target != target) {
  205.         throw new AWTError("OverlayLayout can't be shared");
  206.     }
  207.     }
  208.     
  209.     void checkRequests() {
  210.     if (xChildren == null || yChildren == null) {
  211.         // The requests have been invalidated... recalculate
  212.         // the request information.
  213.         int n = target.getComponentCount();
  214.         xChildren = new SizeRequirements[n];
  215.         yChildren = new SizeRequirements[n];
  216.         for (int i = 0; i < n; i++) {
  217.         Component c = target.getComponent(i);
  218.         Dimension min = c.getMinimumSize();
  219.         Dimension typ = c.getPreferredSize();
  220.         Dimension max = c.getMaximumSize();
  221.         xChildren[i] = new SizeRequirements(min.width, typ.width, 
  222.                             max.width, 
  223.                             c.getAlignmentX());
  224.         yChildren[i] = new SizeRequirements(min.height, typ.height, 
  225.                             max.height, 
  226.                             c.getAlignmentY());
  227.         }
  228.         
  229.         xTotal = SizeRequirements.getAlignedSizeRequirements(xChildren);
  230.         yTotal = SizeRequirements.getAlignedSizeRequirements(yChildren);
  231.     }
  232.     }
  233.         
  234.     private Container target;
  235.     private SizeRequirements[] xChildren;
  236.     private SizeRequirements[] yChildren;
  237.     private SizeRequirements xTotal;
  238.     private SizeRequirements yTotal;
  239.     
  240. }
  241.  
  242.