Package org.gephi.layout.spi
Interface LayoutUI
-
public interface LayoutUIVarious information about a layout algorithm that allows UI integration.- Author:
- Mathieu Bastian
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetDescription()The description of the layout algorithm purpose.IcongetIcon()The icon that represents the layout action.intgetQualityRank()An appraisal of quality for this algorithm.JPanelgetSimplePanel(Layout layout)ALayoutUIcan have a optional settings panel, that will be displayed instead of the property sheet.intgetSpeedRank()An appraisal of speed for this algorithm.
-
-
-
Method Detail
-
getDescription
String getDescription()
The description of the layout algorithm purpose.- Returns:
- a description snippet for the algorithm
-
getIcon
Icon getIcon()
The icon that represents the layout action.- Returns:
- a icon for this particular layout
-
getSimplePanel
JPanel getSimplePanel(Layout layout)
ALayoutUIcan have a optional settings panel, that will be displayed instead of the property sheet.- Parameters:
layout- the layout that require a simple panel- Returns:
- A simple settings panel for
layoutornull
-
getQualityRank
int getQualityRank()
An appraisal of quality for this algorithm. The rank must be between 1 and 5. The rank will be displayed tousers to help them to choose a suitable algorithm. Return -1 if you don't want to display a rank.- Returns:
- an integer between 1 and 5 or -1 if you don't want to show a rank
-
getSpeedRank
int getSpeedRank()
An appraisal of speed for this algorithm. The rank must be between 1 and 5. The rank will be displayed tousers to help them to choose a suitable algorithm. Return -1 if you don't want to display a rank.- Returns:
- an integer between 1 and 5 or -1 if you don't want to show a rank
-
-