// This Source Code is Copyright & Licenced as indicated below
package org.litesoft.GWT.client.widgets.nonpublic.external;
/*
 * Copyright 2006 Mat Gessel <mat.gessel@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

import com.google.gwt.user.client.*;
import com.google.gwt.user.client.ui.*;

import java.util.*;

/**
 * Wraps an widget to provide event processing via
 * {@link asquare.gwt.tk.client.ui.behavior.Controller controllers}. The
 * wrapped widget will process events and notify listeners as if it was not
 * wrapped.
 */
public class CWrapper extends EventWrapper implements ControllerSupport {
    private final ControllerSupportDelegate m_controllerSupport;

    /**
     * Creates a CWrapper around the specified widget.
     */
    public CWrapper( Widget widget ) {
        this( widget, null );
    }

    /**
     * Creates a CWrapper around the specified widget. Pass a
     * value for <code>controllers</code> if you wish to avoid controller
     * creation via {@link #createControllers()}. Otherwise pass null.
     *
     * @param controllers a list of 0 or more controllers, or <code>null</code>
     *
     * @throws IllegalArgumentException if <code>element</code> is null
     */
    public CWrapper( Widget widget, List controllers ) {
        initWidget( widget );
        m_controllerSupport = new ControllerSupportDelegate( this );

        if ( controllers == null ) {
            controllers = createControllers();
        }

        setControllers( controllers );
    }

    /**
     * A factory method which gives subclasses the opportunity to override
     * default controller creation.
     *
     * @return a List with 0 or more controllers, or <code>null</code>
     */
    protected List createControllers() {
        return null;
    }

    /*
      *  (non-Javadoc)
      * @see asquare.gwt.tk.client.ui.behavior.ControllerSupport#getController(java.lang.Class)
      */
    @Override
    public Controller getController( Class id ) {
        return m_controllerSupport.getController( id );
    }

    /*
      *  (non-Javadoc)
      * @see asquare.gwt.tk.client.ui.behavior.ControllerSupport#addController(asquare.gwt.tk.client.ui.behavior.Controller)
      */
    @Override
    public Widget addController( Controller controller ) {
        return m_controllerSupport.addController( controller );
    }

    /*
      *  (non-Javadoc)
      * @see asquare.gwt.tk.client.ui.behavior.ControllerSupport#removeController(asquare.gwt.tk.client.ui.behavior.Controller)
      */
    @Override
    public Widget removeController( Controller controller ) {
        return m_controllerSupport.removeController( controller );
    }

    /*
      *  (non-Javadoc)
      * @see asquare.gwt.tk.client.ui.behavior.ControllerSupport#setControllers(java.util.List)
      */
    @Override
    public void setControllers( List controllers ) {
        m_controllerSupport.setControllers( controllers );
    }

    /*
      *  (non-Javadoc)
      * @see com.google.gwt.user.client.ui.UIObject#sinkEvents(int)
      */
    @Override
    public void sinkEvents( int eventBits ) {
        m_controllerSupport.sinkEvents( eventBits );
    }

    /*
      *  (non-Javadoc)
      * @see com.google.gwt.user.client.ui.UIObject#unsinkEvents(int)
      */
    @Override
    public void unsinkEvents( int eventBits ) {
        m_controllerSupport.unsinkEvents( eventBits );
    }

    /*
      *  (non-Javadoc)
      * @see com.google.gwt.user.client.ui.Widget#onAttach()
      */
    @Override
    protected void onAttach() {
        if ( isAttached() ) {
            return;
        }
        m_controllerSupport.onAttach();
        super.onAttach();
    }

    /*
      *  (non-Javadoc)
      * @see com.google.gwt.user.client.ui.Widget#onDetach()
      */
    @Override
    protected void onDetach() {
        if ( !isAttached() ) {
            return;
        }

        try {
            super.onDetach();
        }
        finally {
            m_controllerSupport.onDetach();
        }
    }

    /*
      *  (non-Javadoc)
      * @see com.google.gwt.user.client.EventListener#onBrowserEvent(com.google.gwt.user.client.Event)
      */
    @Override
    public void onBrowserEvent( Event event ) {
        if ( (m_controllerSupport.getLegacyEventBits() & DOM.eventGetType( event )) != 0 ) {
            super.onBrowserEvent( event );
        }
        m_controllerSupport.onBrowserEvent( event );
    }
}