Package com.polarion.alm.tracker

Interface IModulePageLayouter

public interface IModulePageLayouter

Module home page layouter.

Since:

3.5

Author:

Stepan Roh

See Also:

• IModule.renderHomePageContent(String, String, String)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IModulePageLayouter.IRenderingLayout	Layout definition.
static class	IModulePageLayouter.PropertyDescriptior
static class	IModulePageLayouter.RenderParameters

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_FIELDS_AT_END
static final String	PROPERTY_FIELDS_AT_END_AS_TABLE
static final String	PROPERTY_FIELDS_AT_START
static final String	PROPERTY_SIDEBAR_WORK_ITEM_FIELDS
static final String	PROPERTY_TYPE_BOOLEAN
static final String	PROPERTY_TYPE_LIST_OF_FIELDS
static final String	PROPERTY_TYPE_STRING

Method Summary

Modifier and Type	Method	Description
Set<String>	getContentRenderedFieldIds(IModulePageLayouter.IRenderingLayout layout)	Returns fields that are rendered as content in the layout as, for example, the description.
List<IModulePageLayouter.PropertyDescriptior>	getPropertyDescriptors()	Returns a list of PropertyDescriptiors needed by the layout customization dialog for editing the properties.
Set<String>	getRenderedFieldIds(IModulePageLayouter.IRenderingLayout layout)	Returns fields that are rendered in the layout.
List<ITypeOpt>	getSuitableForTypes(String projectId)
CharSequence	renderWorkItem(IModulePageLayouter.RenderParameters parameters)	Render Work Item using the given layout.
CharSequence	renderWorkItemTemplate(IModulePageLayouter.RenderParameters parameters)	Render a template for the newly created Work Items that are used by the editor.

Field Details

PROPERTY_TYPE_BOOLEAN

static final String PROPERTY_TYPE_BOOLEAN

See Also:

• Constant Field Values

PROPERTY_TYPE_STRING

static final String PROPERTY_TYPE_STRING

See Also:

• Constant Field Values

PROPERTY_TYPE_LIST_OF_FIELDS

static final String PROPERTY_TYPE_LIST_OF_FIELDS

See Also:

• Constant Field Values

PROPERTY_FIELDS_AT_START

static final String PROPERTY_FIELDS_AT_START

See Also:

• Constant Field Values

PROPERTY_FIELDS_AT_END

static final String PROPERTY_FIELDS_AT_END

See Also:

• Constant Field Values

PROPERTY_FIELDS_AT_END_AS_TABLE

static final String PROPERTY_FIELDS_AT_END_AS_TABLE

See Also:

• Constant Field Values

PROPERTY_SIDEBAR_WORK_ITEM_FIELDS

static final String PROPERTY_SIDEBAR_WORK_ITEM_FIELDS

Since:

3.9.1

See Also:

• Constant Field Values

Method Details

renderWorkItem

CharSequence renderWorkItem(IModulePageLayouter.RenderParameters parameters)

Render Work Item using the given layout.

Parameters:

parameters - The rendering parameters.

Returns:

rendered Work Item (not null).

renderWorkItemTemplate

CharSequence renderWorkItemTemplate(IModulePageLayouter.RenderParameters parameters)

Render a template for the newly created Work Items that are used by the editor.

Parameters:

parameters - The rendering parameters.

Returns:

The rendered Work Item template (not null).

getRenderedFieldIds

@NotNull
Set<String> getRenderedFieldIds(@NotNull
 IModulePageLayouter.IRenderingLayout layout)

Returns fields that are rendered in the layout. Returned set contains fields returned by getContentRenderedFieldIds(IRenderingLayout).

Parameters:

layout -

Returns:

list of Work Item field IDs (not null).

getContentRenderedFieldIds

@NotNull
Set<String> getContentRenderedFieldIds(@NotNull
 IModulePageLayouter.IRenderingLayout layout)

Returns fields that are rendered as content in the layout as, for example, the description. Unlike getRenderedFieldIds(IRenderingLayout), it does not return Field at Start and Field at End.

Returns:

set of Work Item field IDs (not null).

Since:

3.8.3

getPropertyDescriptors

List<IModulePageLayouter.PropertyDescriptior> getPropertyDescriptors()

Returns a list of PropertyDescriptiors needed by the layout customization dialog for editing the properties. The editors for the properties are displayed in the same order that is returned by this method.

getSuitableForTypes

List<ITypeOpt> getSuitableForTypes(String projectId)

Returns:

list of Work Item types which can be laid out by this layouter in the given project; null if it can handle all types.

Since:

3.6.3