TabCloseEvent.java

/*
 * TabCloseEvent.java
 *
 * Copyright (C) 2009-12 by RStudio, Inc.
 *
 * Unless you have received this program directly from RStudio pursuant
 * to the terms of a commercial license agreement with RStudio, then
 * this program is licensed to you under the terms of version 3 of the
 * GNU Affero General Public License. This program is distributed WITHOUT
 * ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
 * AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.
 *
 */
package org.rstudio.core.client.events;

import com.google.gwt.event.shared.GwtEvent;

/**
 * Indicates that the specified tab is about to close. Happens after
 * TabClosingEvent but before TabClosedEvent.
 */
public class TabCloseEvent extends GwtEvent<TabCloseHandler>
{ 
   public static final GwtEvent.Type<TabCloseHandler> TYPE =
      new GwtEvent.Type<TabCloseHandler>();

   public TabCloseEvent(int tabIndex)
   {
      tabIndex_ = tabIndex;
   }

   public int getTabIndex()
   {
      return tabIndex_;
   }

   @Override
   protected void dispatch(TabCloseHandler handler)
   {
      handler.onTabClose(this);
   }

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

   private final int tabIndex_;
}