|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicApi public interface FieldConfigItemType
Represents a single dimension of configuration for a custom field. If a custom field needs to be configured in many ways, each way would have an implementation of this type. Methods defined include those necessary to render the current configured state and a name for the type of configuration that the implementation embodies. Also included are a URL link for directing the browser to the configuration screen and a value for the current configuration as well as a key unique to this configuration type.
Method Summary | |
---|---|
String |
getBaseEditUrl()
Creates the base of the URL that links to the configuration screen for this type of configuration. |
Object |
getConfigurationObject(Issue issue,
FieldConfig config)
Returns an Object that holds the the configuration. |
String |
getDisplayName()
The user interface name for this dimension of configuration. |
String |
getDisplayNameKey()
The i18n key for the user interface name for this dimension of configuration. |
String |
getObjectKey()
Returns a key unique among FieldConfigItemType implementations for the configuration value so it can be retrieved from a key-value pair store. |
String |
getViewHtml(FieldConfig fieldConfig,
FieldLayoutItem fieldLayoutItem)
Renders a view of the current configuration as html. |
Method Detail |
---|
String getDisplayName()
String getDisplayNameKey()
String getViewHtml(FieldConfig fieldConfig, FieldLayoutItem fieldLayoutItem)
fieldConfig
- fieldLayoutItem
-
String getObjectKey()
Object getConfigurationObject(Issue issue, FieldConfig config)
issue
- config
-
String getBaseEditUrl()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |