org.apache.poi.xwpf.usermodel

Class XWPFTheme

java.lang.Object

org.apache.poi.ooxml.POIXMLDocumentPart

org.apache.poi.xwpf.usermodel.XWPFTheme

public class XWPFTheme
extends POIXMLDocumentPart

A shared style sheet in a .docx document

Since:

POI 5.2.4

Nested Class Summary

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

POIXMLDocumentPart.RelationPart

Constructor Summary

Constructors

Constructor and Description
XWPFTheme() Construct XWPFStyles from scratch for a new document.
XWPFTheme(PackagePart part) Construct XWPFStyles from a package part

Method Summary

Modifier and Type	Method and Description
protected void	commit() Save the content in the underlying package part.
org.openxmlformats.schemas.drawingml.x2006.main.CTColor	getCTColor(String name) Get a color from the theme's color scheme by name
String	getMajorFont()
String	getMinorFont()
String	getName()
void	importTheme(XSLFTheme theme)
protected void	onDocumentRead() Read document
void	setName(String name) Set name of this theme
void	setTheme(org.openxmlformats.schemas.drawingml.x2006.main.CTOfficeStyleSheet theme)

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

_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommitted, onDocumentCreate, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommitted, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XWPFTheme

public XWPFTheme(PackagePart part)

Construct XWPFStyles from a package part

Parameters:

part - the package part holding the data of the styles

XWPFTheme

public XWPFTheme()

Construct XWPFStyles from scratch for a new document.

Method Detail

importTheme

public void importTheme(XSLFTheme theme)

getName

public String getName()

Returns:

name of this theme, e.g. "Office Theme"

setName

public void setName(String name)

Set name of this theme

Parameters:

name - name of this theme

getCTColor

@Internal
public org.openxmlformats.schemas.drawingml.x2006.main.CTColor getCTColor(String name)

Get a color from the theme's color scheme by name

Returns:

a theme color or null if not found

getMajorFont

public String getMajorFont()

Returns:

typeface of the major font to use in a document. Typically, the major font is used for heading areas of a document.

getMinorFont

public String getMinorFont()

Returns:

typeface of the minor font to use in a document. Typically, the minor font is used for normal text or paragraph areas.

onDocumentRead

protected void onDocumentRead()
                       throws IOException

Read document

Overrides:

onDocumentRead in class POIXMLDocumentPart

Throws:

IOException - a subclass may throw an IOException when a document is read

commit

protected void commit()
               throws IOException

Description copied from class: POIXMLDocumentPart

Save the content in the underlying package part. Default implementation is empty meaning that the package part is left unmodified.

Sub-classes should override and add logic to marshal the "model" into Ooxml4J.

For example, the code saving a generic XML entry may look as follows:

 protected void commit() throws IOException {
   PackagePart part = getPackagePart();
   try (OutputStream out = part.getOutputStream()) {
     XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
     bean.save(out, DEFAULT_XML_OPTIONS);
   }
 }
 

Overrides:

commit in class POIXMLDocumentPart

Throws:

IOException - a subclass may throw an IOException if the changes can't be committed

setTheme

public void setTheme(org.openxmlformats.schemas.drawingml.x2006.main.CTOfficeStyleSheet theme)