org.apache.poi.xssf.model

Class ThemesTable

java.lang.Object

org.apache.poi.POIXMLDocumentPart

org.apache.poi.xssf.model.ThemesTable

public class ThemesTable
extends POIXMLDocumentPart

Class that represents theme of XLSX document. The theme includes specific colors and fonts.

Field Summary

Fields inherited from class org.apache.poi.POIXMLDocumentPart

DEFAULT_XML_OPTIONS

Constructor Summary

Constructors

Constructor and Description
ThemesTable(PackagePart part, PackageRelationship rel) Construct a ThemesTable.
ThemesTable(org.openxmlformats.schemas.drawingml.x2006.main.ThemeDocument theme) Construct a ThemesTable from an existing ThemeDocument.

Method Summary

Modifier and Type	Method and Description
XSSFColor	getThemeColor(int idx) Convert a theme "index" into a color.
void	inheritFromThemeAsRequired(XSSFColor color) If the colour is based on a theme, then inherit information (currently just colours) from it as required.

Methods inherited from class org.apache.poi.POIXMLDocumentPart

addRelation, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelations, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ThemesTable

public ThemesTable(PackagePart part,
                   PackageRelationship rel)
            throws java.io.IOException

Construct a ThemesTable.

Parameters:

part - A PackagePart.

rel - A PackageRelationship.

Throws:

java.io.IOException

ThemesTable

public ThemesTable(org.openxmlformats.schemas.drawingml.x2006.main.ThemeDocument theme)

Construct a ThemesTable from an existing ThemeDocument.

Parameters:

theme - A ThemeDocument.

Method Detail

getThemeColor

public XSSFColor getThemeColor(int idx)

Convert a theme "index" into a color.

Parameters:

idx - A theme "index"

Returns:

The mapped XSSFColor, or null if not mapped.

inheritFromThemeAsRequired

public void inheritFromThemeAsRequired(XSSFColor color)

If the colour is based on a theme, then inherit information (currently just colours) from it as required.