Package ca.phon.plugin

Interface IPluginEntryPoint

All Known Implementing Classes:
AboutEP, AbstractPluginEntryPoint, AnalysisComposerEP, CopyEP, CutEP, ExitEP, ExportEntryPt, ImportEntryPt, IPAMapEP, LanguageCodeEP, LogViewerEP, OpenFileEP, OpenProjectEP, OpgraphEditorEP, PasteEP, PhonexDebuggerEP, PreferencesEP, ProjectArchiveEP, QueryAndReportWizardEP, ReportComposerEP, ResultSetEP, SessionCheckEP, SessionEditorEP, SessionTemplateEP, WelcomeWindowEP
public interface IPluginEntryPoint
Entry point for a plugin

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Plugin action ID.
    void
    pluginStart(Map<String,Object> args)
    Entry point method for a plugin.

  • Method Details

    • getName

      String getName()
      Plugin action ID. This is used by Phon to call the entry point using a string name.

    • pluginStart

      void pluginStart(Map<String,Object> args)
      Entry point method for a plugin.
      Parameters:
      args - a hash table of arguments given to the plugin. By default, Phon will provide the plugin with the following arguments: project:IPhonProject - the project. null if N/A. corpus:String - the corpus id of the open session. null if N/A session:String - the session id of the open session. null if N/A More arguments can be defined statically in the module definition xml files.