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 Please use tag in web views instead of this component.

Field Summary

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

applicationProperties

Constructor Summary

Constructors

Constructor and Description
IssueTableWebComponent()

Method Summary

Modifier and Type	Method and Description
void	asHtml(Writer writer, IssueTableLayoutBean layout, List<Issue> issues, IssuePager pager, Long selectedIssueId) Writes a table of issues into the writer provided.
String	getHtml(IssueTableLayoutBean layout, List<Issue> issues, IssuePager pager) Deprecated. Since 6.3.8 use asHtml(java.io.Writer, IssueTableLayoutBean, java.util.List, IssuePager, Long). It is inefficient in using memory as it uses a string writer.
String	getHtml(IssueTableLayoutBean layout, List<Issue> issues, IssuePager pager, Long selectedIssueId) Deprecated. Since 6.3.8 use asHtml(java.io.Writer, IssueTableLayoutBean, java.util.List, IssuePager, Long). It is inefficient in using memory as it uses a string writer.
IssueTableWriter	getHtmlIssueWriter(Writer writer, IssueTableLayoutBean layout, IssuePager pager, ColumnLayoutItem actionColumn) Deprecated. since 6.3.8 please use asHtml(java.io.Writer, IssueTableLayoutBean, java.util.List, IssuePager, Long) and pass in the writer object.
IssueTableWriter	getHtmlIssueWriter(Writer writer, IssueTableLayoutBean layout, IssuePager pager, ColumnLayoutItem actionColumn, Long selectedIssueId) Deprecated. since 6.3.8 please use asHtml(java.io.Writer, IssueTableLayoutBean, java.util.List, IssuePager, Long) and pass in the writer object.

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

asHtml, 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

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

Deprecated. Since 6.3.8 use asHtml(java.io.Writer, IssueTableLayoutBean, java.util.List, IssuePager, Long). It is inefficient in using memory as it uses a string writer.

Gets 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

Returns:

An HTML table of issues

getHtml

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

Deprecated. Since 6.3.8 use asHtml(java.io.Writer, IssueTableLayoutBean, java.util.List, IssuePager, Long). It is inefficient in using memory as it uses a string writer.

Gets 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

asHtml

public void asHtml(Writer writer,
                   IssueTableLayoutBean layout,
                   List<Issue> issues,
                   IssuePager pager,
                   Long selectedIssueId)

Writes a table of issues into the writer provided.

Parameters:

writer - Writer where the HTML markup is written to.

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

getHtmlIssueWriter

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

Deprecated. since 6.3.8 please use asHtml(java.io.Writer, IssueTableLayoutBean, java.util.List, IssuePager, Long) and pass in the writer object.

getHtmlIssueWriter

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

Deprecated. since 6.3.8 please use asHtml(java.io.Writer, IssueTableLayoutBean, java.util.List, IssuePager, Long) and pass in the writer object.

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.