Package net.storm.api.plugins.config

Class PluginConfigurationDescriptor

java.lang.Object

net.storm.api.plugins.config.PluginConfigurationDescriptor

public class PluginConfigurationDescriptor
extends Object

Complete descriptor for a plugin's configuration, combining plugin metadata with config details.

PluginConfigurationDescriptor provides all the information needed to display and manage a plugin in the configuration panel, including:

• Plugin metadata (name, description, tags)
• The Plugin instance (if applicable)
• The Config interface and its descriptor
• Conflict information

This class is used by the UI to render plugin list items and configuration panels.

See Also:

• Plugin
• Config
• ConfigDescriptor

Constructor Summary

Constructors

Constructor	Description
PluginConfigurationDescriptor(String name, String description, String[] tags, Config config, ConfigDescriptor configDescriptor)	Creates a descriptor without a Plugin instance (for non-plugin configurations).

Method Summary

Modifier and Type	Method	Description
JMenuItem	createSupportMenuItem()	Creates a menu item for linking to support/documentation for the plugin.
String	getInternalPluginHubName()	Gets the internal plugin hub name for this plugin.
boolean	hasConfigurables()	Checks if this plugin has any visible configurable items.

Methods inherited from class java.lang.Object

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

Constructor Details

PluginConfigurationDescriptor

public PluginConfigurationDescriptor(String name,
 String description,
 String[] tags,
 Config config,
 ConfigDescriptor configDescriptor)

Creates a descriptor without a Plugin instance (for non-plugin configurations).

Parameters:

name - the display name

description - the description

tags - the search tags

config - the configuration interface

configDescriptor - the configuration descriptor

Method Details

hasConfigurables

public boolean hasConfigurables()

Checks if this plugin has any visible configurable items.

Returns:

true if there are non-hidden configuration items, false otherwise

createSupportMenuItem

public JMenuItem createSupportMenuItem()

Creates a menu item for linking to support/documentation for the plugin.

For plugin hub plugins, links to the plugin hub page. For other plugins, links to the wiki page.

Returns:

a JMenuItem that opens the appropriate URL when clicked

getInternalPluginHubName

@Nullable
public String getInternalPluginHubName()

Gets the internal plugin hub name for this plugin.

Override in subclasses to provide plugin hub integration.

Returns:

the plugin hub name, or null if not a plugin hub plugin