/************************************************************************
 *
 *	FootnoteConverter.java
 *
 *  Copyright: 2002-2015 by Henrik Just
 *
 *  This file is part of Writer2LaTeX.
 *  
 *  Writer2LaTeX is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *  
 *  Writer2LaTeX is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *  
 *  You should have received a copy of the GNU General Public License
 *  along with Writer2LaTeX.  If not, see <http://www.gnu.org/licenses/>.
 * 
 *  Version 1.6 (2015-06-14)
 *
 */
package writer2latex.xhtml.content;

import org.w3c.dom.Element;
import org.w3c.dom.Node;

import writer2latex.office.OfficeReader;
import writer2latex.office.PropertySet;
import writer2latex.office.XMLString;
import writer2latex.xhtml.Converter;
import writer2latex.xhtml.StyleInfo;
import writer2latex.xhtml.XhtmlConfig;

class FootnoteParser extends NoteParser {
	
    // Footnote position (can be page or document)
    private boolean bFootnotesAtPage = true;

    FootnoteParser(OfficeReader ofr, XhtmlConfig config, Converter converter) {
        super(ofr,config,converter,ofr.getFootnotesConfiguration());
        PropertySet configuration=ofr.getFootnotesConfiguration();
        if (configuration!=null) {
        	bFootnotesAtPage = !"document".equals(configuration.getProperty(XMLString.TEXT_FOOTNOTES_POSITION));
        }
    }
    
    /** Insert the footnotes gathered so far. Export will only happen if the source document configures footnotes
     *  per page, or if this is the final call of the method.
     * 
     * @param hnode a block HTML element to contain the footnotes
     * @param bFinal true if this is the final call
     */
    void insertFootnotes(Node hnode, boolean bFinal) {
        if (hasNotes()) {
        	if (bFootnotesAtPage) {
        		Element sectionElement = createNoteSection(hnode, "footnotes");

        		// Add footnote rule
        		Element rule = converter.createElement("hr");
        		StyleInfo info = new StyleInfo();
        		getPageSc().applyFootnoteRuleStyle(info);
        		getPageSc().applyStyle(info, rule);
        		sectionElement.appendChild(rule);

        		flushAllNotes(sectionElement,"footnote");
        	}
        	else if (bFinal) {
        		// New page if required for footnotes as endnotes
        		if (config.getXhtmlSplitLevel()>0) { hnode = converter.nextOutFile(); }
        		Element sectionElement = createNoteSection(hnode, "footnotes");
        		insertNoteHeading(sectionElement, config.getFootnotesHeading(), "footnotes");        	
        		flushAllNotes(sectionElement,"footnote");
        	}
        }
    }

}