Class PluginListPanel

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
net.runelite.client.ui.PluginPanel
net.storm.api.plugins.config.PluginListPanel
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, net.runelite.client.ui.Activatable

public abstract class PluginListPanel extends net.runelite.client.ui.PluginPanel
Abstract base class for the plugin list panel in the sidebar.

PluginListPanel displays the list of available plugins and provides functionality for managing plugins (start/stop) and opening their configuration panels.

This class extends PluginPanel and integrates with the MultiplexingPluginPanel for panel navigation.

See Also:
  • Constructor Details

    • PluginListPanel

      public PluginListPanel()
      Creates a new plugin list panel with wrapping disabled.
  • Method Details

    • openConfigurationPanel

      public abstract void openConfigurationPanel(PluginConfigurationDescriptor pluginConfig)
      Opens the configuration panel for the specified plugin configuration.
      Parameters:
      pluginConfig - the plugin configuration descriptor
    • openConfigurationPanel

      public abstract void openConfigurationPanel(String configGroup)
      Opens the configuration panel for the plugin with the specified config group.
      Parameters:
      configGroup - the configuration group name
    • openConfigurationPanel

      public abstract void openConfigurationPanel(Plugin plugin)
      Opens the configuration panel for the specified plugin.
      Parameters:
      plugin - the plugin to configure
    • savePinnedPlugins

      public abstract void savePinnedPlugins()
      Saves the list of pinned plugins to persistent storage.
    • refresh

      public abstract void refresh()
      Refreshes the plugin list display.

      This updates the display without fully rebuilding the list.

    • rebuildPluginList

      public abstract void rebuildPluginList()
      Completely rebuilds the plugin list.

      This recreates all list items and should be called when plugins are added or removed.

    • startPlugin

      public abstract void startPlugin(Plugin plugin) throws PluginInstantiationException
      Starts the specified plugin.
      Parameters:
      plugin - the plugin to start
      Throws:
      PluginInstantiationException - if the plugin fails to start
    • stopPlugin

      public abstract void stopPlugin(Plugin plugin) throws PluginInstantiationException
      Stops the specified plugin.
      Parameters:
      plugin - the plugin to stop
      Throws:
      PluginInstantiationException - if the plugin fails to stop
    • getMuxer

      public abstract net.runelite.client.ui.MultiplexingPluginPanel getMuxer()
      Gets the multiplexing panel that manages panel navigation.
      Returns:
      the multiplexing plugin panel