Package de.griefed.serverpackcreator.api.plugins.swinggui

Interface TabExtension

  • All Implemented Interfaces:
    de.griefed.serverpackcreator.api.plugins.BaseInformation , de.griefed.serverpackcreator.api.plugins.ExtensionInformation , org.pf4j.ExtensionPoint 
    
public interface TabExtension
 implements ExtensionInformation

    Extension point for plugins which add additional javax.swing.JPanels as additional tabs to the ServerPackCreator GUI.

    Author:

    Griefed

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract ExtensionTab getTab(VersionMeta versionMeta, ApiProperties apiProperties, Utilities utilities, Optional<CommentedConfig> pluginConfig, Optional<File> configFile) Builds the tab this plugin contributes to the GUI, once, when the main window is assembled.
      abstract Icon getIcon() Get the Icon for this tab to display to the ServerPackCreator GUI.
      abstract String getTitle() Get the title of this tab to display in the ServerPackCreator GUI.
      abstract String getTooltip() Get the tooltip for this tab to display in the ServerPackCreator GUI.

      • Methods inherited from class de.griefed.serverpackcreator.api.plugins.ExtensionInformation

        getExtensionId

      • Methods inherited from class de.griefed.serverpackcreator.api.plugins.BaseInformation

        getAuthor, getDescription, getName, getVersion

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • getTab

         abstract ExtensionTab getTab(VersionMeta versionMeta, ApiProperties apiProperties, Utilities utilities, Optional<CommentedConfig> pluginConfig, Optional<File> configFile)

        Builds the tab this plugin contributes to the GUI, once, when the main window is assembled.

        Called by ApiPlugins.addTabExtensionTabs at GUI startup — not per generation — so the returned ExtensionTab is long-lived and owns its own state. A throw here is caught and logged against the plugin rather than propagated, so a failing tab costs its own tab and not the window. icon and title name it in the tab bar.

        Parameters:
        versionMeta - Instance of VersionMeta so you can work with available Minecraft, Forge, Fabric, LegacyFabric and Quilt versions.
        apiProperties - Instance of ApiProperties The current configuration of ServerPackCreator, like the default list of clientside-only mods, the server pack directory etc.
        utilities - Instance of Utilities commonly used across ServerPackCreator.
        pluginConfig - Plugin specific configuration conveniently provided by ServerPackCreator.
        configFile - The config-file corresponding to the ID of the plugin, wrapped in an Optional.
        Returns:

        Component to add to the ServerPackCreator GUI as a tab.

      • getIcon

         abstract Icon getIcon()

        Get the Icon for this tab to display to the ServerPackCreator GUI.

        Returns:

        Icon to be used by the added tab.

      • getTitle

         abstract String getTitle()

        Get the title of this tab to display in the ServerPackCreator GUI.

        Returns:

        The title of this plugin's tabbed pane.

      • getTooltip

         abstract String getTooltip()

        Get the tooltip for this tab to display in the ServerPackCreator GUI.

        Returns:

        The tooltip of this plugin's tabbed pane.