/*
* Copyright 2007-2008, Plutext Pty Ltd.
*
* This file is part of docx4j.
docx4j is licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package org.docx4j.openpackaging.parts.WordprocessingML;
import java.io.IOException;
import java.math.BigInteger;
import java.util.List;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Unmarshaller;
import org.docx4j.XmlUtils;
import org.docx4j.jaxb.Context;
import org.docx4j.model.styles.BrokenStyleRemediator;
import org.docx4j.openpackaging.exceptions.Docx4JException;
import org.docx4j.openpackaging.exceptions.InvalidFormatException;
import org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware;
import org.docx4j.openpackaging.parts.PartName;
import org.docx4j.openpackaging.parts.relationships.Namespaces;
import org.docx4j.utils.ResourceUtils;
import org.docx4j.wml.DocDefaults;
import org.docx4j.wml.HpsMeasure;
import org.docx4j.wml.PPr;
import org.docx4j.wml.PPrBase.Spacing;
import org.docx4j.wml.RPr;
import org.docx4j.wml.Style;
import org.docx4j.wml.Style.BasedOn;
import org.docx4j.wml.Styles;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public final class StyleDefinitionsPart extends JaxbXmlPartXPathAware<Styles> {
private static Logger log = LoggerFactory.getLogger(StyleDefinitionsPart.class);
public StyleDefinitionsPart(PartName partName) throws InvalidFormatException {
super(partName);
init();
}
public StyleDefinitionsPart() throws InvalidFormatException {
super(new PartName("/word/styles.xml"));
init();
}
public void init() {
// Used if this Part is added to [Content_Types].xml
setContentType(new org.docx4j.openpackaging.contenttype.ContentType(
org.docx4j.openpackaging.contenttype.ContentTypes.WORDPROCESSINGML_STYLES));
// Used when this Part is added to a rels
setRelationshipType(Namespaces.STYLES);
}
// A variety of pre-defined styles, available for use in a StyleDefinitionsPart.
private static java.util.Map<String, org.docx4j.wml.Style> knownStyles = null;
// private PropertyResolver propertyResolver;
@Override
public void setJaxbElement(Styles jaxbElement) {
super.setJaxbElement(jaxbElement);
// Null out cached values which now point to unrelated objects
styleDocDefaults=null;
defaultCharacterStyle = null;
defaultParagraphStyle = null;
defaultTableStyle = null;
css=null;
}
// @Override
// public Styles unmarshal(org.w3c.dom.Element el) throws JAXBException {
//
// // Note: This is used when we read in a pkg:package
//
// try {
//
// Unmarshaller u = jc.createUnmarshaller();
//
// u.setEventHandler(new org.docx4j.jaxb.JaxbValidationEventHandler());
//
// jaxbElement = (Styles) u.unmarshal( el );
//
// return jaxbElement;
//
// } catch (JAXBException e) {
// // TODO Auto-generated catch block
// e.printStackTrace();
// return null;
// }
// }
/**
* Unmarshal a default set of styles, useful when creating this
* part from scratch.
*
* @return the newly created root object of the java content tree
*
* @throws JAXBException
* If any unexpected errors occur while unmarshalling
*/
public Object unmarshalDefaultStyles() throws JAXBException {
// Throwable t = new Throwable();
// t.printStackTrace();
java.io.InputStream is = null;
try {
//Works in Eclipse if the resource is in source/main/java
//is = getResource("styles.xml");
// Works in Eclipse - not absence of leading '/'
is = ResourceUtils.getResourceViaProperty("docx4j.openpackaging.parts.WordprocessingML.StyleDefinitionsPart.DefaultStyles",
"org/docx4j/openpackaging/parts/WordprocessingML/styles.xml");
// styles.xml defines a small subset of common styles
// (it is a much smaller set of styles than KnownStyles.xml)
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
return unmarshal( is ); // side-effect is to set jaxbElement
}
private static void initKnownStyles() {
// Throwable t = new Throwable();
// t.printStackTrace();
java.io.InputStream is = null;
try {
is = ResourceUtils.getResourceViaProperty("docx4j.openpackaging.parts.WordprocessingML.StyleDefinitionsPart.KnownStyles",
"org/docx4j/openpackaging/parts/WordprocessingML/KnownStyles.xml");
JAXBContext jc = Context.jc;
Unmarshaller u = jc.createUnmarshaller();
u.setEventHandler(new org.docx4j.jaxb.JaxbValidationEventHandler());
org.docx4j.wml.Styles styles = (org.docx4j.wml.Styles)u.unmarshal( is );
knownStyles = new java.util.HashMap<String, org.docx4j.wml.Style>();
for ( org.docx4j.wml.Style s : styles.getStyle() ) {
knownStyles.put(s.getStyleId(), s);
}
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/**
* Returns a map of styles defined in docx4j's KnownStyles.xml
* (not styles defined in your pkg)
* @return
*/
public static java.util.Map<String, org.docx4j.wml.Style> getKnownStyles() {
if (knownStyles==null) {
initKnownStyles();
}
return knownStyles;
}
private Style styleDocDefaults;
/**
* Manufacture a paragraph style from the following, so it can be used as the
* root of our paragraph style tree.
*
* <w:docDefaults>
<w:rPrDefault>
<w:rPr>
<w:rFonts w:asciiTheme="minorHAnsi" w:eastAsiaTheme="minorHAnsi" w:hAnsiTheme="minorHAnsi" w:cstheme="minorBidi" />
<w:sz w:val="22" />
<w:szCs w:val="22" />
<w:lang w:val="en-US" w:eastAsia="en-US" w:bidi="ar-SA" />
</w:rPr>
</w:rPrDefault>
<w:pPrDefault>
<w:pPr>
<w:spacing w:after="200" w:line="276" w:lineRule="auto" />
</w:pPr>
</w:pPrDefault>
</w:docDefaults>
BEWARE: in a table, paragraph style ppr trumps table style ppr.
The effect of including w:docDefaults in the style hierarchy
is that they trump table style ppr, but they should not!
* There is no need for a doc defaults character style.
* The reason for this is that Word seems to ignore Default Paragraph Style!
* So the run formatting comes from paragraph style + explicit character style (if any),
* plus direct formatting.
*/
public void createVirtualStylesForDocDefaults() throws Docx4JException {
if (styleDocDefaults!=null) return; // been done already
String ROOT_NAME = "DocDefaults";
// could be in docx which we saved and are now re-opening
styleDocDefaults = getStyleById(this.getJaxbElement().getStyle(), ROOT_NAME);
if (styleDocDefaults==null) {
styleDocDefaults = Context.getWmlObjectFactory().createStyle();
styleDocDefaults.setStyleId(ROOT_NAME);
this.getJaxbElement().getStyle().add(styleDocDefaults);
} else {
log.info("Found existing style named " + ROOT_NAME);
log.debug(XmlUtils.marshaltoString(styleDocDefaults, true, true));
// TODO: could be a name collision; some other app using that name :-(
// We could check whether normal is based on it (see towards end of this method)
if (styleDocDefaults.getRPr()!=null) {
log.debug(".. reusing");
return;
} else {
log.debug(".. but no rPr, so re-creating");
}
}
styleDocDefaults.setType("paragraph");
org.docx4j.wml.Style.Name n = Context.getWmlObjectFactory().createStyleName();
n.setVal(ROOT_NAME);
styleDocDefaults.setName(n);
// Initialise docDefaults
DocDefaults docDefaults = this.getJaxbElement().getDocDefaults();
if (docDefaults == null) {
log.warn("No DocDefaults present");
// The only way this can happen is if the
// styles definition part is missing the docDefaults element
// (these are present in docs created from Word, and
// in our default styles, so maybe the user created it using
// some 3rd party program?)
try {
docDefaults = (DocDefaults) XmlUtils
.unmarshalString(docDefaultsString);
} catch (JAXBException e) {
throw new Docx4JException("Problem unmarshalling "
+ docDefaultsString, e);
}
}
// Setup documentDefaultPPr
PPr documentDefaultPPr;
if (docDefaults.getPPrDefault() == null) {
log.warn("No PPrDefault present");
try {
documentDefaultPPr = (PPr) XmlUtils
.unmarshalString(pPrDefaultsString);
} catch (JAXBException e) {
throw new Docx4JException("Problem unmarshalling "
+ pPrDefaultsString, e);
}
} else {
documentDefaultPPr = docDefaults.getPPrDefault().getPPr();
if (documentDefaultPPr==null) {
documentDefaultPPr = Context.getWmlObjectFactory().createPPr();
}
}
// If the docDefaults have no setting for w:spacing
// then add it:
if (documentDefaultPPr.getSpacing()==null) {
Spacing spacing = Context.getWmlObjectFactory().createPPrBaseSpacing();
documentDefaultPPr.setSpacing(spacing);
spacing.setBefore(BigInteger.ZERO);
spacing.setAfter(BigInteger.ZERO);
spacing.setLine(BigInteger.valueOf(240));
}
// Setup documentDefaultRPr
RPr documentDefaultRPr;
if (docDefaults.getRPrDefault() == null) {
log.warn("No RPrDefault present");
try {
documentDefaultRPr = (RPr) XmlUtils
.unmarshalString(rPrDefaultsString);
// that includes font size 10
} catch (JAXBException e) {
throw new Docx4JException("Problem unmarshalling "
+ rPrDefaultsString, e);
}
} else {
documentDefaultRPr = docDefaults.getRPrDefault().getRPr();
if (documentDefaultRPr==null) {
documentDefaultRPr = Context.getWmlObjectFactory().createRPr();
}
// If default font size is not specified, set it to match Word default when unspecified (ie 10)
// It is useful to have this explicitly, especially for XHTML Import
// <w:sz w:val="20"/>
// <w:szCs w:val="20"/>
if (documentDefaultRPr.getSz()==null) {
HpsMeasure s10pt = Context.getWmlObjectFactory().createHpsMeasure();
s10pt.setVal(BigInteger.valueOf(20));
documentDefaultRPr.setSz(s10pt);
}
if (documentDefaultRPr.getSzCs()==null) {
HpsMeasure s10pt = Context.getWmlObjectFactory().createHpsMeasure();
s10pt.setVal(BigInteger.valueOf(20));
documentDefaultRPr.setSzCs(s10pt);
}
}
styleDocDefaults.setPPr(documentDefaultPPr);
styleDocDefaults.setRPr(documentDefaultRPr);
// Now point Normal at this
Style normal = getDefaultParagraphStyle();
if (normal==null) {
log.warn("No default paragraph style!!");
normal = Context.getWmlObjectFactory().createStyle();
normal.setType("paragraph");
normal.setStyleId("Normal");
n = Context.getWmlObjectFactory().createStyleName();
n.setVal("Normal");
normal.setName(n);
this.getJaxbElement().getStyle().add(normal);
normal.setDefault(Boolean.TRUE); // @since 3.2.0
}
BasedOn based = Context.getWmlObjectFactory().createStyleBasedOn();
based.setVal(ROOT_NAME);
normal.setBasedOn(based);
log.info("Set virtual style, id '" + styleDocDefaults.getStyleId() + "', name '"+ styleDocDefaults.getName().getVal() + "'");
log.debug(XmlUtils.marshaltoString(styleDocDefaults, true, true));
}
/**
* @param id
* @return
* @since 3.0.0
*/
public Style getStyleById(String id) {
return getStyleById( this.getJaxbElement().getStyle(), id );
}
/**
* @param id
* @return
* @since 3.0.1
*/
private static Style getStyleById(List<Style> styles, String id) {
for ( org.docx4j.wml.Style s : styles ) {
if (s.getStyleId()==null) {
BrokenStyleRemediator.remediate(s);
}
if( s.getStyleId()!=null
&& s.getStyleId().equals(id) ) {
return s;
}
}
return null;
}
private Style defaultCharacterStyle;
public Style getDefaultCharacterStyle() {
if (defaultCharacterStyle==null) {
defaultCharacterStyle = getDefaultStyle("character");
}
// OpenOffice conversion to docx
// doesn't necessarily contain a default character style
// so manufacture one
if (defaultCharacterStyle==null) {
try {
defaultCharacterStyle = (Style)XmlUtils.unmarshalString(DEFAULT_CHARACTER_STYLE_DEFAULT);
this.getJaxbElement().getStyle().add(defaultCharacterStyle);
} catch (JAXBException e) {
e.printStackTrace();
}
}
return defaultCharacterStyle;
}
private final static String DEFAULT_CHARACTER_STYLE_DEFAULT = "<w:style w:type=\"character\" w:default=\"1\" w:styleId=\"DefaultParagraphFont\" " + Namespaces.W_NAMESPACE_DECLARATION + "><w:name w:val=\"Default Paragraph Font\" /></w:style>";
private Style defaultParagraphStyle;
/**
* if this returns null; invoke createVirtualStylesForDocDefaults() @since 3.2.0 then try again
*
* @return
*/
public Style getDefaultParagraphStyle() {
if (defaultParagraphStyle==null) {
defaultParagraphStyle = getDefaultStyle("paragraph");
}
// OpenOffice conversion to docx
// doesn't set default, so use name
// (alternatively, could use id=style0)
if (defaultParagraphStyle==null) {
for ( org.docx4j.wml.Style s : this.getJaxbElement().getStyle() ) {
if( s.getType().equals("paragraph")
&& s.getName()!=null
&& s.getName().getVal().equals("Default") ) {
log.info("Style with name " + s.getName().getVal() + ", id '" + s.getStyleId() + "' is default " + s.getType() + " style");
defaultParagraphStyle=s;
break;
}
}
}
// try using id=style0
if (defaultParagraphStyle==null) {
for ( org.docx4j.wml.Style s : this.getJaxbElement().getStyle() ) {
if( s.getType().equals("paragraph")
&& s.getStyleId().equals("style0") ) {
log.info("Style with name " + s.getName().getVal() + ", id '" + s.getStyleId() + "' is default " + s.getType() + " style");
defaultParagraphStyle=s;
break;
}
}
}
return defaultParagraphStyle;
}
private Style defaultTableStyle;
/**
* @since 3.0
*/
public Style getDefaultTableStyle() {
if (defaultTableStyle==null) {
defaultTableStyle = getDefaultStyle("table");
}
return defaultTableStyle;
}
private Style getDefaultStyle(String type) {
for ( org.docx4j.wml.Style s : this.getJaxbElement().getStyle() ) {
if( s.isDefault() && s.getType().equals(type)) {
log.info("Style with name " + s.getName().getVal() + ", id '" + s.getStyleId() + "' is default " + s.getType() + " style");
return s;
}
}
return null;
}
final static String wNamespaceDec = " xmlns:w=\"" + Namespaces.NS_WORD12 + "\"";
public final static String rPrDefaultsString = "<w:rPr" + wNamespaceDec + ">"
// Word 2007 still uses Times New Roman if there is no theme part, and we'd like to replicate that
// + "<w:rFonts w:asciiTheme=\"minorHAnsi\" w:eastAsiaTheme=\"minorHAnsi\" w:hAnsiTheme=\"minorHAnsi\" w:cstheme=\"minorBidi\" />"
+ "<w:sz w:val=\"20\" />" // was 11 prior to 3.01, but Word default in absence of this setting is 10.
+ "<w:szCs w:val=\"20\" />"
+ "<w:lang w:val=\"en-US\" w:eastAsia=\"en-US\" w:bidi=\"ar-SA\" />"
+ "</w:rPr>";
public final static String pPrDefaultsString = "<w:pPr" + wNamespaceDec + ">"
+ "<w:spacing w:after=\"200\" w:line=\"276\" w:lineRule=\"auto\" />"
+ "</w:pPr>";
public final static String docDefaultsString = "<w:docDefaults" + wNamespaceDec + ">"
+ "<w:rPrDefault>"
+ rPrDefaultsString
+ "</w:rPrDefault>"
+ "<w:pPrDefault>"
+ pPrDefaultsString
+ "</w:pPrDefault>"
+ "</w:docDefaults>";
/**
* It is convenient to have a CSS representation of styles,
* and this part is a natural place to store it.
*
* HtmlCssHelper contains a method createCssForStyles which
* relies on StyleTree to generate CSS.
*/
private String css;
public String getCss() {
return css;
}
public void setCss(String css) {
this.css = css;
}
/**
* For a run/character style return its linked paragraph style (if any),
* or vice versa.
*
* @param rStyleVal
* @return
*/
public Style getLinkedStyle(String rStyleVal) {
Style rStyle = getStyleById(rStyleVal);
if (rStyle==null) {
log.warn("Couldn't find rStyle " + rStyleVal);
return null;
} else {
// We have a run level style. Is there a linked pStyle?
Style.Link linkedStyle = rStyle.getLink();
if (linkedStyle==null) {
log.warn("No linked style for rStyle " + rStyleVal);
return null;
} else {
String pStyleVal = linkedStyle.getVal();
log.debug(rStyleVal + " is linked to style " + pStyleVal );
Style pStyle = getStyleById(pStyleVal);
if (pStyle==null) {
log.warn("Couldn't find linked pStyle " + pStyleVal
+ " for rStyle " + rStyleVal);
}
return pStyle;
}
}
}
// public static void main(String[] args) throws Exception {
//
// StyleDefinitionsPart sdp = new StyleDefinitionsPart ();
// sdp.initKnownStyles();
//
// }
}