bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/custom/CTabFolderListener.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2016 IBM Corporation and others.
   3  *
   4  * This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License 2.0
   6  * which accompanies this distribution, and is available at
   7  * https://www.eclipse.org/legal/epl-2.0/
   8  *
   9  * SPDX-License-Identifier: EPL-2.0
  10  *
  11  * Contributors:
  12  *     IBM Corporation - initial API and implementation
  13  *******************************************************************************/
  14 package org.eclipse.swt.custom;
  15
  16 import org.eclipse.swt.internal.*;
  17
  18 /**
  19  * Classes which implement this interface provide a method
  20  * that deals with events generated in the CTabFolder.
  21  * <p>
  22  * After creating an instance of a class that implements
  23  * this interface it can be added to a CTabFolder using the
  24  * <code>addCTabFolderListener</code> method and removed using
  25  * the <code>removeCTabFolderListener</code> method. When a
  26  * tab item is closed, the itemClosed method will be invoked.
  27  * </p>
  28  *
  29  * @see CTabFolderEvent
  30  */
  31 @FunctionalInterface
  32 public interface CTabFolderListener extends SWTEventListener {
  33
  34 /**
  35  * Sent when the user clicks on the close button of an item in the CTabFolder.  The item being closed is specified
  36  * in the event.item field. Setting the event.doit field to false will stop the CTabItem from closing.
  37  * When the CTabItem is closed, it is disposed.  The contents of the CTabItem (see CTabItem.setControl) will be
  38  * made not visible when the CTabItem is closed.
  39  *
  40  * @param event an event indicating the item being closed
  41  *
  42  * @see CTabItem#setControl
  43  */
  44 public void itemClosed(CTabFolderEvent event);
  45 }