// Copyright 2012 Google Inc. All Rights Reserved.
//
// 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.google.collide.client.code;

import com.google.collide.client.workspace.WorkspacePlace;
import com.google.gwt.event.shared.EventHandler;
import com.google.gwt.event.shared.GwtEvent;

/**
 * Simple event that is fired within a {@link WorkspacePlace} that changes the
 * expansion state of the Navigation area on the workspace.
 *
 */
public class NavigationAreaExpansionEvent extends GwtEvent<NavigationAreaExpansionEvent.Handler> {

  /**
   * Handler interface for getting notified when the NavigationArea is expanded
   * or collapsed.
   */
  public interface Handler extends EventHandler {
    void onNavAreaExpansion(NavigationAreaExpansionEvent evt);
  }

  public static final Type<Handler> TYPE = new Type<Handler>();

  private final boolean shouldExpand;

  public NavigationAreaExpansionEvent(boolean isExpanded) {
    this.shouldExpand = isExpanded;
  }

  @Override
  public GwtEvent.Type<Handler> getAssociatedType() {
    return TYPE;
  }

  public boolean shouldExpand() {
    return shouldExpand;
  }

  @Override
  protected void dispatch(Handler handler) {
    handler.onNavAreaExpansion(this);
  }
}
