Top Description Methods
org.apache.poi.ss.usermodel

public Interface TableStyle


Data table style definition. Includes style elements for various table components. Any number of style elements may be represented, and any cell may be styled by multiple elements. The order of elements in TableStyleType defines precedence.
Since
3.17 beta 1

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

index from org.apache.poi.xssf.model.StylesTable.getExplicitTableStyle(String) or org.apache.poi.xssf.usermodel.XSSFBuiltinTableStyle.ordinal()
getIndex
()

Some clients may care where in the table style list this definition came from, so we'll track it.

public String

Returns:

name (may be a built-in name)
getName
()

public DifferentialStyleProvider

Returns:

style definition for the given type, or null if not defined in this style.
getStyle
(TableStyleType type)

public boolean

Returns:

true if this is a built-in style defined in the OOXML specification, false if it is a user style
isBuiltin
()

Method Detail

getIndexback to summary
public int getIndex()

Some clients may care where in the table style list this definition came from, so we'll track it. The spec only references these by name, unlike Dxf records, which these definitions reference by index (XML definition order). Nice of MS to be consistent when defining the ECMA standard. Use org.apache.poi.xssf.usermodel.XSSFBuiltinTableStyle.isBuiltinStyle(TableStyle) to determine whether the index is for a built-in style or explicit user style

Returns:int

index from org.apache.poi.xssf.model.StylesTable.getExplicitTableStyle(String) or org.apache.poi.xssf.usermodel.XSSFBuiltinTableStyle.ordinal()

getNameback to summary
public String getName()
Returns:String

name (may be a built-in name)

getStyleback to summary
public DifferentialStyleProvider getStyle(TableStyleType type)
Returns:DifferentialStyleProvider

style definition for the given type, or null if not defined in this style.

isBuiltinback to summary
public boolean isBuiltin()
Returns:boolean

true if this is a built-in style defined in the OOXML specification, false if it is a user style