package votorola.s.gwt.scene; // Copyright 2011, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.

import com.google.web.bindery.event.shared.*;
import votorola.g.web.gwt.*;


/** An event that signals a change in the filtering or bounding of the scene and other
  * scoping-dependent views, such as the feed.
  */
public final class ScopeChangeEvent extends com.google.gwt.event.shared.GwtEvent<ScopeChangeHandler>
{


    /** Registers a handler to receive change events fired from any scoping model.  You
      * must usually register a handler for {@linkplain Scenes#scene scene} changes as well,
      * because a scene change implies a scope change.  This wrinkle could be smoothed out
      * if necessary, but it currently poses no difficulty.
      *
      *     @see Scoping#addHandler(ScopeChangeHandler)
      */
    public static HandlerRegistration addHandler( final ScopeChangeHandler handler )
    {
        return GWTX.i().bus().addHandler( TYPE, handler );
    }



    /** The common type key for all scope change events.
      */
    public static final Type<ScopeChangeHandler> TYPE = new Type<ScopeChangeHandler>();



   // - G w t - E v e n t ----------------------------------------------------------------


    public @Override Type<ScopeChangeHandler> getAssociatedType() { return TYPE; }



    protected @Override void dispatch( final ScopeChangeHandler handler )
    {
        handler.onScopeChange( ScopeChangeEvent.this );
    }


}