ListObject (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.ListObject

public class ListObject
extends java.lang.Object

Represents a list object on a worksheet. The ListObject object is a member of the ListObjects collection. The ListObjects collection contains all the list objects on a worksheet.

Example

 
         Workbook workbook = new Workbook();
         Cells cells = workbook.getWorksheets().get(0).getCells();
         for (int i = 0; i  ɝ i++)
         {
         cells.get(0,i).putValue(CellsHelper.columnIndexToName(i));
          }
         for (int row = 1; row  ᝺ row++)
         {
          for (int column = 0; column  ɝ column++)
         {
         cells.get(row, column).putValue(row * column);
          }
          }
         ListObjectCollection tables = workbook.getWorksheets().get(0).getListObjects();
         int index = tables.add(0, 0, 9, 4, true);
         ListObject table = tables.get(0);
         table.setShowTotals(true);
         table.getListColumns().get(4).setTotalsCalculation(com.aspose.cells.TotalsCalculation.SUM);
         workbook.save("Book1.xlsx");

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`applyStyleToRange()` Apply the table style to the range.
`void`	`convertToRange()` Convert the table to range.
`void`	`convertToRange(TableToRangeOptions options)` Convert the table to range.
`AutoFilter`	`filter()` Filter the table.
`java.lang.String`	`getAlternativeDescription()` Gets the alternative description.
`java.lang.String`	`getAlternativeText()` Gets the alternative text.
`AutoFilter`	`getAutoFilter()` Gets auto filter.
`java.lang.String`	`getComment()` Gets the comment of the table.
`Range`	`getDataRange()` Gets the data range of the ListObject.
`int`	`getDataSourceType()` Gets the data source type of the table.
`java.lang.String`	`getDisplayName()` Gets the display name.
`int`	`getEndColumn()` Gets the end column of the range.
`int`	`getEndRow()` Gets the end row of the range.
`ListColumnCollection`	`getListColumns()` Gets ListColumns of the ListObject.
`QueryTable`	`getQueryTable()` Gets the linked QueryTable.
`boolean`	`getShowHeaderRow()` Gets whether this ListObject show header row.
`boolean`	`getShowTableStyleColumnStripes()` Indicates whether column stripe formatting is applied.
`boolean`	`getShowTableStyleFirstColumn()` Indicates whether the first column in the table should have the style applied.
`boolean`	`getShowTableStyleLastColumn()` Indicates whether the last column in the table should have the style applied.
`boolean`	`getShowTableStyleRowStripes()` Indicates whether row stripe formatting is applied.
`boolean`	`getShowTotals()` Gets whether this ListObject show total row.
`int`	`getStartColumn()` Gets the start column of the range.
`int`	`getStartRow()` Gets the start row of the range.
`java.lang.String`	`getTableStyleName()` Gets the table style name.
`int`	`getTableStyleType()` Gets and the built-in table style.
`XmlMap`	`getXmlMap()` Gets an `getXmlMap()` used for this list.
`void`	`putCellFormula(int rowOffset, int columnOffset, java.lang.String formula)` Put the formula to the cell in the table.
`void`	`putCellFormula(int rowOffset, int columnOffset, java.lang.String formula, boolean isTotalsRowFormula)` Put the formula to the cell in the table.
`void`	`putCellValue(int rowOffset, int columnOffset, java.lang.Object value)` Put the value to the cell.
`void`	`putCellValue(int rowOffset, int columnOffset, java.lang.Object value, boolean isTotalsRowLabel)` Put the value to the cell.
`void`	`resize(int startRow, int startColumn, int endRow, int endColumn, boolean hasHeaders)` Resize the range of the list object.
`void`	`setAlternativeDescription(java.lang.String value)` Sets the alternative description.
`void`	`setAlternativeText(java.lang.String value)` Sets the alternative text.
`void`	`setComment(java.lang.String value)` Sets the comment of the table.
`void`	`setDisplayName(java.lang.String value)` Sets the display name.
`void`	`setShowHeaderRow(boolean value)` Sets whether this ListObject show header row.
`void`	`setShowTableStyleColumnStripes(boolean value)` Indicates whether column stripe formatting is applied.
`void`	`setShowTableStyleFirstColumn(boolean value)` Indicates whether the first column in the table should have the style applied.
`void`	`setShowTableStyleLastColumn(boolean value)` Indicates whether the last column in the table should have the style applied.
`void`	`setShowTableStyleRowStripes(boolean value)` Indicates whether row stripe formatting is applied.
`void`	`setShowTotals(boolean value)` Sets whether this ListObject show total row.
`void`	`setTableStyleName(java.lang.String value)` Sets the table style name.
`void`	`setTableStyleType(int value)` Gets and the built-in table style.
`void`	`updateColumnName()` Updates all list columns' name from the worksheet.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getStartRow
```
public int getStartRow()
```
    Gets the start row of the range.
  - getStartColumn
```
public int getStartColumn()
```
    Gets the start column of the range.
  - getEndRow
```
public int getEndRow()
```
    Gets the end row of the range.
  - getEndColumn
```
public int getEndColumn()
```
    Gets the end column of the range.
  - getListColumns
```
public ListColumnCollection getListColumns()
```
    Gets ListColumns of the ListObject.
  - resize
```
public void resize(int startRow,
          int startColumn,
          int endRow,
          int endColumn,
          boolean hasHeaders)
```
    Resize the range of the list object.
    
    Parameters:
    startRow - The start row index of the new range.
    startColumn - The start column index of the new range.
    endRow - The end row index of the new range.
    endColumn - The end column index of the new range.
    hasHeaders - Whether this table has headers.
  - putCellValue
```
public void putCellValue(int rowOffset,
                int columnOffset,
                java.lang.Object value)
```
    Put the value to the cell.
    
    Parameters:
    rowOffset - The row offset in the table.
    columnOffset - The column offset in the table.
    value - The cell value.
  - putCellValue
```
public void putCellValue(int rowOffset,
                int columnOffset,
                java.lang.Object value,
                boolean isTotalsRowLabel)
```
    Put the value to the cell.
    
    Parameters:
    rowOffset - The row offset in the table.
    columnOffset - The column offset in the table.
    value - The cell value.
    isTotalsRowLabel - Indicates whether it is a label for total row,only works for total row. If False and this row is total row, a new row will be inserted.
  - putCellFormula
```
public void putCellFormula(int rowOffset,
                  int columnOffset,
                  java.lang.String formula)
```
    Put the formula to the cell in the table.
    
    Parameters:
    rowOffset - The row offset in the table.
    columnOffset - The column offset in the table.
    formula - The formula of the cell.
  - putCellFormula
```
public void putCellFormula(int rowOffset,
                  int columnOffset,
                  java.lang.String formula,
                  boolean isTotalsRowFormula)
```
    Put the formula to the cell in the table.
    
    Parameters:
    rowOffset - The row offset in the table.
    columnOffset - The column offset in the table.
    formula - The formula of the cell.
    isTotalsRowFormula -
  - getShowHeaderRow
```
public boolean getShowHeaderRow()
```
    Gets whether this ListObject show header row.
  - setShowHeaderRow
```
public void setShowHeaderRow(boolean value)
```
    Sets whether this ListObject show header row.
  - getShowTotals
```
public boolean getShowTotals()
```
    Gets whether this ListObject show total row.
  - setShowTotals
```
public void setShowTotals(boolean value)
```
    Sets whether this ListObject show total row.
  - getDataRange
```
public Range getDataRange()
```
    Gets the data range of the ListObject.
  - updateColumnName
```
public void updateColumnName()
```
    Updates all list columns' name from the worksheet.
    Remarks
    The value of the cells in the header row of the table must be same as the name of the ListColumn; Cell.PutValue do not auto modify the name of the ListColumn for performance.
  - getQueryTable
```
public QueryTable getQueryTable()
```
    Gets the linked QueryTable.
  - getDataSourceType
```
public int getDataSourceType()
```
    Gets the data source type of the table.
    See TableDataSourceType.
  - filter
```
public AutoFilter filter()
```
    Filter the table.
  - getAutoFilter
```
public AutoFilter getAutoFilter()
```
    Gets auto filter.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Gets the display name.
  - setDisplayName
```
public void setDisplayName(java.lang.String value)
```
    Sets the display name.
  - getComment
```
public java.lang.String getComment()
```
    Gets the comment of the table.
  - setComment
```
public void setComment(java.lang.String value)
```
    Sets the comment of the table.
  - getShowTableStyleFirstColumn
```
public boolean getShowTableStyleFirstColumn()
```
    Indicates whether the first column in the table should have the style applied.
  - setShowTableStyleFirstColumn
```
public void setShowTableStyleFirstColumn(boolean value)
```
    Indicates whether the first column in the table should have the style applied.
  - getShowTableStyleLastColumn
```
public boolean getShowTableStyleLastColumn()
```
    Indicates whether the last column in the table should have the style applied.
  - setShowTableStyleLastColumn
```
public void setShowTableStyleLastColumn(boolean value)
```
    Indicates whether the last column in the table should have the style applied.
  - getShowTableStyleRowStripes
```
public boolean getShowTableStyleRowStripes()
```
    Indicates whether row stripe formatting is applied.
  - setShowTableStyleRowStripes
```
public void setShowTableStyleRowStripes(boolean value)
```
    Indicates whether row stripe formatting is applied.
  - getShowTableStyleColumnStripes
```
public boolean getShowTableStyleColumnStripes()
```
    Indicates whether column stripe formatting is applied.
  - setShowTableStyleColumnStripes
```
public void setShowTableStyleColumnStripes(boolean value)
```
    Indicates whether column stripe formatting is applied.
  - applyStyleToRange
```
public void applyStyleToRange()
```
    Apply the table style to the range.
  - convertToRange
```
public void convertToRange()
```
    Convert the table to range.
  - convertToRange
```
public void convertToRange(TableToRangeOptions options)
```
    Convert the table to range.
    
    Parameters:
    options - the options when converting table to range.
  - getTableStyleType
```
public int getTableStyleType()
```
    Gets and the built-in table style.
    See TableStyleType.
    
    Example
```
 
         Workbook workbook = new Workbook("Book1.xlsx");
         ListObjectCollection tables = workbook.getWorksheets().get(0).getListObjects();
         int index = tables.add(0, 0, 9, 4, true);
         ListObject table = tables.get(0);
         table.setTableStyleType(TableStyleType.TABLE_STYLE_DARK_2);
          workbook.save("TableStyle.xlsx");
 
```
  - setTableStyleType
```
public void setTableStyleType(int value)
```
    Gets and the built-in table style.
    See TableStyleType.
  - getTableStyleName
```
public java.lang.String getTableStyleName()
```
    Gets the table style name.
  - setTableStyleName
```
public void setTableStyleName(java.lang.String value)
```
    Sets the table style name.
  - getXmlMap
```
public XmlMap getXmlMap()
```
    Gets an getXmlMap() used for this list.
  - getAlternativeText
```
public java.lang.String getAlternativeText()
```
    Gets the alternative text.
  - setAlternativeText
```
public void setAlternativeText(java.lang.String value)
```
    Sets the alternative text.
  - getAlternativeDescription
```
public java.lang.String getAlternativeDescription()
```
    Gets the alternative description.
  - setAlternativeDescription
```
public void setAlternativeDescription(java.lang.String value)
```
    Sets the alternative description.

Class ListObject

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getStartRow

getStartColumn

getEndRow

getEndColumn

getListColumns

resize

putCellValue

putCellValue

putCellFormula

putCellFormula

getShowHeaderRow

setShowHeaderRow

getShowTotals

setShowTotals

getDataRange

updateColumnName

getQueryTable

getDataSourceType

filter

getAutoFilter

getDisplayName

setDisplayName

getComment

setComment

getShowTableStyleFirstColumn

setShowTableStyleFirstColumn

getShowTableStyleLastColumn

setShowTableStyleLastColumn

getShowTableStyleRowStripes

setShowTableStyleRowStripes

getShowTableStyleColumnStripes

setShowTableStyleColumnStripes

applyStyleToRange

convertToRange

convertToRange

getTableStyleType

setTableStyleType

getTableStyleName

setTableStyleName

getXmlMap

getAlternativeText

setAlternativeText

getAlternativeDescription

setAlternativeDescription