com.atlassian.jira.issue.fields.screen

Class BulkFieldScreenRendererImpl

java.lang.Object

com.atlassian.jira.issue.fields.screen.BulkFieldScreenRendererImpl

All Implemented Interfaces:

FieldScreenRenderer

public class BulkFieldScreenRendererImpl
extends Object

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) Return null if cannot find tab for the given 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFieldScreenRenderTabs

public List<FieldScreenRenderTab> getFieldScreenRenderTabs()

Returns:

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

getFieldLayout

public FieldLayout getFieldLayout()

Description copied from interface: FieldScreenRenderer

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

public Collection<FieldScreenRenderLayoutItem> getRequiredFieldScreenRenderItems()

Description copied from interface: FieldScreenRenderer

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

Specified by:

getRequiredFieldScreenRenderItems in interface FieldScreenRenderer

Returns:

A collection of FieldScreenRenderLayoutItem objects

getFieldScreenRenderTabPosition

public FieldScreenRenderTab getFieldScreenRenderTabPosition(String fieldId)

Return null if cannot find tab for the given fieldId

Specified by:

getFieldScreenRenderTabPosition in interface FieldScreenRenderer

Parameters:

fieldId - The id of an the OrderableField to match against

Returns:

The tab which contains the field.

See Also:

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

getFieldScreenRenderLayoutItem

public FieldScreenRenderLayoutItem getFieldScreenRenderLayoutItem(OrderableField orderableField)

Description copied from interface: FieldScreenRenderer

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

Specified by:

getFieldScreenRenderLayoutItem in interface FieldScreenRenderer

Parameters:

orderableField - The field to find

Returns:

The FieldScreenRenderLayoutItem which contains the OrderableField

See Also:

FieldScreenRenderer.getFieldScreenRenderTabPosition(String)

getAllScreenRenderItems

public List<FieldScreenRenderLayoutItem> getAllScreenRenderItems()

Description copied from interface: FieldScreenRenderer

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.

Specified by:

getAllScreenRenderItems in interface FieldScreenRenderer

Returns:

all the layout items from all tabs.

getFieldScreenRenderLayoutItemByFieldId

public Optional<FieldScreenRenderLayoutItem> getFieldScreenRenderLayoutItemByFieldId(String fieldId)

Description copied from interface: FieldScreenRenderer

Find FieldScreenRenderLayoutItem by fieldId in all screen render items

Specified by:

getFieldScreenRenderLayoutItemByFieldId in interface FieldScreenRenderer

Parameters:

fieldId - field id

Returns:

FieldScreenRenderLayoutItem if exists, empty optional otherwise