DropEvent.java

/*
 * Copyright 2010 The gwtquery plugins team.
 * 
 * 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 gwtquery.plugins.droppable.client.events;

import com.google.gwt.dom.client.Element;
import com.google.gwt.event.shared.EventHandler;
import gwtquery.plugins.draggable.client.events.DragContext;

/**
 * Event fired when an acceptable draggable is dropped on a droppable.
 *
 * @author Julien Dramaix (julien.dramaix@gmail.com)
 */
public class DropEvent extends AbstractDroppableEvent<DropEvent.DropEventHandler> {
    public interface DropEventHandler extends EventHandler {
        public void onDrop(DropEvent event);
    }

    public static Type<DropEventHandler> TYPE = new Type<DropEventHandler>();

    public DropEvent(DragAndDropContext ctx) {
        super(ctx);
    }

    public DropEvent(Element droppable, DragContext dragCtx) {
        super(droppable, dragCtx);
    }

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

    @Override
    protected void dispatch(DropEventHandler handler) {
        handler.onDrop(this);
    }
}