001    /*
002     * Copyright 2002-2004 the original author or authors.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License"); you may not
005     * use this file except in compliance with the License. You may obtain a copy of
006     * the License at
007     *
008     * http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
012     * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
013     * License for the specific language governing permissions and limitations under
014     * the License.
015     */
016    package org.springframework.richclient.layout;
017    
018    import javax.swing.JPanel;
019    
020    /**
021     * LayoutBuilders exist to make it easier to do component layouts. Typical usage
022     * is to create an instance of the builder, add components to it, the call the
023     * builder's {@link #getPanel()}method.
024     */
025    public interface LayoutBuilder {
026    
027        /**
028         * Creates and returns a JPanel with all the given components in it, using
029         * the "hints" that were provided to the builder.
030         * 
031         * @return a new JPanel with the components laid-out in it; never null
032         */
033        JPanel getPanel();
034    
035    }