public abstract class AbstractCapabilityTypeModule extends AbstractCapabilityType implements CapabilityTypeModule
Constructor and Description |
---|
AbstractCapabilityTypeModule() |
Modifier and Type | Method and Description |
---|---|
@NotNull String |
getCapabilityTypeKey()
The key for the type typically lower case
|
@NotNull String |
getCapabilityTypeLabel()
Human readable version of the key
|
String |
getEditHtml()
Renders the edit form using the ftl template declared in module descriptor.
|
String |
getExtraInfo(@NotNull String key)
Displayed after the label
|
@NotNull String |
getNewKeyFromLabel(@NotNull String oldKey,
@NotNull String label)
From the key and label, return a new key.
|
int |
getSortOrder()
Specifies how early in the UI the type should be shown
|
String |
getValueDescriptionKey(@NotNull String key,
@Nullable String value)
Given the key and value, show any custom description for the value
|
void |
init(@NotNull com.atlassian.plugin.ModuleDescriptor moduleDescriptor)
Initialises the Plugin with the plugin module descriptor
|
boolean |
isAllowRename()
Can you rename the key for this type
|
void |
setTemplateRenderer(TemplateRenderer templateRenderer)
Deprecated.
since 6.8 use constructor injection or annotation injection
|
compareTo, equals, getViewTypeAction, hashCode, toString, updatePlanForNewLabel, updateTasksForNewLabel
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getCapability, getCapabilityTypeSpecificTaskConfigurationKey, getLabel, getViewTypeAction, updatePlanForNewLabel, validate
compareTo
public int getSortOrder()
CapabilityType
getSortOrder
in interface CapabilityType
@NotNull public @NotNull String getCapabilityTypeKey()
CapabilityType
getCapabilityTypeKey
in interface CapabilityType
@NotNull public @NotNull String getCapabilityTypeLabel()
CapabilityType
getCapabilityTypeLabel
in interface CapabilityType
public String getExtraInfo(@NotNull @NotNull String key)
CapabilityType
getExtraInfo
in interface CapabilityType
public String getValueDescriptionKey(@NotNull @NotNull String key, @Nullable @Nullable String value)
CapabilityType
getValueDescriptionKey
in interface CapabilityType
public boolean isAllowRename()
CapabilityType
isAllowRename
in interface CapabilityType
@NotNull public @NotNull String getNewKeyFromLabel(@NotNull @NotNull String oldKey, @NotNull @NotNull String label)
CapabilityType
getNewKeyFromLabel
in interface CapabilityType
public String getEditHtml()
This method sets this as capabilityType variable which you can use in the template
Override this method if you need custom rendering.
getEditHtml
in interface CapabilityTypeModule
public void init(@NotNull @NotNull com.atlassian.plugin.ModuleDescriptor moduleDescriptor)
InitablePluginModule
init
in interface InitablePluginModule
moduleDescriptor
- Plugin module descriptor@Deprecated public void setTemplateRenderer(TemplateRenderer templateRenderer)
Copyright © 2022 Atlassian Software Systems Pty Ltd. All rights reserved.