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

import org.litesoft.core.typeutils.*;
import org.litesoft.ui.def.*;
import org.litesoft.ui.def.nonpublic.support.*;
import org.litesoft.ui.support.*;
import org.litesoft.uispecification.*;

public class UiRelSubFormDef extends UiCompDef implements UiContainerMarker,
                                                          UiTitleBorderSource,
                                                          AttributeUniqueable,
                                                          FormUniqueable
{
    public static final UiD_Type TYPE = new UiD_Type( CI_REL_SUB_FORM, "RelSubForm" );
    public static final UiDefTypeFactory FACTORY = new UiDefTypeFactory()
    {
        public UiD_Type getType()
        {
            return TYPE;
        }

        public UiDef create()
        {
            return new UiRelSubFormDef();
        }
    };

    public UiD_Type getType()
    {
        return TYPE;
    }

    public UiRelSubFormDef()
    {
        mChildrenHelper = new UiChildrenHelperRequiredSingleContainer( this );
    }

    public UiRelSubFormDef( String pAttributeName, UiCompDef pCompDef )
    {
        this();
        setAttributeName( pAttributeName );
        if ( pCompDef != null )
        {
            if ( !(pCompDef instanceof UiContainerDef) )
            {
                pCompDef = new UiSingleLayoutDef( pCompDef );
            }
            getChildrenHelper().addChild( pCompDef );
        }
    }

    public UiRelSubFormDef disabled()
    {
        setDisabled( true );
        return this;
    }

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

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

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

    public UiRelSubFormDef tabbedUsing( String pTabAttributeName )
    {
        return tabbedUsing( pTabAttributeName, null );
    }

    public UiRelSubFormDef tabbedUsing( String pTabAttributeName, UiFont pFont )
    {
        setTabAttributeName( Strings.assertNotNullNotEmpty( "TabAttributeName", pTabAttributeName ) );
        setTabsFont( pFont );
        return this;
    }

    public UiContainerDef getSubFormDef()
    {
        return (UiContainerDef) getChildrenHelper().getFirstChild();
    }

    public UiChildrenHelper getChildrenHelper()
    {
        return mChildrenHelper;
    }

    protected void collectDefAttributes( UiD_AttributeCollector pCollector )
    {
        super.collectDefAttributes( pCollector );
        pCollector.add( mDisabled );
        pCollector.add( mAttributeName );
        pCollector.add( mBordered );
        pCollector.add( mExtTitle );
        pCollector.add( mTabAttributeName );
    }

    private UiD_AttributeDisabled mDisabled = new UiD_AttributeDisabled();

    public boolean isDisabled()
    {
        return mDisabled.isValue();
    }

    public void setDisabled( boolean pDisabled )
    {
        mDisabled.setValue( pDisabled );
    }

    private UiD_AttributeAttributeNameRequired mAttributeName = new UiD_AttributeAttributeNameRequired();

    public String getAttributeName()
    {
        return mAttributeName.getValue();
    }

    public void setAttributeName( String pAttributeName )
    {
        mAttributeName.setValue( pAttributeName );
    }

    private UiD_Attribute_boolean mBordered = new UiD_Attribute_boolean( "Bordered" );
    private UiD_AttributeStringOptional mExtTitle = new UiD_AttributeStringOptional( "ExtTitle" );

    public boolean isBordered()
    {
        return mBordered.isValue();
    }

    public void setBordered( boolean pBordered )
    {
        mBordered.setValue( pBordered );
    }

    public void setExtTitle( String pExtTitle )
    {
        mExtTitle.setValue( pExtTitle );
    }

    public String getExtTitle()
    {
        return mExtTitle.getValue();
    }

    public String getLabelID()
    {
        return getExtTitle();
    }

    public final LabelUsage getLabelUsage()
    {
        String zTitle = getExtTitle();
        return (zTitle != null) ? new LabelUsage( zTitle ) : null;
    }

    private static final String TITLE_FONT_ATTRIBUTE_NAME = "TitleFont";

    private UiFont mTitleFont = null;

    public UiFont getTitleFont()
    {
        return mTitleFont;
    }

    public void setTitleFont( UiFont pFont )
    {
        mTitleFont = pFont;
    }

    private UiD_AttributeStringOptional mTabAttributeName =
            new UiD_AttributeStringOptional( "TabAttributeName" );

    public String getTabAttributeName()
    {
        return mTabAttributeName.getValue();
    }

    public void setTabAttributeName( String pTabAttributeName )
    {
        mTabAttributeName.setValue( pTabAttributeName );
    }

    public AttributeUsage getTabAttributeUsage()
    {
        String zName = getTabAttributeName();
        return (zName != null) ? new AttributeUsage( getAttributeUniqueID(), zName ) : null;
    }

    public Integer getAttributeUniqueID()
    {
        return mAttributeUniqueID;
    }

    private Integer mAttributeUniqueID = null;

    public void setAttributeUniqueID( Integer pUniqueID )
    {
        mAttributeUniqueID = pUniqueID;
    }

    private static final String TABS_FONT_ATTRIBUTE_NAME = "TabsFont";

    private UiFont mTabsFont = null;

    public UiFont getTabsFont()
    {
        return mTabsFont;
    }

    public void setTabsFont( UiFont pFont )
    {
        mTabsFont = pFont;
    }

    private static final String[] FONT_ATTRIBUTE_NAMES = new String[] //
            { //
              TITLE_FONT_ATTRIBUTE_NAME, //
              TABS_FONT_ATTRIBUTE_NAME, //
            };

    public String[] getFontAttributeNames()
    {
        return FONT_ATTRIBUTE_NAMES;
    }

    public UiFont getFont( String pAttributeName )
    {
        return TABS_FONT_ATTRIBUTE_NAME.equals( pAttributeName ) ? getTabsFont() :
               TITLE_FONT_ATTRIBUTE_NAME.equals( pAttributeName ) ? getTitleFont() : //
               null;
    }

    public void setFont( String pAttributeName, UiFont pUiFont )
    {
        if ( TABS_FONT_ATTRIBUTE_NAME.equals( pAttributeName ) )
        {
            setTabsFont( pUiFont );
            return;
        }
        if ( TITLE_FONT_ATTRIBUTE_NAME.equals( pAttributeName ) )
        {
            setTitleFont( pUiFont );
            return;
        }
        throw new IllegalArgumentException( "Invalid Font AttributeName '" + pAttributeName + "', " +
                                            Objects.optionsToString( FONT_ATTRIBUTE_NAMES ) );
    }

    public Integer getFormUniqueID()
    {
        return mFormUniqueID;
    }

    private Integer mFormUniqueID = null;

    public void setFormUniqueID( Integer pUniqueID )
    {
        mFormUniqueID = pUniqueID;
    }
}