Package org.gephi.io.importer.spi

Interface ImporterWizardUI

  • 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 an import wizard.

    To be recognized by the system, implementations must just add the following annotation: 

    @ServiceProvider(service=ImporterWizardUI.class)
    Author:
    Mathieu Bastian
    See Also:
    WizardImporter

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getCategory()
      There are two levels for wizard UIs, the category and then the display name.
      String getDescription()
      Returns the description for this importer
      String getDisplayName()
      Returns the importer display name
      org.openide.WizardDescriptor.Panel[] getPanels()
      Returns wizard panels.
      boolean isUIForImporter​(Importer importer)
      Returns true if this UI belongs to the given importer.
      void setup​(org.openide.WizardDescriptor.Panel panel)
      Configure panel with previously remembered settings.
      void unsetup​(WizardImporter importer, org.openide.WizardDescriptor.Panel panel)
      Notify UI the settings panel has been closed and that new values can be written.

    • Method Detail

      • getDisplayName

        String getDisplayName()
        Returns the importer display name
        Returns:
        the importer display name

      • getCategory

        String getCategory()
        There are two levels for wizard UIs, the category and then the display name. Returns the importer category.
        Returns:
        the importer category

      • getDescription

        String getDescription()
        Returns the description for this importer
        Returns:
        the description test

      • getPanels

        org.openide.WizardDescriptor.Panel[] getPanels()
        Returns wizard panels.
        Returns:
        panels of the current importer

      • setup

        void setup​(org.openide.WizardDescriptor.Panel panel)
        Configure panel with previously remembered settings. This method is called after getPanels() to push settings.
        Parameters:
        panel - the panel that settings are to be set

      • unsetup

        void unsetup​(WizardImporter importer,
             org.openide.WizardDescriptor.Panel panel)
        Notify UI the settings panel has been closed and that new values can be written. Settings can be read in panel and written importer.
        Parameters:
        importer - the importer that settings are to be written
        panel - the panel that settings are read

      • isUIForImporter

        boolean isUIForImporter​(Importer importer)
        Returns true if this UI belongs to the given importer.
        Parameters:
        importer - the importer that has to be tested
        Returns:
        true if the UI is matching with importer, false otherwise.