org.eclipse.swt.custom.CTabFolder2Adapter.java Source code

Introduction

Here is the source code for org.eclipse.swt.custom.CTabFolder2Adapter.java

Source

/*******************************************************************************
 * Copyright (c) 2000, 2017 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.swt.custom;

/**
 * This adapter class provides default implementations for the
 * methods described by the <code>CTabFolder2Listener</code> interface.
 * <p>
 * Classes that wish to deal with <code>CTabFolderEvent</code>s can
 * extend this class and override only the methods which they are
 * interested in.
 * </p>
 * <p>
 * An alternative to this class are the static helper methods in
 * {@link CTabFolder2Listener},
 * which accept a lambda expression or a method reference that implements the event consumer.
 * </p>
 *
 * @see CTabFolder2Listener
 * @see CTabFolderEvent
 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
 *
 * @since 3.0
 */
public class CTabFolder2Adapter implements CTabFolder2Listener {

    /**
     * Sent when the user clicks on the close button of an item in the CTabFolder.  The item being closed is specified
     * in the event.item field. Setting the event.doit field to false will stop  the CTabItem from closing.
     * When the CTabItem is closed, it is disposed.  The contents of the CTabItem (see CTabItem#setControl) will be
     * made not visible when the CTabItem is closed.
     * <p>
     * The default behaviour is to close the CTabItem.
     * </p>
     *
     * @param event an event indicating the item being closed
     */
    @Override
    public void close(CTabFolderEvent event) {
    }

    /**
     * Sent when the user clicks on the minimize button of a CTabFolder.
     * <p>
     * The default behaviour is to do nothing.
     * </p>
     *
     * @param event an event containing information about the minimize
     */
    @Override
    public void minimize(CTabFolderEvent event) {
    }

    /**
     * Sent when the user clicks on the maximize button of a CTabFolder.
     * <p>
     * The default behaviour is to do nothing.
     * </p>
     *
     * @param event an event containing information about the maximize
     */
    @Override
    public void maximize(CTabFolderEvent event) {
    }

    /**
     * Sent when the user clicks on the restore button of a CTabFolder.
     * <p>
     * The default behaviour is to do nothing.
     * </p>
     *
     * @param event an event containing information about the restore
     */
    @Override
    public void restore(CTabFolderEvent event) {
    }

    /**
     * Sent when the user clicks on the chevron button of a CTabFolder.
     * <p>
     * The default behaviour is to show a list of items that are not currently
     * visible and to change the selection based on the item selected from the list.
     * </p>
     *
     * @param event an event containing information about the show list
     */
    @Override
    public void showList(CTabFolderEvent event) {
    }
}