public interface OptionCategoryDefinition
OptionDefinition.getCategory()
on any option there should be an option category in registry.
Option categories depend on some module type. They are only used for options of module definitions that belong to the module type they are registered for.
That way it is possible to register one category name for two different module types with differing information.
Register option category implementations via ModuleRegistry.addOptionCategoryDefinition(OptionCategoryDefinition)
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDescription(java.util.Locale locale)
Returns a localized description for the category
|
java.lang.String |
getKey()
Returns the key of the option category, which is the string returned by
OptionDefinition.getCategory() |
java.lang.Class<? extends ModuleType> |
getModuleType()
Returns the module type for which this category is registered
|
java.lang.String |
getTitle(java.util.Locale locale)
Returns a localized title for the category
|
java.lang.String getKey()
OptionDefinition.getCategory()
java.lang.String getTitle(java.util.Locale locale)
java.lang.String getDescription(java.util.Locale locale)
java.lang.Class<? extends ModuleType> getModuleType()