com.alee.extended.window.PopupMethods 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.window;

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

/**
 * This interface provides a set of methods that should be added into components that support custom popup methods.
 *
 * @author Mikle Garin
 * @see com.alee.utils.swing.extensions.MethodExtension
 * @see com.alee.extended.window.PopupMethodsImpl
 */
public interface PopupMethods extends MethodExtension
{
    /**
     * Shortcut method for on-before-open popup event.
     *
     * @param action action to perform
     * @return used popup listener
     */
    public PopupListener beforePopupOpen ( Runnable action );

    /**
     * Shortcut method for on-open popup event.
     *
     * @param action action to perform
     * @return used popup listener
     */
    public PopupListener onPopupOpen ( Runnable action );

    /**
     * Shortcut method for on-before-close popup event.
     *
     * @param action action to perform
     * @return used popup listener
     */
    public PopupListener beforePopupClose ( Runnable action );

    /**
     * Shortcut method for on-close popup event.
     *
     * @param action action to perform
     * @return used popup listener
     */
    public PopupListener onPopupClose ( Runnable action );
}