@PublicApi
public interface FieldScreenRenderer
A FieldScreenRenderer glues a FieldLayout (which governs requireability and hideability) with a FieldScreen (which governs tabs, and ordering within tabs, and screen-level hideability). For example, it is possible for a field to be hidden on this screen, but still visible on other screens.
FieldScreenRenderers are usually constructed with a user, and a particular operation.
Modifier and Type | Method and Description |
---|---|
List<FieldScreenRenderLayoutItem> |
getAllScreenRenderItems()
Return a list of all the
FieldScreenRenderLayoutItem s contained
on any of the FieldScreenRenderTab s. |
FieldLayout |
getFieldLayout()
Get the underlying
FieldLayout which backs this FieldScreenRenderer . |
FieldScreenRenderLayoutItem |
getFieldScreenRenderLayoutItem(OrderableField orderableField)
A convenience method to locate the
FieldScreenRenderLayoutItem which has a field
which has an id matching parameter orderableField |
FieldScreenRenderTab |
getFieldScreenRenderTabPosition(String fieldId)
A convenience method to locate the tab, which contains the
FieldScreenRenderLayoutItem which has a field
which has an id matching parameter fieldId |
List<FieldScreenRenderTab> |
getFieldScreenRenderTabs() |
Collection<FieldScreenRenderLayoutItem> |
getRequiredFieldScreenRenderItems()
A convenience method which loops through all the
FieldScreenRenderLayoutItem on all tabs, and returns
the ones that are required. |
List<FieldScreenRenderTab> getFieldScreenRenderTabs()
FieldScreenRenderTab
objects which are visible and contain at least one
FieldScreenRenderLayoutItem
FieldScreenRenderTab getFieldScreenRenderTabPosition(String fieldId)
FieldScreenRenderLayoutItem
which has a field
which has an id matching parameter fieldIdfieldId
- The id of an the OrderableField
to match againstgetFieldScreenRenderLayoutItem(com.atlassian.jira.issue.fields.OrderableField)
FieldScreenRenderLayoutItem getFieldScreenRenderLayoutItem(OrderableField orderableField)
FieldScreenRenderLayoutItem
which has a field
which has an id matching parameter orderableFieldorderableField
- The field to findFieldScreenRenderLayoutItem
which contains the OrderableField
getFieldScreenRenderTabPosition(String)
FieldLayout getFieldLayout()
FieldLayout
which backs this FieldScreenRenderer
. This is currently used to find all
the visible fields, not just the ones visible on this screen. This allows the 'default' values to be set on
the fields not shown on this screen.FieldLayout
.Collection<FieldScreenRenderLayoutItem> getRequiredFieldScreenRenderItems()
FieldScreenRenderLayoutItem
on all tabs, and returns
the ones that are required.FieldScreenRenderLayoutItem
objectsList<FieldScreenRenderLayoutItem> getAllScreenRenderItems()
FieldScreenRenderLayoutItem
s contained
on any of the FieldScreenRenderTab
s.
It returns the items in order from first tab to last tab.Copyright © 2002-2023 Atlassian. All Rights Reserved.