Package org.apache.poi.xssf.model

Class ThemesTable

java.lang.Object

org.apache.poi.ooxml.POIXMLDocumentPart

org.apache.poi.xssf.model.ThemesTable

All Implemented Interfaces:

Themes

public class ThemesTable
extends POIXMLDocumentPart
implements Themes

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ThemesTable.ThemeElement

Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

POIXMLDocumentPart.RelationPart

Constructor Summary

Constructors

Constructor	Description
ThemesTable()	Create a new, empty ThemesTable
ThemesTable(InputStream stream)	Construct a ThemesTable.
ThemesTable(PackagePart part)	Construct a ThemesTable.
ThemesTable(ThemeDocument theme)	Construct a ThemesTable from an existing ThemeDocument.

Method Summary

Modifier and Type	Method	Description
XSSFColor	getThemeColor(int idx)	Convert a theme "index" (as used by fonts etc) 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.
void	readFrom(InputStream is)	Read this themes table from an XML file.
void	writeTo(OutputStream out)	Write this table out as XML.

Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, isCommitted, setCommitted, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ThemesTable

public ThemesTable()

Create a new, empty ThemesTable

ThemesTable

public ThemesTable(PackagePart part)
            throws IOException

Construct a ThemesTable.

Parameters:

part - A PackagePart.

Throws:

IOException

Since:

POI 3.14-Beta1

ThemesTable

public ThemesTable(InputStream stream)
            throws IOException

Construct a ThemesTable.

Parameters:

stream - input stream.

Throws:

IOException

Since:

POI 5.2.0

ThemesTable

public ThemesTable(ThemeDocument theme)

Construct a ThemesTable from an existing ThemeDocument.

Parameters:

theme - A ThemeDocument.

Method Details

readFrom

public void readFrom(InputStream is)
              throws IOException

Read this themes table from an XML file.

Parameters:

is - The input stream containing the XML document.

Throws:

IOException - if an error occurs while reading.

Since:

POI 5.2.0

getThemeColor

public XSSFColor getThemeColor(int idx)

Convert a theme "index" (as used by fonts etc) into a color.

Specified by:

getThemeColor in interface Themes

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.

Specified by:

inheritFromThemeAsRequired in interface Themes

writeTo

public void writeTo(OutputStream out)
             throws IOException

Write this table out as XML.

Parameters:

out - The stream to write to.

Throws:

IOException - if an error occurs while writing.