public final class Table extends Object
Modifier and Type | Method and Description |
---|---|
TableColumn |
addColumn()
Adds a new
TableColumn to the column collection of this Table. |
void |
addRow()
Adds a new row to the row collection of this Table.
|
void |
addRow(int index)
Inserts a new row at the specified index to the row collection of this Table.
|
boolean |
equals(Object obj)
Determines whether the specified
java.lang.Object is equal to this Table instance. |
TableAlternativeText |
getAlternativeText()
Gets the table alternative text.
|
BuiltInTableStyleName |
getBuiltInStyle()
Gets the built-in style used in the body of the
Table . |
TableColumn |
getColumn(int index)
Gets the
TableColumn at the specified index from the column collection of this Table. |
TableColumn |
getColumn(String name)
Gets
TableColumn described by name from the column collection of this Table. |
TableColumnCollection |
getColumns()
Gets the collection of table columns.
|
CellRange |
getDataRange()
Gets the table data range.
|
AutoFilter |
getFilter()
Gets the table filter.
|
String |
getName()
Gets the table name.
|
CellRange |
getRange()
Gets the table range.
|
TableRowCollection |
getRows()
Gets the collection of table rows.
|
SortState |
getSort()
Gets the table sort.
|
EnumSet<TableStyleOptions> |
getStyleOptions()
Gets the options to be applied to the
Table style. |
int |
hashCode()
Returns a hash code for this
Table instance. |
boolean |
hasTotalsRow()
Gets a value indicating whether this table has a totals row.
|
TableColumn |
insertColumn(int index)
Inserts a new
TableColumn at the specified index to the column collection of this Table. |
void |
removeColumn(int index)
Removes the
TableColumn at the specified index from the column collection of this Table. |
boolean |
removeColumn(TableColumn column)
Removes the specified
TableColumn from the column collection of this Table. |
void |
removeRow(int index)
Removes the row at the specified index from the row collection of this Table.
|
void |
setBuiltInStyle(BuiltInTableStyleName value)
Sets the built-in style used in the body of the
Table . |
void |
setFilter(AutoFilter filter)
Sets the table filter.
|
void |
setHasTotalsRow(boolean value)
Sets a value indicating whether this table has a totals row.
|
void |
setStyleOptions(EnumSet<TableStyleOptions> value)
Sets the options to be applied to the
Table style. |
String |
toString()
Returns a
String that represents this Table instance. |
public TableColumn addColumn()
TableColumn
to the column collection of this Table.
This method has the same effect as using table.
getColumns()
.add()
TableColumn
.TableColumnCollection.add()
public void addRow()
This method has the same effect as using table.
getRows()
.add()
TableRowCollection.add()
public void addRow(int index)
This method has the same effect as using table.
getRows()
.add(index)
index
- The row index.IndexOutOfBoundsException
- index
is out of range.TableRowCollection.add(int)
public boolean equals(Object obj)
java.lang.Object
is equal to this Table
instance.public TableAlternativeText getAlternativeText()
public BuiltInTableStyleName getBuiltInStyle()
Table
.Table
.public TableColumn getColumn(int index)
TableColumn
at the specified index from the column collection of this Table.
This method has the same effect as using table.
getColumns()
.get(index)
index
- The zero-based index of the TableColumn
.TableColumn
at the specified index.TableColumnCollection.get(int)
public TableColumn getColumn(String name)
TableColumn
described by name from the column collection of this Table.
This method has the same effect as using table.
getColumns()
.get(name)
name
- Name of the table column.TableColumnCollection.get(String)
public TableColumnCollection getColumns()
public CellRange getDataRange()
Method returns table range without header row and, if enabled, totals row.
CellRange
.public AutoFilter getFilter()
public String getName()
public CellRange getRange()
Property returns complete table range which includes header row and, if enabled, totals row.
CellRange
.public TableRowCollection getRows()
public SortState getSort()
public EnumSet<TableStyleOptions> getStyleOptions()
Table
style.Table
style.public int hashCode()
Table
instance.public boolean hasTotalsRow()
true
if this table has totals row; otherwise, false
.public TableColumn insertColumn(int index)
TableColumn
at the specified index to the column collection of this Table.
This method has the same effect as using table.
getColumns()
.insert(index)
index
- The column index.TableColumn
.IndexOutOfBoundsException
- index
is out of range.TableColumnCollection.insert(int)
public void removeColumn(int index)
TableColumn
at the specified index from the column collection of this Table.
This method has the same effect as using table.
getColumns()
.remove(index)
index
- The column index.TableColumnCollection.remove(int)
public boolean removeColumn(TableColumn column)
TableColumn
from the column collection of this Table.
This method has the same effect as using table.
getColumns()
.remove(column)
column
- The table column.true
if TableColumn
was removed from the collection; otherwise, false
.NullPointerException
- column
is null.TableColumnCollection.remove(TableColumn)
public void removeRow(int index)
This method has the same effect as using table.
getRows()
.remove(index)
index
- The row index.IndexOutOfBoundsException
- index
is out of range.TableRowCollection.remove(int)
public void setBuiltInStyle(BuiltInTableStyleName value)
Table
.value
- The built-in style used in the body of the Table
.public void setFilter(AutoFilter filter)
filter
- The table filter.public void setHasTotalsRow(boolean value)
value
- true
if this table has totals row; otherwise, false
.public void setStyleOptions(EnumSet<TableStyleOptions> value)
Table
style.value
- The options to be applied to the Table
style.© GemBox Ltd. — All rights reserved.