com.atlassian.jira.web.component
Interface TableLayoutUtils

All Known Implementing Classes:
TableLayoutUtilsImpl

public interface TableLayoutUtils

Util class for getting columns for issue tables.

Since:
v4.0

Method Summary
 List<ColumnLayoutItem> getColumns(com.atlassian.crowd.embedded.api.User user, List<String> fields)
          Get the columns based off the a list of field names
 List<ColumnLayoutItem> getColumns(com.atlassian.crowd.embedded.api.User user, String applicationPropertyName)
          Get the columns based off an application property
 List<ColumnLayoutItem> getColumns(com.atlassian.crowd.embedded.api.User user, String applicationPropertyName, List<String> fields, 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.
 

Method Detail

getDefaultColumnNames

List<String> getDefaultColumnNames(String applicationPropertyName)
Users can specify a list of columns to display in their application properties. This is a method to retrieve them.

Parameters:
applicationPropertyName - The name of the property in jira-application.properties
Returns:
A list of String objects

getColumns

List<ColumnLayoutItem> getColumns(com.atlassian.crowd.embedded.api.User user,
                                  List<String> fields)
                                  throws FieldException
Get the columns based off the a list of field names

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

List<ColumnLayoutItem> getColumns(com.atlassian.crowd.embedded.api.User user,
                                  String applicationPropertyName,
                                  List<String> fields,
                                  boolean addDefaults)
                                  throws FieldException
Get the columns based on a list of field names, and the default as defined in application properties with the given property name.

Parameters:
user - The user to retreive columns for.
applicationPropertyName - The name of the property in jira-application.properties
fields - 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

getColumns

List<ColumnLayoutItem> getColumns(com.atlassian.crowd.embedded.api.User user,
                                  String applicationPropertyName)
                                  throws FieldException
Get the columns based off an application property

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


Copyright © 2002-2015 Atlassian. All Rights Reserved.