|
Gephi Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ImporterWizardUI
Define importer settings wizard user interface.
Declared in the system as services (i.e. singleton), the role of UI classes is to provide user interface to configure importers and remember last used settings if needed. This service is designed to provide the different panels part of a spigot import wizard.
To be recognized by the system, implementations must just add the following annotation:
@ServiceProvider(service=ImporterWizardUI.class)
SpigotImporter
Method Summary | |
---|---|
java.lang.String |
getCategory()
There are two levels for wizard UIs, the category and then the display name. |
java.lang.String |
getDescription()
Returns the description for this importer |
java.lang.String |
getDisplayName()
Returns the importer display name |
WizardDescriptor.Panel[] |
getPanels()
Returns wizard panels. |
boolean |
isUIForImporter(Importer importer)
Returns true if this UI belongs to the given importer. |
void |
setup(WizardDescriptor.Panel panel)
Configure panel with previously remembered settings. |
void |
unsetup(SpigotImporter importer,
WizardDescriptor.Panel panel)
Notify UI the settings panel has been closed and that new values can be written. |
Method Detail |
---|
java.lang.String getDisplayName()
java.lang.String getCategory()
java.lang.String getDescription()
WizardDescriptor.Panel[] getPanels()
void setup(WizardDescriptor.Panel panel)
panel
with previously remembered settings. This method
is called after getPanels()
to push settings.
panel
- the panel that settings are to be setvoid unsetup(SpigotImporter importer, WizardDescriptor.Panel panel)
panel
and written
importer
.
importer
- the importer that settings are to be writtenpanel
- the panel that settings are readboolean isUIForImporter(Importer importer)
true
if this UI belongs to the given importer.
importer
- the importer that has to be tested
true
if the UI is matching with importer
,
false
otherwise.
|
Gephi Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |