org.apache.poi.xslf.usermodel

Class XSLFTheme

java.lang.Object

org.apache.poi.ooxml.POIXMLDocumentPart

org.apache.poi.xslf.usermodel.XSLFTheme

@Beta
public class XSLFTheme
extends POIXMLDocumentPart

A shared style sheet in a .pptx slide show

Nested Class Summary

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

POIXMLDocumentPart.RelationPart

Constructor Summary

Constructors

Constructor and Description
XSLFTheme(PackagePart 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()
org.openxmlformats.schemas.drawingml.x2006.main.CTOfficeStyleSheet	getXmlObject() While developing only!
void	importTheme(XSLFTheme theme)
void	setName(String name) Set name of this 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, onDocumentRead, 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

XSLFTheme

public XSLFTheme(PackagePart part)
          throws IOException,
                 org.apache.xmlbeans.XmlException

Throws:

IOException

org.apache.xmlbeans.XmlException

Since:

POI 3.14-Beta1

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

getXmlObject

@Internal
public org.openxmlformats.schemas.drawingml.x2006.main.CTOfficeStyleSheet getXmlObject()

While developing only!

commit

protected final 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

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.