com.alee.extended.tab.DocumentPaneEventMethods Maven / Gradle / Ivy

Go to download
/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * WebLookAndFeel library 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with WebLookAndFeel library.  If not, see .
 */

package com.alee.extended.tab;

import com.alee.utils.swing.extensions.MethodExtension;

/**
 * {@link MethodExtension} for {@link DocumentListener} available in {@link WebDocumentPane}.
 *
 * @param  {@link DocumentData} type
 * @author Mikle Garin
 * @see How to use WebDocumentPane
 * @see MethodExtension
 * @see DocumentPaneEventMethodsImpl
 * @see WebDocumentPane
 */
public interface DocumentPaneEventMethods extends MethodExtension
{
    /**
     * Shortcut method for {@link DocumentListener#opened(DocumentData, PaneData, int)} event.
     *
     * @param runnable {@link DocumentDataRunnable}
     * @return created {@link DocumentListener}
     */
    public DocumentListener onDocumentOpen ( DocumentDataRunnable runnable );

    /**
     * Shortcut method for {@link DocumentListener#selected(DocumentData, PaneData, int)} event.
     *
     * @param runnable {@link DocumentDataRunnable}
     * @return created {@link DocumentListener}
     */
    public DocumentListener onDocumentSelection ( DocumentDataRunnable runnable );

    /**
     * Shortcut method for {@link DocumentListener#closing(DocumentData, PaneData, int)} event.
     *
     * @param runnable {@link DocumentDataCancellableRunnable}
     * @return created {@link DocumentListener}
     */
    public DocumentListener onDocumentClosing ( DocumentDataCancellableRunnable runnable );

    /**
     * Shortcut method for {@link DocumentListener#closed(DocumentData, PaneData, int)} event.
     *
     * @param runnable {@link DocumentDataRunnable}
     * @return created {@link DocumentListener}
     */
    public DocumentListener onDocumentClose ( DocumentDataRunnable runnable );
}