org.gwtbootstrap3.extras.summernote.client.event.SummernotePasteEvent Maven / Gradle / Ivy

package org.gwtbootstrap3.extras.summernote.client.event;

/*
 * #%L
 * GwtBootstrap3
 * %%
 * Copyright (C) 2015 GwtBootstrap3
 * %%
 * 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.
 * #L%
 */

import com.google.gwt.event.shared.GwtEvent;

/**
 * The {@link SummernotePasteEvent} is fired when the paste action is performed
 * within the summernote editor.
 *
 * @author Xiaodong Sun
 */
public class SummernotePasteEvent extends GwtEvent {

    private static Type TYPE;

    /**
     * Fires a summernote paste event on all registered handlers in the handler
     * manager. If no such handlers exist, this method will do nothing.
     *
     * @param source the source of the handlers
     */
    public static void fire(final HasSummernotePasteHandlers source) {
        if (TYPE != null) {
            SummernotePasteEvent event = new SummernotePasteEvent();
            source.fireEvent(event);
        }
    }

    /**
     * Gets the type associated with this event.
     *
     * @return returns the handler type
     */
    public static Type getType() {
        if (TYPE == null) {
            TYPE = new Type();
        }
        return TYPE;
    }

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

    @Override
    protected void dispatch(final SummernotePasteHandler handler) {
        handler.onSummernotePaste(this);
    }

    /**
     * Creates a summernote paste event.
     */
    protected SummernotePasteEvent() {}
}