com.github.gwtbootstrap.client.ui.event.ShownEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gwt-bootstrap Show documentation

A GWT Library that provides the widgets of Twitter Bootstrap.

The newest version!

/*
 *  Copyright 2012 GWT-Bootstrap
 *
 *  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.github.gwtbootstrap.client.ui.event;

import com.google.gwt.dom.client.NativeEvent;
import com.google.gwt.event.shared.GwtEvent;

/**
 * Represents an event that is fired immediately when a widget's
 * show() method is called.
 *
 * @author Dominik Mayer
 * @author Danilo Reinert
 *
 * @see ShownEvent
 * @see HideEvent
 * @see HiddenEvent
 *
 * @since 2.0.4.0
 */
public class ShownEvent extends GwtEvent {

    private static final Type TYPE = new Type();
    private final NativeEvent nativeEvent;
    private final boolean autoShown;

    public static Type getType() {
        return TYPE;
    }

    public ShownEvent() {
        this(null);
    }

    public ShownEvent(NativeEvent nativeEvent) {
        this(nativeEvent, false);
    }

    public ShownEvent(boolean autoShown) {
        this(null, autoShown);
    }

    public ShownEvent(NativeEvent nativeEvent, boolean autoShown) {
        this.nativeEvent = nativeEvent;
        this.autoShown = autoShown;
    }

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

    @Override
    protected void dispatch(ShownHandler handler) {
        handler.onShown(this);
    }

    /**
     * Prevents the browser from taking its default action for the given event.
     */
    public final void preventDefault() {

        if (nativeEvent == null) return;

        nativeEvent.preventDefault();
    }

    /**
     * Stops the event from being propagated to parent elements.
     */
    public final void stopPropagation() {

        if (nativeEvent == null) return;

        nativeEvent.stopPropagation();
    }

    public boolean isAutoShown() {
        return autoShown;
    }
}