Apache POI - Common 5.3.0 · org.apache.poi.ss.usermodel.TableStyleType

Ordered list of table style elements, for both data tables and pivot tables. Some elements only apply to pivot tables, but any style definition can omit any number, so having them in one list should not be a problem.

The order is the specification order of application, with later elements overriding previous ones, if style properties conflict.

Processing could iterate bottom-up if looking for specific properties, and stop when the first style is found defining a value for that property.

Enum names match the OOXML spec values exactly, so valueOf(String) will work.

Field Summary

Modifier and Type	Field and Description
public static final TableStyleType	blankRow
public static final TableStyleType	firstColumn
public static final TableStyleType	firstColumnStripe
public static final TableStyleType	firstColumnSubheading
public static final TableStyleType	firstHeaderCell
public static final TableStyleType	firstRowStripe
public static final TableStyleType	firstRowSubheading
public static final TableStyleType	firstSubtotalColumn
public static final TableStyleType	firstSubtotalRow
public static final TableStyleType	firstTotalCell
public static final TableStyleType	headerRow
public static final TableStyleType	lastColumn
public static final TableStyleType	lastHeaderCell
public static final TableStyleType	lastTotalCell
public static final TableStyleType	pageFieldLabels
public static final TableStyleType	pageFieldValues
public static final TableStyleType	secondColumnStripe
public static final TableStyleType	secondColumnSubheading
public static final TableStyleType	secondRowStripe
public static final TableStyleType	secondRowSubheading
public static final TableStyleType	secondSubtotalColumn
public static final TableStyleType	secondSubtotalRow
public static final TableStyleType	thirdColumnSubheading
public static final TableStyleType	thirdRowSubheading
public static final TableStyleType	thirdSubtotalColumn
public static final TableStyleType	thirdSubtotalRow
public static final TableStyleType	totalRow
public static final TableStyleType	wholeTable

Access	Constructor and Description
private	TableStyleType()

Method Summary

Modifier and Type	Method and Description
public CellRangeAddressBase	Returns: range in the table representing this class of cells, if it contains the given cell, or null if not applicable. Stripe style types return only the stripe range containing the given cell, or null. appliesTo(Table table to evaluate table, Cell to evaluate cell) A range is returned only for the part of the table matching this enum instance and containing the given cell.
public CellRangeAddressBase	Returns: range in the table representing this class of cells, if it contains the given cell, or null if not applicable. Stripe style types return only the stripe range containing the given cell, or null. appliesTo(Table table to evaluate table, CellReference CellReference to evaluate cell) A range is returned only for the part of the table matching this enum instance and containing the given cell reference.
public final CellRangeAddressBase	Returns: default is unimplemented/null getRange(Table table, Cell cell) Calls `getRange(Table, CellReference)`.
public CellRangeAddressBase	Returns: default is unimplemented/null getRange(Table table, CellReference cell)
public static TableStyleType	valueOf(String name)
public static TableStyleType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

blankRow	back to summary
public static final TableStyleType blankRow

firstColumn	back to summary
public static final TableStyleType firstColumn

firstColumnStripe	back to summary
public static final TableStyleType firstColumnStripe

firstColumnSubheading	back to summary
public static final TableStyleType firstColumnSubheading

firstHeaderCell	back to summary
public static final TableStyleType firstHeaderCell

firstRowStripe	back to summary
public static final TableStyleType firstRowStripe

firstRowSubheading	back to summary
public static final TableStyleType firstRowSubheading

firstSubtotalColumn	back to summary
public static final TableStyleType firstSubtotalColumn

firstSubtotalRow	back to summary
public static final TableStyleType firstSubtotalRow

firstTotalCell	back to summary
public static final TableStyleType firstTotalCell

headerRow	back to summary
public static final TableStyleType headerRow

lastColumn	back to summary
public static final TableStyleType lastColumn

lastHeaderCell	back to summary
public static final TableStyleType lastHeaderCell

lastTotalCell	back to summary
public static final TableStyleType lastTotalCell

pageFieldLabels	back to summary
public static final TableStyleType pageFieldLabels

pageFieldValues	back to summary
public static final TableStyleType pageFieldValues

secondColumnStripe	back to summary
public static final TableStyleType secondColumnStripe

secondColumnSubheading	back to summary
public static final TableStyleType secondColumnSubheading

secondRowStripe	back to summary
public static final TableStyleType secondRowStripe

secondRowSubheading	back to summary
public static final TableStyleType secondRowSubheading

secondSubtotalColumn	back to summary
public static final TableStyleType secondSubtotalColumn

