package com.temp.foundation.client.widget.input.support;

import org.litesoft.externalization.shared.*;

import com.google.gwt.user.client.ui.*;
import com.temp.foundation.client.widget.*;

/**
 * An interface to a class that can be added to the FormEngine as part of the Focusable list.
 * <p/>
 * It operates in two distinct states:
 * <p/>
 * <li>Builder Mode - Where properties are specified (and certain methods are NOT accessable)</li>
 * <li>Run Mode - Where everything is accessable (and the specification properties are NOT changeable)</li>
 * <p/>
 * The transition between the states is one way ('Builder' to 'Run') and is a result of the call to 'init'.
 */
public interface FormEngineMember extends HasEnabled {
    /**
     * The 'Builder' to 'Run' state transition method fully "Builds" 'this'.
     * <p/>
     * Only callable ONCE and only in Builder Mode!
     *
     * @param parentResolver
     */
    void init( E13nResolver parentResolver );

    // Callable anytime:

    boolean isRunMode();

    // Only callable in Run Mode:

    /**
     * Reset the value(s) to a <code>null</code> state.
     */
    void reset();

    /**
     * revert to the "Base" value(s)
     */
    void revert();

    /**
     * Return if the Current Value(s) are different than the Base Value(s)
     */
    boolean isChanged();

    /**
     * Return if 'this' has Focus (or null indicating that the Focus state is not tracked)
     */
    Boolean isFocused();

    /**
     * Return if the Current Value(s) are rejected by any of the ValueValidator(s)
     */
    boolean isErrored();

    /**
     * Validate the Current Value(s), and "manage" the Error Label(s) appropriately.
     *
     * @return true if <code>isErrored() == false</code>.
     */
    boolean validate();

    /**
     * Pull the Focus to 'this' (return false if 'this' is "thought" to be currently un-focusable, e.g. Disabled, or has no Focusable components)
     */
    boolean setFocused();

    E13nResolver getE13nResolver();

    NameToID addNamedWidgetsTo( NameToID nameToID );
}