com.atlassian.jira.web.component

Class TableLayoutUtilsImpl

java.lang.Object

com.atlassian.jira.web.component.TableLayoutUtilsImpl

All Implemented Interfaces:

TableLayoutUtils

public class TableLayoutUtilsImpl
extends Object
implements TableLayoutUtils

Constructor Summary

Constructors

Constructor and Description
TableLayoutUtilsImpl(ApplicationProperties applicationProperties, FieldManager fieldManager)

Method Summary

Modifier and Type	Method and Description
List<ColumnLayoutItem>	getColumns(ApplicationUser user, List<String> fields) Get the columns based off the a list of field names
List<ColumnLayoutItem>	getColumns(ApplicationUser user, String applicationPropertyName) Get the columns based off an application property
List<ColumnLayoutItem>	getColumns(ApplicationUser user, String context, List<String> columnNames, boolean addDefaults) Get the columns based on a list of field names, and the default as defined in application properties with the given property name.
List<String>	getDefaultColumnNames(String applicationPropertyName) Users can specify a list of columns to display in their application properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableLayoutUtilsImpl

public TableLayoutUtilsImpl(ApplicationProperties applicationProperties,
                            FieldManager fieldManager)

Method Detail

getDefaultColumnNames

public List<String> getDefaultColumnNames(String applicationPropertyName)

Description copied from interface: TableLayoutUtils

Users can specify a list of columns to display in their application properties. This is a method to retrieve them.

Specified by:

getDefaultColumnNames in interface TableLayoutUtils

Parameters:

applicationPropertyName - The name of the property in jira-application.properties

Returns:

A list of String objects

getColumns

public List<ColumnLayoutItem> getColumns(ApplicationUser user,
                                         String applicationPropertyName)
                                  throws FieldException

Description copied from interface: TableLayoutUtils

Get the columns based off an application property

Specified by:

getColumns in interface TableLayoutUtils

Parameters:

user - The suer to retreive columns for.

applicationPropertyName - The property to get the list of fields from in the application properties

Returns:

a list containing the field equivs of the field names

Throws:

FieldException - if there is an exception thrown while retieving the fields

getColumns

public List<ColumnLayoutItem> getColumns(ApplicationUser user,
                                         List<String> fields)
                                  throws FieldException

Description copied from interface: TableLayoutUtils

Get the columns based off the a list of field names

Specified by:

getColumns in interface TableLayoutUtils

Parameters:

user - The suer to retreive columns for.

fields - The list of columns to retrieve.

Returns:

a list containing the field equivs of the field names

Throws:

FieldException - if there is an exception thrown while retieving the fields

getColumns

public List<ColumnLayoutItem> getColumns(ApplicationUser user,
                                         String context,
                                         List<String> columnNames,
                                         boolean addDefaults)
                                  throws FieldException

Description copied from interface: TableLayoutUtils

Get the columns based on a list of field names, and the default as defined in application properties with the given property name.

Specified by:

getColumns in interface TableLayoutUtils

Parameters:

user - The user to retreive columns for.

context - The name of the property in jira-application.properties

columnNames - The list of columns to retrieve.

addDefaults - if true, will add the default columns.

Returns:

a list containing the field equivs of the field names

Throws:

FieldException - if there is an exception thrown while retieving the fields