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 SummernoteEnterEvent} is fired when the ENTER key is pressed.
027 *
028 * @author Xiaodong Sun
029 */
030public class SummernoteEnterEvent extends GwtEvent<SummernoteEnterHandler> {
031
032    private static Type<SummernoteEnterHandler> TYPE;
033
034    /**
035     * Fires a summernote enter event on all registered handlers in the handler
036     * manager. If no such handlers exist, this method will do nothing.
037     *
038     * @param source the source of the handlers
039     */
040    public static void fire(final HasSummernoteEnterHandlers source) {
041        if (TYPE != null) {
042            SummernoteEnterEvent event = new SummernoteEnterEvent();
043            source.fireEvent(event);
044        }
045    }
046
047    /**
048     * Gets the type associated with this event.
049     *
050     * @return returns the handler type
051     */
052    public static Type<SummernoteEnterHandler> getType() {
053        if (TYPE == null) {
054            TYPE = new Type<SummernoteEnterHandler>();
055        }
056        return TYPE;
057    }
058
059    @Override
060    public Type<SummernoteEnterHandler> getAssociatedType() {
061        return TYPE;
062    }
063
064    @Override
065    protected void dispatch(final SummernoteEnterHandler handler) {
066        handler.onSummernoteEnter(this);
067    }
068
069    /**
070     * Creates a summernote enter event.
071     */
072    protected SummernoteEnterEvent() {}
073}