// This Source Code is in the Public Domain per: http://unlicense.org
package org.litesoft.ui.def.nonpublic.support;

import org.litesoft.ui.support.*;
import org.litesoft.uispecification.*;

public abstract class UiLayoutTwoDimensionalDef extends UiMultiCellLayoutDef
{
    public static final int DEFAULT_COLUMNS = 2;

    protected UiLayoutTwoDimensionalDef()
    {
    }

    protected UiLayoutTwoDimensionalDef( int pColumns )
            throws IllegalArgumentException
    {
        setColumns( pColumns );
    }

    public UiLayoutTwoDimensionalDef forEdit()
    {
        setIntendedUse( IntendedUse.ForEdit );
        return this;
    }

    public UiLayoutTwoDimensionalDef forSearch()
    {
        setIntendedUse( IntendedUse.ForSearch );
        return this;
    }

    public UiLayoutTwoDimensionalDef forView()
    {
        setIntendedUse( IntendedUse.ForView );
        return this;
    }

    public UiLayoutTwoDimensionalDef bordered()
    {
        setBordered( true );
        return this;
    }

    public UiLayoutTwoDimensionalDef bordered( String pExtName )
    {
        setExtTitle( pExtName );
        return this;
    }

    public UiLayoutTwoDimensionalDef bordered( String pExtName, UiFont pFont )
    {
        setExtTitle( pExtName );
        setTitleFont( pFont );
        return this;
    }

    public UiLayoutTwoDimensionalDef scrolled()
    {
        LLsetScrolled();
        return this;
    }

    public UiLayoutTwoDimensionalDef clipped()
    {
        LLsetClipped();
        return this;
    }

    public UiLayoutTwoDimensionalDef allCellsSameSize()
    {
        setAllCellsSameSize( true );
        return this;
    }

    private UiD_Attribute_Column mColumns = new UiD_Attribute_Column();

    public int getColumns()
    {
        return mColumns.getValue();
    }

    public void setColumns( int pColumns )
            throws IllegalArgumentException
    {
        validateAtLeastTwoColumns( pColumns );
        mColumns.setValue( pColumns );
    }

    public static void validateAtLeastTwoColumns( int pColumns )
    {
        if ( pColumns < 2 )
        {
            throw new IllegalArgumentException( "The number of Columns may NOT be less than 2" );
        }
    }

    public int getRows()
    {
        return getComponentGrid().getRows();
    }

    public ComponentGrid getComponentGrid()
    {
        if ( isDefineMode() )
        {
            throw new IllegalStateException( "method only available in Rendered Mode" );
        }
        validate();
        return ((AbstractUiChildrenHelperTwoDimensional) getChildrenHelper()).getComponentGrid();
    }

    public static class UiD_Attribute_Column extends UiD_Attribute_int
    {
        public UiD_Attribute_Column()
        {
            super( "Columns", DEFAULT_COLUMNS );
        }

        public String nonDefaultValueToString()
        {
            return Integer.toString( getValue() ); // Always show value!
        }
    }
}