com.atlassian.jira.issue.fields.screen

Interface FieldScreenRenderer

All Known Implementing Classes:

BulkFieldScreenRendererImpl

@PublicApi
public interface FieldScreenRenderer

Copyright (c) 2002-2004 All rights reserved.

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.

Method Summary

Modifier and Type	Method and Description
List<FieldScreenRenderLayoutItem>	getAllScreenRenderItems() Return a list of all the FieldScreenRenderLayoutItems contained on any of the FieldScreenRenderTabs.
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
Optional<FieldScreenRenderLayoutItem>	getFieldScreenRenderLayoutItemByFieldId(String fieldId) Find FieldScreenRenderLayoutItem by fieldId in all screen render items
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.

Method Detail

getFieldScreenRenderTabs

List<FieldScreenRenderTab> getFieldScreenRenderTabs()

Returns:

A list of FieldScreenRenderTab objects which are visible and contain at least one FieldScreenRenderLayoutItem

getFieldScreenRenderTabPosition

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

Parameters:

fieldId - The id of an the OrderableField to match against

Returns:

The tab which contains the field.

See Also:

getFieldScreenRenderLayoutItem(com.atlassian.jira.issue.fields.OrderableField)

getFieldScreenRenderLayoutItem

FieldScreenRenderLayoutItem getFieldScreenRenderLayoutItem(OrderableField orderableField)

A convenience method to locate the FieldScreenRenderLayoutItem which has a field which has an id matching parameter orderableField

Parameters:

orderableField - The field to find

Returns:

The FieldScreenRenderLayoutItem which contains the OrderableField

See Also:

getFieldScreenRenderTabPosition(String)

getFieldLayout

FieldLayout getFieldLayout()

Get the underlying 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.

Returns:

the underlying FieldLayout.

getRequiredFieldScreenRenderItems

Collection<FieldScreenRenderLayoutItem> getRequiredFieldScreenRenderItems()

A convenience method which loops through all the FieldScreenRenderLayoutItem on all tabs, and returns the ones that are required.

Returns:

A collection of FieldScreenRenderLayoutItem objects

getAllScreenRenderItems

List<FieldScreenRenderLayoutItem> getAllScreenRenderItems()

Return a list of all the FieldScreenRenderLayoutItems contained on any of the FieldScreenRenderTabs. It returns the items in order from first tab to last tab.

Returns:

all the layout items from all tabs.

getFieldScreenRenderLayoutItemByFieldId

Optional<FieldScreenRenderLayoutItem> getFieldScreenRenderLayoutItemByFieldId(String fieldId)

Find FieldScreenRenderLayoutItem by fieldId in all screen render items

Parameters:

fieldId - field id

Returns:

FieldScreenRenderLayoutItem if exists, empty optional otherwise

Since:

9.9