// This Source Code is in the Public Domain per: http://unlicense.org
package org.litesoft.GWT.forms.client.components;

import org.litesoft.GWT.client.*;
import org.litesoft.core.util.*;
import org.litesoft.logger.*;
import org.litesoft.ui.*;

public interface IFormComponent extends SizeManaged,
                                        Enableable
{
    public static final Logger LOGGER = LoggerFactory.getLogger( IFormComponent.class );

    public boolean isVisible();

    public boolean setFocus();

    /**
     * @return the current value of the FormComponent.
     *         The actual type will vary, e.g.: String, SimpleKeyValuePair, Boolean, CalendarYMD, ...
     */
    public Object getCurrentValue();

    /**
     * @param pNewValue the desired current value for the FormComponent.
     *                  The actual type MUST match the FormComponent's expected
     *                  type, e.g.: String, SimpleKeyValuePair, Boolean, CalendarYMD, ...
     */
    public void setCurrentValue( Object pNewValue );

    public boolean hasError();

    public void setError( String pError );

    public void setFocused( boolean pFocused );

    public void setValueChanged( boolean pChanged );

    public void publishAnyPendingChanges();

    /**
     * It is the responcibility of the IFormComponent to call the add() method on the passed in Listener!
     */
    public IFormComponent addFormComponentListener( Listener pFormComponentListener );

    /**
     * It is the responcibility of the IFormComponent to call the remove() method on the passed in Listener!
     */
    public IFormComponent removeFormComponentListener( Listener pFormComponentListener );

    public interface Listener
    {
        public void add( IFormComponent pComponent );

        public void remove( IFormComponent pComponent );

        public void changeOccurred();

        public void blurOccurred();

        public void focusOccured();

        public void enterPressed( KeyboardKeyModifier pModifiers );

        public interface Factory
        {
            Listener createListenerFor( String pName, IFormComponent pComponent );
        }
    }
}