org.datacleaner.widgets.tabs.TabCloseEvent Maven / Gradle / Ivy

Go to download
/**
 * DataCleaner (community edition)
 * Copyright (C) 2014 Free Software Foundation, Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.datacleaner.widgets.tabs;

import java.awt.Component;
import java.util.EventObject;

import javax.swing.JTabbedPane;

/**
 * This is a slightly rewritten/modified version of swingutil's
 * ClosableTabbedPane
 */
public final class TabCloseEvent extends EventObject {

    private static final long serialVersionUID = -8865377836780462308L;

    /**
     * The index of the closing tab
     */
    private final int _tabIndex;

    /**
     * The contents of the closed tab
     */
    private final Component _tabContents;

    /**
     * Construct an event for the indicated tab number associated with the
     * indicated JTabbedPane
     */
    public TabCloseEvent(final JTabbedPane pane, final int tabIndex, final Component tabContents) {
        super(pane);
        _tabIndex = tabIndex;
        _tabContents = tabContents;
    }

    /**
     * Get the closed tab index
     *
     * @return the tab that is closed
     */
    public int getTabIndex() {
        return _tabIndex;
    }

    public Component getTabContents() {
        return _tabContents;
    }

    @Override
    public boolean equals(final Object obj) {
        if (obj instanceof TabCloseEvent) {
            final TabCloseEvent that = (TabCloseEvent) obj;
            return this._tabIndex == that._tabIndex;
        }
        return false;
    }

    @Override
    public int hashCode() {
        return _tabIndex;
    }

    @Override
    public String toString() {
        return "TabCloseEvent[tabIndex=" + _tabIndex + "]";
    }
}