org.gephi.perspective.spi.Perspective Maven / Gradle / Ivy
/*
Copyright 2008-2010 Gephi
Authors : Mathieu Bastian
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.perspective.spi;
import javax.swing.Icon;
/**
* Define a group of components which are showed in the banner. Overview, Data
* Laboratory and Preview are perspectives.
* Create a new Perspective
* - Create a new module and set
Perspective API,
* and Lookup API as dependencies.
* - Create a new implementation of perspective and fill methods.
* - Add
@ServiceProvider annotation to your class to be found by
* the system, like @ServiceProvider(service = Perspective.class, position = 500).
* - Set the position to define the order of appearance, Overview is 100, Preview is 300.
*
* @author Mathieu Bastian
*/
public interface Perspective {
/**
* Return the name to display in the user interface.
* @return the perspective display name
*/
public String getDisplayName();
/**
* Return a unique identifier for this perspective.
* @return the name of the perspective
*/
public String getName();
/**
* Return the icon of the perspective.
* @return the perspective's icon, or null
*/
public Icon getIcon();
}