/*
 *  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 when a widget is completely hidden.
 *
 * @author Dominik Mayer
 * @author Danilo Reinert
 *
 * @see HideEvent
 * @see ShowEvent
 * @see ShownEvent
 *
 * @since 2.0.4.0
 */
public class HiddenEvent extends GwtEvent<HiddenHandler> {

    private static final Type<HiddenHandler> TYPE = new Type<HiddenHandler>();
    private final NativeEvent nativeEvent;
    private final boolean autoHidden;
    
    public HiddenEvent() {
        this(null, false);
    }

    public HiddenEvent(boolean autoHidden) {
        this(null, autoHidden);
    }

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

    public HiddenEvent(NativeEvent nativeEvent, boolean autoHidden) {
        this.nativeEvent = nativeEvent;
        this.autoHidden = autoHidden;
    }

    public static Type<HiddenHandler> getType() {
        return TYPE;
    }

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

    @Override
    protected void dispatch(HiddenHandler handler) {
        handler.onHidden(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 isAutoHidden() {
        return autoHidden;
    }
}