/**
* Copyright (C) 2011-2015 The XDocReport Team <xdocreport@googlegroups.com>
*
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package fr.opensagres.poi.xwpf.converter.core;
import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.Map;
import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlObject;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDocument1;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtrRef;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPPr;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSectPr;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSettings;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr;
import fr.opensagres.poi.xwpf.converter.core.styles.XWPFStylesDocument;
import fr.opensagres.poi.xwpf.converter.core.utils.XWPFUtils;
/**
* See http://officeopenxml.com/WPsection.php
*/
public class MasterPageManager
extends LinkedList<CTSectPr>
{
private final CTDocument1 document;
private final IMasterPageHandler documentHandler;
private final CTSectPr bodySectPr;
private CTSectPr currentSectPr;
private final Map<CTSectPr, IXWPFMasterPage> masterPages;
private boolean initialized;
private boolean changeSection;
private int nbPages;
private IXWPFMasterPage currentMasterPage;
private final boolean evenAndOddHeaders;
public MasterPageManager( CTDocument1 document, IMasterPageHandler visitor )
throws Exception
{
this.document = document;
this.documentHandler = visitor;
this.bodySectPr = document.getBody().getSectPr();
this.masterPages = new HashMap<CTSectPr, IXWPFMasterPage>();
this.initialized = false;
this.changeSection = false;
this.nbPages = 0;
// get event
this.evenAndOddHeaders = isEventAndOddHeaders( visitor.getStylesDocument() );
}
public void initialize()
throws Exception
{
this.initialized = true;
compute( document );
if ( isEmpty() )
{
currentSectPr = bodySectPr;
addSection( currentSectPr, false );
fireSectionChanged( currentSectPr );
}
else
{
currentSectPr = super.poll();
fireSectionChanged( currentSectPr );
}
}
private void compute( CTDocument1 document )
throws Exception
{
XmlCursor cursor = document.getBody().newCursor();
cursor.selectPath( "./*" );
while ( cursor.toNextSelection() )
{
XmlObject o = cursor.getObject();
if ( o instanceof CTP )
{
CTP paragraph = (CTP) o;
CTSectPr sectPr = getSectPr( paragraph );
if ( sectPr != null )
{
addSection( sectPr, true );
}
}
}
/*
* for ( IBodyElement bodyElement : document.getBodyElements() ) { if ( bodyElement.getElementType() ==
* BodyElementType.PARAGRAPH ) { XWPFParagraph paragraph = (XWPFParagraph) bodyElement; CTSectPr sectPr =
* getSectPr( paragraph ); if ( sectPr != null ) { addSection( sectPr, true ); } } }
*/
addSection( bodySectPr, false );
}
public CTSectPr getBodySectPr()
{
return bodySectPr;
}
public void update( CTP paragraph )
{
if ( changeSection )
{
changeSection = false;
if ( !isEmpty() )
{
currentSectPr = super.poll();
fireSectionChanged( currentSectPr );
}
else
{
currentSectPr = bodySectPr;
fireSectionChanged( currentSectPr );
}
}
else
{
CTSectPr sectPr = getSectPr( paragraph );
if ( sectPr != null )
{
currentSectPr = sectPr;
changeSection = true;
}
}
}
private void fireSectionChanged( CTSectPr sectPr )
{
currentMasterPage = getMasterPage( sectPr );
documentHandler.setActiveMasterPage( currentMasterPage );
}
private void addSection( CTSectPr sectPr, boolean pushIt )
throws Exception
{
if ( pushIt )
{
super.add( sectPr );
}
// For each <w:sectPr of the word/document.xml, create a master page.
IXWPFMasterPage masterPage = documentHandler.createMasterPage( sectPr );
visitHeadersFooters( masterPage, sectPr );
masterPages.put( sectPr, masterPage );
}
// ------------------------------ Header/Footer visitor -----------
private void visitHeadersFooters( IXWPFMasterPage masterPage, CTSectPr sectPr )
throws Exception
{
// see titlePg at http://officeopenxml.com/WPsection.php i
// Specifies whether the section should have a different header and
// footer
// for its first page.
// If the element is set to true (e.g., <w:titlePg/>),
// then the section will use a first page header;
// if it is false (e.g., <w:titlePg w:val="false"/>)
// (the default value), then the first page uses the odd page header. If
// the element is set to true but the
// first page header type is omitted, then a blank header is created.
boolean ignoreFirstHeaderFooter = !XWPFUtils.isCTOnOff( sectPr.getTitlePg() );
Collection<CTHdrFtrRef> headersRef = sectPr.getHeaderReferenceList();
Collection<CTHdrFtrRef> footersRef = sectPr.getFooterReferenceList();
boolean firstHeaderFooter = false;
for ( CTHdrFtrRef headerRef : headersRef )
{
STHdrFtr type = headerRef.xgetType();
firstHeaderFooter = ( type != null && type.enumValue() == STHdrFtr.FIRST );
if ( !firstHeaderFooter || ( firstHeaderFooter && !ignoreFirstHeaderFooter ) )
{
masterPage.setType( type.enumValue().intValue() );
documentHandler.visitHeaderRef( headerRef, sectPr, masterPage );
}
}
for ( CTHdrFtrRef footerRef : footersRef )
{
STHdrFtr type = footerRef.xgetType();
firstHeaderFooter = ( type != null && type.enumValue() == STHdrFtr.FIRST );
if ( !firstHeaderFooter || ( firstHeaderFooter && !ignoreFirstHeaderFooter ) )
{
masterPage.setType( type.enumValue().intValue() );
documentHandler.visitFooterRef( footerRef, sectPr, masterPage );
}
}
masterPage.setType( STHdrFtr.INT_FIRST );
}
private CTSectPr getSectPr( CTP paragraph )
{
CTPPr ppr = paragraph.getPPr();
if ( ppr != null )
{
return ppr.getSectPr();
}
return null;
}
public IXWPFMasterPage getMasterPage( CTSectPr sectPr )
{
return masterPages.get( sectPr );
}
public boolean isInitialized()
{
return initialized;
}
// edited
public void onNewPage()
{
if ( currentMasterPage != null )
{
int oldType = currentMasterPage.getType();
int newType = STHdrFtr.INT_DEFAULT;
if ( evenAndOddHeaders )
{
if ( nbPages % 2 == 0 )
{
newType = STHdrFtr.INT_EVEN;
}
nbPages++;
}
if ( oldType != newType )
{
currentMasterPage.setType( newType );
}
}
}
/**
* Returns true if <w:evenAndOddHeaders /> is defined in the word/settings.xml entry and false otherwise.
*
* @param stylesDocument
* @return
*/
private boolean isEventAndOddHeaders( XWPFStylesDocument stylesDocument )
{
if ( stylesDocument == null )
{
return false;
}
CTSettings settings = stylesDocument.getCTSettings();
if ( settings == null )
{
return false;
}
return XWPFUtils.isCTOnOff( settings.getEvenAndOddHeaders() );
}
}