LayoutController.java

/*
Copyright 2008-2010 Gephi
Authors : Mathieu Bastian <mathieu.bastian@gephi.org>
Website : http://www.gephi.org

This file is part of Gephi.

DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

Copyright 2011 Gephi Consortium. All rights reserved.

The contents of this file are subject to the terms of either the GNU
General Public License Version 3 only ("GPL") or the Common
Development and Distribution License("CDDL") (collectively, the
"License"). You may not use this file except in compliance with the
License. You can obtain a copy of the License at
http://gephi.org/about/legal/license-notice/
or /cddl-1.0.txt and /gpl-3.0.txt. See the License for the
specific language governing permissions and limitations under the
License.  When distributing the software, include this License Header
Notice in each file and include the License files at
/cddl-1.0.txt and /gpl-3.0.txt. If applicable, add the following below the
License Header, with the fields enclosed by brackets [] replaced by
your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

If you wish your version of this file to be governed by only the CDDL
or only the GPL Version 3, indicate your decision by adding
"[Contributor] elects to include this software in this distribution
under the [CDDL or GPL Version 3] license." If you do not indicate a
single choice of license, a recipient has the option to distribute
your version of this file under either the CDDL, the GPL Version 3 or
to extend the choice of license to its licensees as provided above.
However, if you add GPL Version 3 code and therefore, elected the GPL
Version 3 license, then the option applies only if the new code is
made subject to such option by the copyright holder.

Contributor(s):

Portions Copyrighted 2011 Gephi Consortium.
 */
package org.gephi.layout.api;

import org.gephi.layout.spi.Layout;
import org.gephi.project.api.Workspace;

/**
 * A LayoutController is the one responsible for controlling the states of
 * the {@link LayoutModel}. It always controls the current workspace model.
 * <p>
 * This controller is a singleton and can therefore be found in Lookup:
 * <pre>LayoutController lc = Lookup.getDefault().lookup(LayoutController.class);</pre>
 * @author Mathieu Bastian
 */
public interface LayoutController {

    /**
     * Returns the model of the currently selected {@link Workspace}.
     */
    public LayoutModel getModel();

    /**
     * Sets the Layout to execute.
     * @param layout the layout that is to be selected
     */
    public void setLayout(Layout layout);

    /**
     * Executes the current Layout.
     */
    public void executeLayout();

    /**
     * Executes the current layout for <code>numIterations</code> iterations.
     * @param numIterations the number of iterations of the algorithm
     */
    public void executeLayout(int numIterations);

    /**
     * Determine if the current Layout can be executed.
     * @return <code>true</code> if the layout is executable.
     */
    public boolean canExecute();

    /**
     * Stop the Layout's execution.
     */
    public void stopLayout();

    /**
     * Determine if the current Layout execution can be stopped.
     * If the current Layout is not running, it generally cannot be stopped.
     * @return <code>true</code> if the layout can be stopped.
     */
    public boolean canStop();
}