Summary: Methods | [Expand All]
@PublicApi public interface

FieldScreenRenderer

com.atlassian.jira.issue.fields.screen.FieldScreenRenderer
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

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.

Summary

Public Methods
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
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.

Public Methods

public 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.

public 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

public 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
See Also

public 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

public List<FieldScreenRenderTab> getFieldScreenRenderTabs ()

Returns

public Collection<FieldScreenRenderLayoutItem> getRequiredFieldScreenRenderItems ()

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

Returns