com.atlassian.jira.web.component
Class IssueTableLayoutBean

java.lang.Object
  extended by com.atlassian.jira.web.component.IssueTableLayoutBean

public class IssueTableLayoutBean
extends Object

This bean is used to control the display properties of the IssueTable, and works with IssueTableWebComponent and issuetable.vm to achieve this.

It contains sensible defaults.


Field Summary
static String CELL_NO_LINK
           
static String CELL_TEXT_ONLY
           
static String EXCEL_VIEW
          Deprecated. use FieldRenderingContext.EXCEL_VIEW instead
static String FULL_LINK
           
static String NAVIGATOR_VIEW
          Deprecated. use FieldRenderingContext.NAVIGATOR_VIEW instead
 
Constructor Summary
IssueTableLayoutBean(List<ColumnLayoutItem> columns)
           
IssueTableLayoutBean(List<ColumnLayoutItem> columns, Collection<SearchSort> searchSorts)
           
IssueTableLayoutBean(User user, Collection<SearchSort> searchSorts)
           
 
Method Summary
 void addCellDisplayParam(String key, Object value)
          You can use this method to pass parameters through to individual cells / issues for formatting.
 String getActionUrl()
           
 Map getCellDisplayParams()
           
 List<ColumnLayoutItem> getColumns()
           
 Long getFilterId()
           
 SearchSort getFirstSorter()
           
 String getTableCssClass()
           
 boolean isAlternateRowColors()
           
 boolean isDisplayHeader()
           
 boolean isDisplayHeaderPager()
           
 boolean isShowActionColumn()
           
 boolean isShowExteriorTable()
           
 boolean isShowHeaderDescription()
           
 boolean isShowTableEditHeader()
           
 boolean isSortingEnabled()
           
 void setActionUrl(String actionUrl)
           
 void setAlternateRowColors(boolean alternateRowColors)
           
 void setDisplayHeader(boolean displayHeader)
           
 void setDisplayHeaderPager(boolean displayHeaderPager)
           
 void setFilterId(Long filterId)
           
 void setShowActionColumn(boolean showActionColumn)
           
 void setShowExteriorTable(boolean showExteriorTable)
           
 void setShowHeaderDescription(boolean showHeaderDescription)
           
 void setShowTableEditHeader(boolean showTableEditHeader)
           
 void setSortingEnabled(boolean sortingEnabled)
           
 void setTableCssClass(String tableCssClass)
          Set the CSS class for the table element in the issue table.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CELL_NO_LINK

public static final String CELL_NO_LINK
See Also:
Constant Field Values

CELL_TEXT_ONLY

public static final String CELL_TEXT_ONLY
See Also:
Constant Field Values

FULL_LINK

public static final String FULL_LINK
See Also:
Constant Field Values

EXCEL_VIEW

public static final String EXCEL_VIEW
Deprecated. use FieldRenderingContext.EXCEL_VIEW instead
See Also:
Constant Field Values

NAVIGATOR_VIEW

public static final String NAVIGATOR_VIEW
Deprecated. use FieldRenderingContext.NAVIGATOR_VIEW instead
See Also:
Constant Field Values
Constructor Detail

IssueTableLayoutBean

public IssueTableLayoutBean(List<ColumnLayoutItem> columns)

IssueTableLayoutBean

public IssueTableLayoutBean(List<ColumnLayoutItem> columns,
                            Collection<SearchSort> searchSorts)

IssueTableLayoutBean

public IssueTableLayoutBean(User user,
                            Collection<SearchSort> searchSorts)
Method Detail

getColumns

public List<ColumnLayoutItem> getColumns()

getFirstSorter

public SearchSort getFirstSorter()

getFilterId

public Long getFilterId()

getActionUrl

public String getActionUrl()

addCellDisplayParam

public void addCellDisplayParam(String key,
                                Object value)
You can use this method to pass parameters through to individual cells / issues for formatting.

See Also:
CELL_NO_LINK, CELL_TEXT_ONLY

getCellDisplayParams

public Map getCellDisplayParams()

isSortingEnabled

public boolean isSortingEnabled()

setSortingEnabled

public void setSortingEnabled(boolean sortingEnabled)

isShowHeaderDescription

public boolean isShowHeaderDescription()

setShowHeaderDescription

public void setShowHeaderDescription(boolean showHeaderDescription)

isAlternateRowColors

public boolean isAlternateRowColors()

setAlternateRowColors

public void setAlternateRowColors(boolean alternateRowColors)

isShowTableEditHeader

public boolean isShowTableEditHeader()

setShowTableEditHeader

public void setShowTableEditHeader(boolean showTableEditHeader)

setFilterId

public void setFilterId(Long filterId)

setActionUrl

public void setActionUrl(String actionUrl)

setDisplayHeader

public void setDisplayHeader(boolean displayHeader)

isDisplayHeader

public boolean isDisplayHeader()

isDisplayHeaderPager

public boolean isDisplayHeaderPager()

setDisplayHeaderPager

public void setDisplayHeaderPager(boolean displayHeaderPager)

isShowExteriorTable

public boolean isShowExteriorTable()

setShowExteriorTable

public void setShowExteriorTable(boolean showExteriorTable)

getTableCssClass

public String getTableCssClass()

setTableCssClass

public void setTableCssClass(String tableCssClass)
Set the CSS class for the table element in the issue table. Defaults to 'grid'


isShowActionColumn

public boolean isShowActionColumn()

setShowActionColumn

public void setShowActionColumn(boolean showActionColumn)


Copyright © 2002-2009 Atlassian. All Rights Reserved.