com.atlassian.jira.web.component
Class TableLayoutFactory
java.lang.Object
com.atlassian.jira.web.component.TableLayoutFactory
public class TableLayoutFactory
- extends Object
A class for creating IssueTableLayoutBean
objects.
Method Summary |
IssueTableLayoutBean |
getAllColumnsExcelLayout(SearchRequest searchRequest,
com.atlassian.crowd.embedded.api.User user)
|
IssueTableLayoutBean |
getDashboardLayout(com.atlassian.crowd.embedded.api.User user,
List<String> columnNames)
Get the columns relevant for the dashboard, but limiting to a specific list of column names. |
IssueTableLayoutBean |
getPrintableLayout(SearchRequest searchRequest,
com.atlassian.crowd.embedded.api.User user)
|
IssueTableLayoutBean |
getStandardExcelLayout(SearchRequest searchRequest,
com.atlassian.crowd.embedded.api.User user)
|
IssueTableLayoutBean |
getStandardLayout(SearchRequest searchRequest,
com.atlassian.crowd.embedded.api.User user)
|
IssueTableLayoutBean |
getSubTaskIssuesLayout(com.atlassian.crowd.embedded.api.User user,
Issue parentIssue,
SubTaskBean subTaskBean,
String subTaskView,
boolean timeTrackingData)
Get the layout for sub-tasks on the view issue page. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
TableLayoutFactory
public TableLayoutFactory(ColumnLayoutManager columnLayoutManager,
FieldManager fieldManager,
TableLayoutUtils tableLayoutUtils,
ColumnLayoutItemFactory columnLayoutItemFactory,
UserPreferencesManager userPreferencesManager,
SearchService searchService,
SearchSortUtil searchSortUtil)
getStandardLayout
public IssueTableLayoutBean getStandardLayout(SearchRequest searchRequest,
com.atlassian.crowd.embedded.api.User user)
getDashboardLayout
public IssueTableLayoutBean getDashboardLayout(com.atlassian.crowd.embedded.api.User user,
List<String> columnNames)
throws FieldException
- 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 APKeys.ISSUE_TABLE_COLS_DASHBOARD
- Returns:
- A layout using the columns specified or default, with the correct display properties for the Dashboard.
- Throws:
FieldException
getPrintableLayout
public IssueTableLayoutBean getPrintableLayout(SearchRequest searchRequest,
com.atlassian.crowd.embedded.api.User user)
getStandardExcelLayout
public IssueTableLayoutBean getStandardExcelLayout(SearchRequest searchRequest,
com.atlassian.crowd.embedded.api.User user)
getAllColumnsExcelLayout
public IssueTableLayoutBean getAllColumnsExcelLayout(SearchRequest searchRequest,
com.atlassian.crowd.embedded.api.User user)
getSubTaskIssuesLayout
public IssueTableLayoutBean getSubTaskIssuesLayout(com.atlassian.crowd.embedded.api.User user,
Issue parentIssue,
SubTaskBean subTaskBean,
String subTaskView,
boolean timeTrackingData)
throws ColumnLayoutStorageException,
FieldException
- 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 fromparentIssue
- The parent issue of all the subTaskssubTaskBean
- The subTask bean that contains all the subtasks that will be displayed on this pagesubTaskView
- 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
Copyright © 2002-2012 Atlassian. All Rights Reserved.