com.jgoodies.looks.MicroLayoutPolicy Maven / Gradle / Ivy

/*
 * Copyright (c) 2001-2014 JGoodies Software GmbH. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  o Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 *  o Redistributions 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.
 *
 *  o Neither the name of JGoodies Software GmbH nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.jgoodies.looks;

import javax.swing.UIDefaults;


/**
 * Looks up and returns a MicroLayout.
 *
 * @author  Karsten Lentzsch
 * @version $Revision: 1.6 $
 *
 * @see MicroLayout
 * @see MicroLayoutPolicies
 *
 * @since 2.1
 */
public interface MicroLayoutPolicy {

    /**
     * Looks up and returns insets, margins, and gaps that will be used
     * by a Look&Feel to set the component insets, margins and gaps.
     *
     * This method is invoked during the L&F component initialization.
     * And the invoker hands over the UIDefaults object used to define
     * the component settings. Hence, the UIDefaults object may be used
     * to look up values as initialized by a super Look&Feel.
     * For example the JGoodies Windows L&F could use the
     * defaults set by the super L&F, the Sun Windows L&F.
     *
     * @param lafName the name of the Look&Feel that requests the fonts
     * @param table   the UIDefaults table that can be used
     *     to look up fonts of a super L&F
     *
     * @return a micro layout used as default for the components.
     */
    MicroLayout getMicroLayout(String lafName, UIDefaults table);

}