/*
 * Copyright (c) 2011, grossmann, nimoll
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * 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.
 * * Neither the name of the jo-widgets.org 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 jo-widgets.org 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 org.jowidgets.api.layout.miglayout;

import org.jowidgets.api.layout.ILayoutFactory;
import org.jowidgets.common.widgets.layout.MigLayoutDescriptor;

public interface IMigLayoutFactoryBuilder {

    /**
     * Sets the row, column and layout constraints based on mig layout descriptor
     * 
     * @param descriptor The mig layout descriptor to use, must no be null
     * 
     * @return This builder
     */
    IMigLayoutFactoryBuilder descriptor(MigLayoutDescriptor descriptor);

    /**
     * Sets the row constraints
     * 
     * @param constraints The constraints to set
     * 
     * @return This builder
     */
    IMigLayoutFactoryBuilder rowConstraints(String constraints);

    /**
     * Sets the column constraints
     * 
     * @param constraints The constraints to set
     * 
     * @return This builder
     */
    IMigLayoutFactoryBuilder columnConstraints(String constraints);

    /**
     * Sets the layout constraints
     * 
     * @param constraints The constraints to set
     * 
     * @return This builder
     */
    IMigLayoutFactoryBuilder constraints(String constraints);

    /**
     * Sets the row constraints
     * 
     * @param constraints The constraints to set
     * 
     * @return This builder
     */
    IMigLayoutFactoryBuilder rowConstraints(IAC constraints);

    /**
     * Sets the column constraints
     * 
     * @param constraints The constraints to set
     * 
     * @return This builder
     */
    IMigLayoutFactoryBuilder columnConstraints(IAC constraints);

    /**
     * Sets the layout constraints
     * 
     * @param constraints The constraints to set
     * 
     * @return This builder
     */
    IMigLayoutFactoryBuilder constraints(ILC constraints);

    /**
     * Creates a new layout factory for 'IMigLayout'
     * 
     * @return A new layout factory for 'IMigLayout', never null
     */
    ILayoutFactory<IMigLayout> build();

}