DialogControls.java

/*
Copyright 2008-2010 Gephi
Authors : Eduardo Ramos <eduramiba@gmail.com>
Website : http://www.gephi.org

This file is part of Gephi.

Gephi is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

Gephi 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with Gephi.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.gephi.datalab.spi;

/**
 * <p>An instance of this interface is passed to any type of manipulator UI, allowing the
 * UIs to enable/disable the dialog controls</p>
 * <p>For now allows to enable/disable the Ok button of the dialog</p>
 * @author Eduardo Ramos <eduramiba@gmail.com>
 */
public interface DialogControls {

    /**
     * Enable or disable the Ok button of the dialog for the UI.
     * @param enabled
     */
    void setOkButtonEnabled(boolean enabled);

    /**
     * Indicates if ok button is enabled for this dialog at the moment
     * @return <code>true</code> if ok button is enabled
     */
    boolean isOkButtonEnabled();
}