// 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 UiInputImageDef extends AbstractUiInputDef
{
    public static final UiD_Type TYPE = new UiD_Type( CI_INPUT_IMAGE, "InputImage" );
    public static final UiDefTypeFactory FACTORY = new UiDefTypeFactory()
    {
        public UiD_Type getType()
        {
            return TYPE;
        }

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

    public UiD_Type getType()
    {
        return TYPE;
    }

    public UiInputImageDef()
    {
    }

    public UiInputImageDef( String pAttributeName )
    {
        super( pAttributeName );
    }

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

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

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

    public UiInputImageDef forSearchRequired()
    {
        setIntendedUse( IntendedUse.ForSearch_Required );
        return this;
    }

    public UiInputImageDef forSearchDirect()
    {
        setIntendedUse( IntendedUse.ForSearch_Direct );
        return this;
    }

    public UiInputImageDef required()
    {
        setRequired( Boolean.TRUE );
        return this;
    }

    public UiInputImageDef notRequired()
    {
        setRequired( Boolean.FALSE );
        return this;
    }

    public UiInputImageDef labelID( String pLabelID )
    {
        setLabelID( pLabelID );
        return this;
    }

    public UiInputImageDef labelLess()
    {
        setLabelLess( true );
        return this;
    }

    public UiInputImageDef labelFont( UiFont pFont )
    {
        setLabelFont( pFont );
        return this;
    }

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

    public UiInputImageDef width( int pWidth )
    {
        setWidth( pWidth );
        return this;
    }

    public UiInputImageDef height( int pHeight )
    {
        setHeight( pHeight );
        return this;
    }

    protected void collectDefAttributes( UiD_AttributeCollector pCollector )
    {
        super.collectDefAttributes( pCollector );
        pCollector.add( mLabelID );
        pCollector.add( mLabelLess );
        pCollector.add( mRequired );
        pCollector.add( mWidth );
        pCollector.add( mHeight );
    }

    private UiD_AttributeStringOptional mLabelID = new UiD_AttributeStringOptional( "LabelID" );
    private UiD_Attribute_boolean mLabelLess = new UiD_Attribute_boolean( "LabelLess" );
    private UiD_AttributeBoolean mRequired = new UiD_AttributeBoolean( "Required" );

    public AttributeUsage getAttributeUsage( IntendedUse pIntendedUseNonNull )
    {
        return new InputImageAttributeUsage( getAttributeUniqueID(), getAttributeName(), pIntendedUseNonNull,
                                        getLabelID(), isDisabled(), isLabelLess(), getRequired(), null );
    }

    public String getLabelID()
    {
        return mLabelID.getValue();
    }

    public void setLabelID( String pLabelID )
    {
        mLabelID.setValue( pLabelID );
    }

    public Boolean getRequired()
    {
        return mRequired.getValue();
    }

    public void setRequired( Boolean pRequired )
    {
        mRequired.setValue( pRequired );
    }

    public boolean isLabelLess()
    {
        return mLabelLess.isValue();
    }

    public void setLabelLess( boolean pLabelLess )
    {
        mLabelLess.setValue( pLabelLess );
    }

    private UiD_AttributePositive_Integer mWidth = new UiD_AttributePositive_Integer( "Width" );

    public Integer getWidth()
    {
        return mWidth.getValue();
    }

    public void setWidth( Integer pWidth )
    {
        mWidth.setValue( pWidth );
    }

    private UiD_AttributePositive_Integer mHeight = new UiD_AttributePositive_Integer( "Height" );

    public Integer getHeight()
    {
        return mHeight.getValue();
    }

    public void setHeight( Integer pHeight )
    {
        mHeight.setValue( pHeight );
    }

    private static final String FONT_ATTRIBUTE_NAME = "LabelFont";

    private UiFont mLabelFont = null;

    public UiFont getLabelFont()
    {
        return mLabelFont;
    }

    public void setLabelFont( UiFont pFont )
    {
        mLabelFont = pFont;
    }

    private static final String[] FONT_ATTRIBUTE_NAMES = new String[]{FONT_ATTRIBUTE_NAME};

    /**
     * @return entry '0' will be for the 'Label'
     */
    public String[] getFontAttributeNames()
    {
        return FONT_ATTRIBUTE_NAMES;
    }

    public UiFont getFont( String pAttributeName )
    {
        return FONT_ATTRIBUTE_NAME.equals( pAttributeName ) ? getLabelFont() : null;
    }

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