public class

TableLayoutFactory

extends Object
java.lang.Object
   ↳ com.atlassian.jira.web.component.TableLayoutFactory

Class Overview

A class for creating IssueTableLayoutBean objects.

Summary

Public Constructors
TableLayoutFactory(FieldManager fieldManager, TableLayoutUtils tableLayoutUtils, ColumnLayoutItemFactory columnLayoutItemFactory, UserPreferencesManager userPreferencesManager, SearchService searchService, SearchSortUtil searchSortUtil)
Public Methods
IssueTableLayoutBean getAllColumnsExcelLayout(SearchRequest searchRequest, ApplicationUser user)
IssueTableLayoutBean getDashboardLayout(ApplicationUser user, List<String> columnNames)
Get the columns relevant for the dashboard, but limiting to a specific list of column names.
IssueTableLayoutBean getPrintableLayout(SearchRequest searchRequest, ApplicationUser user)
IssueTableLayoutBean getStandardExcelLayout(SearchRequest searchRequest, ApplicationUser user)
IssueTableLayoutBean getStandardLayout(SearchRequest searchRequest, ApplicationUser user)
IssueTableLayoutBean getSubTaskIssuesLayout(ApplicationUser user, Issue parentIssue, SubTaskBean subTaskBean, String subTaskView, boolean timeTrackingData)
Get the layout for sub-tasks on the view issue page.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public TableLayoutFactory (FieldManager fieldManager, TableLayoutUtils tableLayoutUtils, ColumnLayoutItemFactory columnLayoutItemFactory, UserPreferencesManager userPreferencesManager, SearchService searchService, SearchSortUtil searchSortUtil)

Public Methods

public IssueTableLayoutBean getAllColumnsExcelLayout (SearchRequest searchRequest, ApplicationUser user)

public IssueTableLayoutBean getDashboardLayout (ApplicationUser user, List<String> columnNames)

Get the columns relevant for the dashboard, but limiting to a specific list of column names. The column names have to match IssueFieldConstants. If you pass null you will get the default columns.

Parameters
columnNames The columns to display. If no columns are specified, this will default to the columns specified in the jira-application.properties file with the key represented by ISSUE_TABLE_COLS_DASHBOARD
Returns
  • A layout using the columns specified or default, with the correct display properties for the Dashboard.

public IssueTableLayoutBean getPrintableLayout (SearchRequest searchRequest, ApplicationUser user)

public IssueTableLayoutBean getStandardExcelLayout (SearchRequest searchRequest, ApplicationUser user)

public IssueTableLayoutBean getStandardLayout (SearchRequest searchRequest, ApplicationUser user)

public IssueTableLayoutBean getSubTaskIssuesLayout (ApplicationUser user, Issue parentIssue, SubTaskBean subTaskBean, String subTaskView, boolean timeTrackingData)

Get the layout for sub-tasks on the view issue page.

Users can specify which columns to show in jira-application.properties. The default columns that are always shown:

  • The sequence number (1, 2, etc)
  • The summary of the sub-task
  • The controls to re-order sub-tasks
  • The links to update workflow on the subtasks

The standard columns are retrieved from ColumnLayoutItemFactory.

Parameters
user To get the available columns from
parentIssue The parent issue of all the subTasks
subTaskBean The subTask bean that contains all the subtasks that will be displayed on this page
subTaskView The 'view' which is passed to the subTaskBean to get the list of subtasks to display. Usually either 'unresolved' or 'all'
timeTrackingData whether or not time tracking data should be shown
Returns
  • the IssueTableLayoutBean based on the application configuration.
Throws
ColumnLayoutStorageException if there is a problem accessing the column layout backing data
FieldException if there is a problem accessing the field backing data