Package org.gephi.io.exporter.spi
Interface ExporterUI
-
public interface ExporterUIDefine exporter settings user interface.- Author:
- Mathieu Bastian
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetDisplayName()Returns the exporter display nameJPanelgetPanel()Returns the exporter settings panel.booleanisUIForExporter(Exporter exporter)Returnstrueif this UI belongs to the given exporter.voidsetup(Exporter exporter)Link the UI to the exporter and therefore to settings values.voidunsetup(boolean update)Notify UI the settings panel has been closed and that new values can be written.
-
-
-
Method Detail
-
getPanel
JPanel getPanel()
Returns the exporter settings panel.- Returns:
- a settings panel, or
null
-
setup
void setup(Exporter exporter)
Link the UI to the exporter and therefore to settings values. This method is called aftergetPanel()to push settings.- Parameters:
exporter- the exporter that settings is to be set
-
unsetup
void unsetup(boolean update)
Notify UI the settings panel has been closed and that new values can be written.- Parameters:
update-trueif user clicked OK orfalseif CANCEL.
-
isUIForExporter
boolean isUIForExporter(Exporter exporter)
Returnstrueif this UI belongs to the given exporter.- Parameters:
exporter- the exporter that has to be tested- Returns:
trueif the UI is matching withexporter,falseotherwise.
-
getDisplayName
String getDisplayName()
Returns the exporter display name- Returns:
- the exporter display name
-
-