Package org.gephi.io.exporter.spi
Interface ExporterUI
-
public interface ExporterUI
Define exporter settings user interface.- Author:
- Mathieu Bastian
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getDisplayName()
Returns the exporter display nameJPanel
getPanel()
Returns the exporter settings panel.boolean
isUIForExporter(Exporter exporter)
Returnstrue
if this UI belongs to the given exporter.void
setup(Exporter exporter)
Link the UI to the exporter and therefore to settings values.void
unsetup(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
-true
if user clicked OK orfalse
if CANCEL.
-
isUIForExporter
boolean isUIForExporter(Exporter exporter)
Returnstrue
if this UI belongs to the given exporter.- Parameters:
exporter
- the exporter that has to be tested- Returns:
true
if the UI is matching withexporter
,false
otherwise.
-
getDisplayName
String getDisplayName()
Returns the exporter display name- Returns:
- the exporter display name
-
-