/*
 * Copyright 2008 Google Inc.
 * 
 * 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.
 */
package com.google.gwt.gen2.event.shared;

import com.google.gwt.gen2.event.shared.AbstractEvent.*;

/**
 * HandlerRegistration instances are returned by
 * HandlerManager.addEventHandler() and used to remove event handler
 * registrations.
 *
 * @deprecated use the com.google.gwt.event.shared classes instead
 */
@Deprecated
public class HandlerRegistration {

    private HandlerManager manager;
    private EventHandler handler;
    private Type type;

    /**
     * Creates a new handler registration.
     *
     * @param manager the handler manager
     * @param type    the event type
     * @param handler the handler
     */
    protected HandlerRegistration( HandlerManager manager, Type type, EventHandler handler ) {
        this.manager = manager;
        this.handler = handler;
        this.type = type;
    }

    /**
     * Removes the given handler from its manager.
     */
    public void removeHandler() {
        manager.removeHandler( type, handler );
    }
}