secondSubtotalRow	back to summary
public static final TableStyleType secondSubtotalRow

thirdColumnSubheading	back to summary
public static final TableStyleType thirdColumnSubheading

thirdRowSubheading	back to summary
public static final TableStyleType thirdRowSubheading

thirdSubtotalColumn	back to summary
public static final TableStyleType thirdSubtotalColumn

thirdSubtotalRow	back to summary
public static final TableStyleType thirdSubtotalRow

totalRow	back to summary
public static final TableStyleType totalRow

wholeTable	back to summary
public static final TableStyleType wholeTable

Constructor Detail

TableStyleType	back to summary
private TableStyleType()

Method Detail

appliesTo back to summary

appliesTo	back to summary
public CellRangeAddressBase appliesTo(Table table, Cell cell) A range is returned only for the part of the table matching this enum instance and containing the given cell. Null is returned for all other cases, such as: Cell on a different sheet than the table Cell outside the table this Enum part is not included in the table (i.e. no header/totals row) this Enum is for a table part not yet implemented in POI, such as pivot table elements The returned range can be used to determine how style options may or may not apply to this cell. For example, `wholeTable` borders only apply to the outer boundary of a table, while the rest of the styling, such as font and color, could apply to all the interior cells as well. Parameters table:Table table to evaluate cell:Cell to evaluate Returns:CellRangeAddressBase range in the table representing this class of cells, if it contains the given cell, or null if not applicable. Stripe style types return only the stripe range containing the given cell, or null.

public CellRangeAddressBase appliesTo(Table table, Cell cell)

A range is returned only for the part of the table matching this enum instance and containing the given cell. Null is returned for all other cases, such as:

Cell on a different sheet than the table
Cell outside the table
this Enum part is not included in the table (i.e. no header/totals row)
this Enum is for a table part not yet implemented in POI, such as pivot table elements

The returned range can be used to determine how style options may or may not apply to this cell. For example, wholeTable borders only apply to the outer boundary of a table, while the rest of the styling, such as font and color, could apply to all the interior cells as well.

Parameters

table:Table: table to evaluate
cell:Cell: to evaluate

Returns:CellRangeAddressBase

range in the table representing this class of cells, if it contains the given cell, or null if not applicable. Stripe style types return only the stripe range containing the given cell, or null.

appliesTo back to summary

appliesTo	back to summary
public CellRangeAddressBase appliesTo(Table table, CellReference cell) A range is returned only for the part of the table matching this enum instance and containing the given cell reference. Null is returned for all other cases, such as: Cell on a different sheet than the table Cell outside the table this Enum part is not included in the table (i.e. no header/totals row) this Enum is for a table part not yet implemented in POI, such as pivot table elements The returned range can be used to determine how style options may or may not apply to this cell. For example, `wholeTable` borders only apply to the outer boundary of a table, while the rest of the styling, such as font and color, could apply to all the interior cells as well. Parameters table:Table table to evaluate cell:CellReference CellReference to evaluate Returns:CellRangeAddressBase range in the table representing this class of cells, if it contains the given cell, or null if not applicable. Stripe style types return only the stripe range containing the given cell, or null.

public CellRangeAddressBase appliesTo(Table table, CellReference cell)

A range is returned only for the part of the table matching this enum instance and containing the given cell reference. Null is returned for all other cases, such as:

Cell on a different sheet than the table
Cell outside the table
this Enum part is not included in the table (i.e. no header/totals row)
this Enum is for a table part not yet implemented in POI, such as pivot table elements

Parameters

table:Table: table to evaluate
cell:CellReference: CellReference to evaluate

Returns:CellRangeAddressBase

range in the table representing this class of cells, if it contains the given cell, or null if not applicable. Stripe style types return only the stripe range containing the given cell, or null.

getRange back to summary

getRange	back to summary
public final CellRangeAddressBase getRange(Table table, Cell cell) Calls `getRange(Table, CellReference)`. Use that instead for performance. Returns:CellRangeAddressBase default is unimplemented/null See Also `getRange(Table, CellReference)`

public final CellRangeAddressBase getRange(Table table, Cell cell)

Calls getRange(Table, CellReference). Use that instead for performance.

Returns:CellRangeAddressBase: default is unimplemented/null
See Also: getRange(Table, CellReference)

getRange	back to summary
public CellRangeAddressBase getRange(Table table, CellReference cell) Returns:CellRangeAddressBase default is unimplemented/null

valueOf	back to summary
public static TableStyleType valueOf(String name)

values	back to summary
public static TableStyleType[] values()

public sealed Enum TableStyleType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail