Spring Form : Layout « Swing JFC « Java






Spring Form

Spring Form
      
/* From http://java.sun.com/docs/books/tutorial/index.html */

/*
 * Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * -Redistribution of source code must retain the above copyright notice, this
 *  list of conditions and the following disclaimer.
 *
 * -Redistribution in binary form must reproduce the above copyright notice,
 *  this list of conditions and the following disclaimer in the documentation
 *  and/or other materials provided with the distribution.
 *
 * Neither the name of Sun Microsystems, Inc. or the names of contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * This software is provided "AS IS," without a warranty of any kind. ALL
 * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING
 * ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
 * OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN")
 * AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE
 * AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
 * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR ANY LOST
 * REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL,
 * INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY
 * OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE,
 * EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 *
 * You acknowledge that this software is not designed, licensed or intended
 * for use in the design, construction, operation or maintenance of any
 * nuclear facility.
 */

/*
 * A 1.4 application that uses SpringLayout to create a forms-type layout. Other
 * files required: SpringUtilities.java.
 */

import java.awt.Component;
import java.awt.Container;

import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JTextField;
import javax.swing.Spring;
import javax.swing.SpringLayout;

public class SpringForm {
  /**
   * Create the GUI and show it. For thread safety, this method should be
   * invoked from the event-dispatching thread.
   */
  private static void createAndShowGUI() {
    String[] labels = { "Name: ", "Fax: ", "Email: ", "Address: " };
    int numPairs = labels.length;

    //Create and populate the panel.
    JPanel p = new JPanel(new SpringLayout());
    for (int i = 0; i < numPairs; i++) {
      JLabel l = new JLabel(labels[i], JLabel.TRAILING);
      p.add(l);
      JTextField textField = new JTextField(10);
      l.setLabelFor(textField);
      p.add(textField);
    }

    //Lay out the panel.
    SpringUtilities.makeCompactGrid(p, numPairs, 2, //rows, cols
        6, 6, //initX, initY
        6, 6); //xPad, yPad

    //Make sure we have nice window decorations.
    JFrame.setDefaultLookAndFeelDecorated(true);

    //Create and set up the window.
    JFrame frame = new JFrame("SpringForm");
    frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

    //Set up the content pane.
    p.setOpaque(true); //content panes must be opaque
    frame.setContentPane(p);

    //Display the window.
    frame.pack();
    frame.setVisible(true);
  }

  public static void main(String[] args) {
    //Schedule a job for the event-dispatching thread:
    //creating and showing this application's GUI.
    javax.swing.SwingUtilities.invokeLater(new Runnable() {
      public void run() {
        createAndShowGUI();
      }
    });
  }
}

/**
 * A 1.4 file that provides utility methods for creating form- or grid-style
 * layouts with SpringLayout. These utilities are used by several programs, such
 * as SpringBox and SpringCompactGrid.
 */

class SpringUtilities {
  /**
   * A debugging utility that prints to stdout the component's minimum,
   * preferred, and maximum sizes.
   */
  public static void printSizes(Component c) {
    System.out.println("minimumSize = " + c.getMinimumSize());
    System.out.println("preferredSize = " + c.getPreferredSize());
    System.out.println("maximumSize = " + c.getMaximumSize());
  }

