|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
void init()
List 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 fieldId
fieldId
- The id of an the OrderableField
to match against
getFieldScreenRenderLayoutItem(com.atlassian.jira.issue.fields.OrderableField)
FieldScreenRenderLayoutItem getFieldScreenRenderLayoutItem(OrderableField orderableField)
FieldScreenRenderLayoutItem
which has a field
which has an id matching parameter orderableField
orderableField
- The field to find
FieldScreenRenderLayoutItem
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.
Collection getRequiredFieldScreenRenderItems()
FieldScreenRenderLayoutItem
on all tabs, and returns
the ones that are required.
FieldScreenRenderLayoutItem
objects
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |