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

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2017 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 /**
  17  * This adapter class provides default implementations for the
  18  * methods described by the <code>CTabFolder2Listener</code> interface.
  19  * <p>
  20  * Classes that wish to deal with <code>CTabFolderEvent</code>s can
  21  * extend this class and override only the methods which they are
  22  * interested in.
  23  * </p>
  24  * <p>
  25  * An alternative to this class are the static helper methods in
  26  * {@link CTabFolder2Listener},
  27  * which accept a lambda expression or a method reference that implements the event consumer.
  28  * </p>
  29  *
  30  * @see CTabFolder2Listener
  31  * @see CTabFolderEvent
  32  * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
  33  *
  34  * @since 3.0
  35  */
  36 public class CTabFolder2Adapter implements CTabFolder2Listener {
  37
  38 /**
  39  * Sent when the user clicks on the close button of an item in the CTabFolder.  The item being closed is specified
  40  * in the event.item field. Setting the event.doit field to false will stop  the CTabItem from closing.
  41  * When the CTabItem is closed, it is disposed.  The contents of the CTabItem (see CTabItem#setControl) will be
  42  * made not visible when the CTabItem is closed.
  43  * <p>
  44  * The default behaviour is to close the CTabItem.
  45  * </p>
  46  *
  47  * @param event an event indicating the item being closed
  48  */
  49 @Override
  50 public void close(CTabFolderEvent event){}
  51
  52 /**
  53  * Sent when the user clicks on the minimize button of a CTabFolder.
  54  * <p>
  55  * The default behaviour is to do nothing.
  56  * </p>
  57  *
  58  * @param event an event containing information about the minimize
  59  */
  60 @Override
  61 public void minimize(CTabFolderEvent event){}
  62
  63 /**
  64  * Sent when the user clicks on the maximize button of a CTabFolder.
  65  * <p>
  66  * The default behaviour is to do nothing.
  67  * </p>
  68  *
  69  * @param event an event containing information about the maximize
  70  */
  71 @Override
  72 public void maximize(CTabFolderEvent event){}
  73
  74 /**
  75  * Sent when the user clicks on the restore button of a CTabFolder.
  76  * <p>
  77  * The default behaviour is to do nothing.
  78  * </p>
  79  *
  80  * @param event an event containing information about the restore
  81  */
  82 @Override
  83 public void restore(CTabFolderEvent event){}
  84
  85 /**
  86  * Sent when the user clicks on the chevron button of a CTabFolder.
  87  * <p>
  88  * The default behaviour is to show a list of items that are not currently
  89  * visible and to change the selection based on the item selected from the list.
  90  * </p>
  91  *
  92  * @param event an event containing information about the show list
  93  */
  94 @Override
  95 public void showList(CTabFolderEvent event){}
  96 }