  /**
   * Aligns the first <code>rows</code>*<code>cols</code> components of
   * <code>parent</code> in a grid. Each component is as big as the maximum
   * preferred width and height of the components. The parent is made just big
   * enough to fit them all.
   * 
   * @param rows
   *            number of rows
   * @param cols
   *            number of columns
   * @param initialX
   *            x location to start the grid at
   * @param initialY
   *            y location to start the grid at
   * @param xPad
   *            x padding between cells
   * @param yPad
   *            y padding between cells
   */
  public static void makeGrid(Container parent, int rows, int cols,
      int initialX, int initialY, int xPad, int yPad) {
    SpringLayout layout;
    try {
      layout = (SpringLayout) parent.getLayout();
    } catch (ClassCastException exc) {
      System.err
          .println("The first argument to makeGrid must use SpringLayout.");
      return;
    }

    Spring xPadSpring = Spring.constant(xPad);
    Spring yPadSpring = Spring.constant(yPad);
    Spring initialXSpring = Spring.constant(initialX);
    Spring initialYSpring = Spring.constant(initialY);
    int max = rows * cols;

    //Calculate Springs that are the max of the width/height so that all
    //cells have the same size.
    Spring maxWidthSpring = layout.getConstraints(parent.getComponent(0))
        .getWidth();
    Spring maxHeightSpring = layout.getConstraints(parent.getComponent(0))
        .getWidth();
    for (int i = 1; i < max; i++) {
      SpringLayout.Constraints cons = layout.getConstraints(parent
          .getComponent(i));

      maxWidthSpring = Spring.max(maxWidthSpring, cons.getWidth());
      maxHeightSpring = Spring.max(maxHeightSpring, cons.getHeight());
    }

    //Apply the new width/height Spring. This forces all the
    //components to have the same size.
    for (int i = 0; i < max; i++) {
      SpringLayout.Constraints cons = layout.getConstraints(parent
          .getComponent(i));

      cons.setWidth(maxWidthSpring);
      cons.setHeight(maxHeightSpring);
    }

    //Then adjust the x/y constraints of all the cells so that they
    //are aligned in a grid.
    SpringLayout.Constraints lastCons = null;
    SpringLayout.Constraints lastRowCons = null;
    for (int i = 0; i < max; i++) {
      SpringLayout.Constraints cons = layout.getConstraints(parent
          .getComponent(i));
      if (i % cols == 0) { //start of new row
        lastRowCons = lastCons;
        cons.setX(initialXSpring);
      } else { //x position depends on previous component
        cons.setX(Spring.sum(lastCons.getConstraint(SpringLayout.EAST),
            xPadSpring));
      }

      if (i / cols == 0) { //first row
        cons.setY(initialYSpring);
      } else { //y position depends on previous row
        cons.setY(Spring.sum(lastRowCons
            .getConstraint(SpringLayout.SOUTH), yPadSpring));
      }
      lastCons = cons;
    }

    //Set the parent's size.
    SpringLayout.Constraints pCons = layout.getConstraints(parent);
    pCons.setConstraint(SpringLayout.SOUTH, Spring.sum(Spring
        .constant(yPad), lastCons.getConstraint(SpringLayout.SOUTH)));
    pCons.setConstraint(SpringLayout.EAST, Spring.sum(
        Spring.constant(xPad), lastCons
            .getConstraint(SpringLayout.EAST)));
  }

  /* Used by makeCompactGrid. */
  private static SpringLayout.Constraints getConstraintsForCell(int row,
      int col, Container parent, int cols) {
    SpringLayout layout = (SpringLayout) parent.getLayout();
    Component c = parent.getComponent(row * cols + col);
    return layout.getConstraints(c);
  }

  /**
   * Aligns the first <code>rows</code>*<code>cols</code> components of
   * <code>parent</code> in a grid. Each component in a column is as wide as
   * the maximum preferred width of the components in that column; height is
   * similarly determined for each row. The parent is made just big enough to
   * fit them all.
   * 
   * @param rows
   *            number of rows
   * @param cols
   *            number of columns
   * @param initialX
   *            x location to start the grid at
   * @param initialY
   *            y location to start the grid at
   * @param xPad
   *            x padding between cells
   * @param yPad
   *            y padding between cells
   */
  public static void makeCompactGrid(Container parent, int rows, int cols,
      int initialX, int initialY, int xPad, int yPad) {
    SpringLayout layout;
    try {
      layout = (SpringLayout) parent.getLayout();
    } catch (ClassCastException exc) {
      System.err
          .println("The first argument to makeCompactGrid must use SpringLayout.");
      return;
    }

    //Align all cells in each column and make them the same width.
    Spring x = Spring.constant(initialX);
    for (int c = 0; c < cols; c++) {
      Spring width = Spring.constant(0);
      for (int r = 0; r < rows; r++) {
        width = Spring.max(width, getConstraintsForCell(r, c, parent,
            cols).getWidth());
      }
      for (int r = 0; r < rows; r++) {
        SpringLayout.Constraints constraints = getConstraintsForCell(r,
            c, parent, cols);
        constraints.setX(x);
        constraints.setWidth(width);
      }
      x = Spring.sum(x, Spring.sum(width, Spring.constant(xPad)));
    }

    //Align all cells in each row and make them the same height.
    Spring y = Spring.constant(initialY);
    for (int r = 0; r < rows; r++) {
      Spring height = Spring.constant(0);
      for (int c = 0; c < cols; c++) {
        height = Spring.max(height, getConstraintsForCell(r, c, parent,
            cols).getHeight());
      }
      for (int c = 0; c < cols; c++) {
        SpringLayout.Constraints constraints = getConstraintsForCell(r,
            c, parent, cols);
        constraints.setY(y);
        constraints.setHeight(height);
      }
      y = Spring.sum(y, Spring.sum(height, Spring.constant(yPad)));
    }

    //Set the parent's size.
    SpringLayout.Constraints pCons = layout.getConstraints(parent);
    pCons.setConstraint(SpringLayout.SOUTH, y);
    pCons.setConstraint(SpringLayout.EAST, x);
  }
}
           
         
    
    
    
    
    
  








Related examples in the same category

1.Laying Out Components in a Flow (Left-to-Right, Top-to-Bottom)
2.Use FlowLayout to hold checkBox, Label and TextField
3.Vertical and horizontal BoxLayoutsVertical and horizontal BoxLayouts
4.Box Layout: Adding struts.Box Layout: Adding struts.
5.Using GlueUsing Glue
6.Rigid areas are like pairs of strutsRigid areas are like pairs of struts
7.Demonstrates BorderLayoutDemonstrates BorderLayout
8.Demonstrates GridLayoutDemonstrates GridLayout
9.Demonstrates FlowLayoutDemonstrates FlowLayout
10.A test of the BoxLayout manager using the Box utility classA test of the BoxLayout manager using the Box utility class
11.A test of the box layout manager using the Box utility class 2A test of the box layout manager using the Box utility class 2
12.A test of the OverlayLayout manager allowing experimentationA test of the OverlayLayout manager allowing experimentation
13.Box layout manager using the Box utility classBox layout manager using the Box utility class
14.BoxLayout demo 1BoxLayout demo 1
15.A demonstration of the SpringLayout class
16.A test of the BoxLayout manager using the Box utility class 3A test of the BoxLayout manager using the Box utility class 3
17.BoxLayout AlignmentBoxLayout Alignment
18.BoxLayout alignment 2BoxLayout alignment 2
19.BoxLayout Component alignmentBoxLayout Component alignment
20.BoxLayout X Y alignmentBoxLayout X Y alignment
21.BoxLayout: Glue SampleBoxLayout: Glue Sample
22.Layout: Overlay SampleLayout: Overlay Sample
23.BoxLayout: setAlignmentX setAlignmentYBoxLayout: setAlignmentX setAlignmentY
24.Component AlignmentComponent Alignment
25.GridLayout Demo 3GridLayout Demo 3
26.BoxLayout SampleBoxLayout Sample
27.BoxLayout Demo 3BoxLayout Demo 3
28.Various layoutsVarious layouts
29.BoxLayout Demo 4BoxLayout Demo 4
30.GridLayout DemoGridLayout Demo
31.CardLayout DemoCardLayout Demo
32.Using CardLayout
33.Laying Out a Screen with CardLayoutLaying Out a Screen with CardLayout
34.Laying out a screen with SpringLayoutLaying out a screen with SpringLayout
35.BorderLayout PaneBorderLayout Pane
36.Add buttons to all parts of a BorderLayout
37.A BorderLayout divides the space into five regions: North, West, South, East and Centre.
38.A typical usage of a border layout manager.
39.BoxLayout PaneBoxLayout Pane
40.FlowLayout PaneFlowLayout Pane
41.GridLayout PaneGridLayout Pane
42.Laying Out Components in a Grid
43.NullLayout PaneNullLayout Pane
44.Without layout manager, we position components using absolute values.
45.Simpler CardLayout demo
46.Use SpringLayout to create a single row of componentsUse SpringLayout to create a single row of components
47. Spring Demo 1 Spring Demo 1
48.Spring Demo 2Spring Demo 2
49.Spring Demo 3Spring Demo 3
50.Spring Demo 4Spring Demo 4
51.Spring Compact GridSpring Compact Grid
52.SpringLayout Utilities
53.Absolute Layout DemoAbsolute Layout Demo
54.A horizontal layout layout manager that allocates horizontal space in specified proportions
55.Laying Out Components Using Absolute Coordinates
56.A vertical layout manager similar to java.awt.FlowLayout
57.A JTextField for displaying insets.
58.A layout manager that lays out components along a circleA layout manager that lays out components along a circle
59.A frame that uses a group layout to arrange font selection components
60.Utility methods for creating form- or grid-style layouts with SpringLayout.
61.A vertical flow layout is similar to a flow layuot but it layouts the components vertically instead of horizontally.