001package org.gwtbootstrap3.extras.summernote.client.event;
002
003/*
004 * #%L
005 * GwtBootstrap3
006 * %%
007 * Copyright (C) 2015 GwtBootstrap3
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 * 
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 * 
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import com.google.gwt.event.shared.GwtEvent;
024
025/**
026 * The {@link SummernotePasteEvent} is fired when the paste action is performed
027 * within the summernote editor.
028 *
029 * @author Xiaodong Sun
030 */
031public class SummernotePasteEvent extends GwtEvent<SummernotePasteHandler> {
032
033    private static Type<SummernotePasteHandler> TYPE;
034
035    /**
036     * Fires a summernote paste event on all registered handlers in the handler
037     * manager. If no such handlers exist, this method will do nothing.
038     *
039     * @param source the source of the handlers
040     */
041    public static void fire(final HasSummernotePasteHandlers source) {
042        if (TYPE != null) {
043            SummernotePasteEvent event = new SummernotePasteEvent();
044            source.fireEvent(event);
045        }
046    }
047
048    /**
049     * Gets the type associated with this event.
050     *
051     * @return returns the handler type
052     */
053    public static Type<SummernotePasteHandler> getType() {
054        if (TYPE == null) {
055            TYPE = new Type<SummernotePasteHandler>();
056        }
057        return TYPE;
058    }
059
060    @Override
061    public Type<SummernotePasteHandler> getAssociatedType() {
062        return TYPE;
063    }
064
065    @Override
066    protected void dispatch(final SummernotePasteHandler handler) {
067        handler.onSummernotePaste(this);
068    }
069
070    /**
071     * Creates a summernote paste event.
072     */
073    protected SummernotePasteEvent() {}
074}