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

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

public class UI_common
{
    public interface Hints
    {
        public static final String FORMAT_CONTROL = "FormatControl"; // See NumericFormatControl
        public static final String DECIMAL_PLACES = "DecimalPlaces";
        public static final String CURRENCY = "Currency"; // See Currency
        public static final String TIME_RES = "TimeRes"; // See TimeRes
        public static final String DATE_FORMAT = "DateFormat"; // See CalendarYMD

        public static final String VALID_OPTIONS = "ValidOptions"; // 1st char is sep

        public static final String BOOLEAN_VIEW = "BooleanView";
        public static final char BV_SEP = '/';

        public static final Hintable.Hint BV_YES_NO = new Hintable.Hint( BOOLEAN_VIEW, "YES/NO" );
        public static final Hintable.Hint BV_Yes_No = new Hintable.Hint( BOOLEAN_VIEW, "Yes/No" );
        public static final Hintable.Hint BV_Y_N = new Hintable.Hint( BOOLEAN_VIEW, "Y/N" );
        public static final Hintable.Hint BV_T_F = new Hintable.Hint( BOOLEAN_VIEW, "T/F" );
        public static final Hintable.Hint BV_TRUE_False = new Hintable.Hint( BOOLEAN_VIEW, "TRUE/FALSE" );
        public static final Hintable.Hint BV_True_False = new Hintable.Hint( BOOLEAN_VIEW, "True/False" );
        public static final Hintable.Hint BV_true_false = new Hintable.Hint( BOOLEAN_VIEW, "true/false" );

        public static final String COMBO_DEFAULT = "ComboDefault";
        public static final String COMBO_REQUIRED_DEFAULT = "ComboRequiredDefault";

        public static final Hintable.Hint CRD_Select = new Hintable.Hint( COMBO_REQUIRED_DEFAULT, "Select" );

        public static final String COMPONENT_FORM = "ComponentForm";

        public static final String CF_RADIO_GROUP = "RadioGroup";
        public static final String CF_COMBO_BOX = "ComboBox";
        public static final String CF_TEXT_AREA = "TextArea";
        public static final String CF_TEXT_FIELD = "TextField";
        public static final String CF_TEXT_FIELD_RIGHT_ALIGNED = "TextFieldRightAligned";

        public static final Hintable.Hint RADIO_GROUP = new Hintable.Hint( COMPONENT_FORM, CF_RADIO_GROUP );
        public static final Hintable.Hint COMBO_BOX = new Hintable.Hint( COMPONENT_FORM, CF_COMBO_BOX );
        public static final Hintable.Hint TEXT_AREA = new Hintable.Hint( COMPONENT_FORM, CF_TEXT_AREA );
        public static final Hintable.Hint TEXT_FIELD = new Hintable.Hint( COMPONENT_FORM, CF_TEXT_FIELD );
        public static final Hintable.Hint TEXT_FIELD_RIGHT_ALIGNED = new Hintable.Hint( COMPONENT_FORM, //
                                                                                        CF_TEXT_FIELD_RIGHT_ALIGNED );

        public static final String TEXT_FIELD_WIDTH = "TextFieldWidth";

        public static final String TEXT_AREA_WIDTH = "TextAreaWidth";
        public static final String TEXT_AREA_LINES = "TextAreaLines";

        public static final String TEXT_AREA_NO_WRAP_CONTENTS = "TextAreaNoWrap";

        public static final Hintable.Hint TA_WRAP = new Hintable.Hint( TEXT_AREA_NO_WRAP_CONTENTS, "false" );
        public static final Hintable.Hint TA_NOWRAP = new Hintable.Hint( TEXT_AREA_NO_WRAP_CONTENTS, "true" );
    }

    public static final UiFont FONT = UiFont.NULL;

    public static UiActionDef action( String pActionID )
    {
        return new UiActionDef( pActionID );
    }

    public static UiCardDef card( String pCardKey, UiCompDef pContent )
    {
        return new UiCardDef( pCardKey, pContent );
    }

    public static UiHiddenAttributeDef hidden( String pAttributeName )
    {
        return new UiHiddenAttributeDef( pAttributeName );
    }

    public static UiImageDef image( String pImageID )
    {
        return new UiImageDef( pImageID );
    }

    public static UiInputActionDef inputAction( String pAttributeName )
    {
        return new UiInputActionDef( pAttributeName );
    }

    public static UiInputImageDef inputImage( String pAttributeName )
    {
        return new UiInputImageDef( pAttributeName );
    }

    public static UiInputDef input( String pAttributeName )
    {
        return new UiInputDef( pAttributeName );
    }

    public static UiLabelDef label( String pLabelID )
    {
        return new UiLabelDef( pLabelID );
    }

    public static UiSpacerDef spacer()
    {
        return new UiSpacerDef();
    }

    public static UiGridSpanFromAboveDef spanFromAbove()
    {
        return UiGridSpanFromAboveDef.INSTANCE;
    }

    public static UiGridSpanFromLeftDef spanFromLeft()
    {
        return UiGridSpanFromLeftDef.INSTANCE;
    }

    public static UiSingleLayoutDef wrap( UiCompDef pCompDef )
    {
        return (pCompDef != null) ? new UiSingleLayoutDef( pCompDef ) : null;
    }

    public static UiTabDef tab( String pExtName, UiCompDef pCompDef )
    {
        UiTabDef rv = new UiTabDef( pExtName );
        if ( pCompDef != null )
        {
            if ( !(pCompDef instanceof UiContainerDef) )
            {
                pCompDef = new UiSingleLayoutDef( pCompDef );
            }
            rv.getChildrenHelper().addChild( pCompDef );
        }
        return rv;
    }

    public static UiViewDef view( String pAttributeName )
    {
        return new UiViewDef( pAttributeName );
    }

    public static UiRelSubFormDef relForm( String pAttributeName, UiCompDef pCompDef )
    {
        return new UiRelSubFormDef( pAttributeName, pCompDef );
    }

    public static UiFormDef form( String pRootType, UiCompDef pCompDef )
    {
        return new UiFormDef( pRootType, pCompDef );
    }
}