com.atlassian.jira.web.component
Class IssueTableWebComponent

java.lang.Object
  com.atlassian.jira.web.component.AbstractWebComponent
      com.atlassian.jira.web.component.IssueTableWebComponent

public class IssueTableWebComponent
extends AbstractWebComponent

This class displays a table of issues, and works together with issuetable.vm.

The layout of the table is configured by an IssueTableLayoutBean

Field Summary

Fields inherited from class com.atlassian.jira.web.component.AbstractWebComponent

applicationProperties, velocityManager

Constructor Summary

IssueTableWebComponent()

Method Summary

String	getHtml(IssueTableLayoutBean layout, List<Issue> issues, IssuePager pager)
String	getHtml(IssueTableLayoutBean layout, List<Issue> issues, IssuePager pager, Long selectedIssueId) Get a table of issues.
IssueTableWriter	getHtmlIssueWriter(Writer writer, IssueTableLayoutBean layout, IssuePager pager, ColumnLayoutItem actionColumn)
IssueTableWriter	getHtmlIssueWriter(Writer writer, IssueTableLayoutBean layout, IssuePager pager, ColumnLayoutItem actionColumn, Long selectedIssueId) Constructs a new IssueTableWriter that can be used to write a table of issues.

Methods inherited from class com.atlassian.jira.web.component.AbstractWebComponent

getHtml

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueTableWebComponent

public IssueTableWebComponent()

Method Detail

getHtml

public String getHtml(IssueTableLayoutBean layout,
                      List<Issue> issues,
                      IssuePager pager)

getHtml

public String getHtml(IssueTableLayoutBean layout,
                      List<Issue> issues,
                      IssuePager pager,
                      Long selectedIssueId)

Get a table of issues.

Parameters:

layout - The layout describing how this table should look

issues - The issues to display. These should be a list of Issue objects

pager - An optional pager which will be used for displaying the next / previous paging at the top and bottom

selectedIssueId - the issue to mark as selected in the table of issues; if null, marks the first issue as selected

Returns:

An HTML table of issues

getHtmlIssueWriter

public IssueTableWriter getHtmlIssueWriter(Writer writer,
                                           IssueTableLayoutBean layout,
                                           IssuePager pager,
                                           ColumnLayoutItem actionColumn)

getHtmlIssueWriter

public IssueTableWriter getHtmlIssueWriter(Writer writer,
                                           IssueTableLayoutBean layout,
                                           IssuePager pager,
                                           ColumnLayoutItem actionColumn,
                                           Long selectedIssueId)

Constructs a new IssueTableWriter that can be used to write a table of issues.

Parameters:

writer - The writer to write the table to

layout - The layout describing how this table should look

pager - An optional pager which will be used for displaying the next / previous paging at the top and bottom

actionColumn - The column to display on the right hand side of the table. If null, no column is shown.

selectedIssueId - the issue to mark as selected in the table; if null, marks the first issue as selected

Returns:

An IssueTableWriter which the caller should use to write each issue to.