com.atlassian.jira.issue.fields.screen
Interface FieldScreenRenderer

All Known Implementing Classes:
AbstractFieldScreenRenderer, BulkFieldScreenRendererImpl, FieldBasedFieldScreenRenderer, FieldScreenRendererImpl

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
 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 getFieldScreenRenderTabs()
           
 Collection getRequiredFieldScreenRenderItems()
          A convenience method which loops through all the FieldScreenRenderLayoutItem on all tabs, and returns the ones that are required.
 void init()
           
 

Method Detail

init

void init()

getFieldScreenRenderTabs

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


getRequiredFieldScreenRenderItems

Collection 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


Copyright © 2002-2008 Atlassian. All Rights Reserved.