Interface MagellanPlugIn

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.awt.Component> getDocks()
      Returns a list of dock elements or null, if the PlugIn has no docks.
      java.util.List<javax.swing.JMenuItem> getMenuItems()
      Returns the menu items that should be added to the Magellan PlugIn menu.
      java.lang.String getName()
      Returns the Name of the PlugIn.
      PreferencesFactory getPreferencesProvider()
      This method is used to find out, if the PlugIn has a preferences dialog that should be used inside the options window of Magellan.
      void init​(Client client, java.util.Properties properties)
      This method is called during client start up procedure.
      void init​(GameData data)
      This method is called every time the user has loaded a file into Magellan (open or add).
      void quit​(boolean storeSettings)
      This method is called whenever the application stops.
    • Method Detail

      • getName

        java.lang.String getName()
        Returns the Name of the PlugIn. This name will be presented to the user in the options panel.
      • init

        void init​(Client client,
                  java.util.Properties properties)
        This method is called during client start up procedure. You can use this method to initialize your PlugIn (load preferences and so on...)
        Parameters:
        client - the main application
        properties - the already loaded configuration
      • init

        void init​(GameData data)
        This method is called every time the user has loaded a file into Magellan (open or add). You should use this method to load report specific information.
        Parameters:
        data - the loaded and merged gamedata
      • getMenuItems

        java.util.List<javax.swing.JMenuItem> getMenuItems()
        Returns the menu items that should be added to the Magellan PlugIn menu. You can return multiple menu items for every kind of action that is available in your PlugIn.
      • quit

        void quit​(boolean storeSettings)
        This method is called whenever the application stops.
      • getPreferencesProvider

        PreferencesFactory getPreferencesProvider()
        This method is used to find out, if the PlugIn has a preferences dialog that should be used inside the options window of Magellan. If you don't want to build a preferences dialog return null.
      • getDocks

        java.util.Map<java.lang.String,​java.awt.Component> getDocks()
        Returns a list of dock elements or null, if the PlugIn has no docks.