org.docx4j.convert.out.html.FldSimpleWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of docx4j Show documentation
docx4j is a library which helps you to work with the Office Open XML file format as used in docx documents, pptx presentations, and xlsx spreadsheets.
The newest version!
/*
   Licensed to Plutext Pty Ltd under one or more contributor license agreements.  
   
 *  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.convert.out.html;

import java.util.List;

import javax.xml.transform.TransformerException;

import org.docx4j.convert.out.common.AbstractWmlConversionContext;
import org.docx4j.convert.out.common.writer.AbstractFldSimpleWriter;
import org.docx4j.convert.out.common.writer.AbstractPagerefHandler;
import org.docx4j.convert.out.common.writer.HyperlinkUtil;
import org.docx4j.convert.out.common.writer.RefHandler;
import org.docx4j.model.fields.FldSimpleModel;
import org.docx4j.model.fields.FormattingSwitchHelper;
import org.docx4j.model.properties.Property;
import org.docx4j.utils.FoNumberFormatUtil;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.Element;

public class FldSimpleWriter extends AbstractFldSimpleWriter {
	
	//In HTML there is only one page - therefore the result is always a (more or less formatted) "1"
	//to keep it consistent with what fo does, it uses the formatting of the page numbers
	protected abstract static class AbstractPageHandler implements FldSimpleStringWriterHandler {

		@Override
		public String toString(AbstractWmlConversionContext context, FldSimpleModel model) throws TransformerException {
		String pageFormat = context.getSections().getCurrentSection().getPageNumberInformation().getPageFormat();
			pageFormat = FormattingSwitchHelper.getFoPageNumberFormat(pageFormat);
			return FoNumberFormatUtil.format(1, pageFormat);
		}
	}
	
	protected static class PageHandler extends AbstractPageHandler {
		@Override
		public String getName() { return "PAGE"; }
	}
	
	protected static class NumpagesHandler extends AbstractPageHandler {
		@Override
		public String getName() { return "NUMPAGES"; }
	}
	
	protected static class SectionpagesHandler extends AbstractPageHandler {
		@Override
		public String getName() { return "SECTIONPAGES"; }
	}
	
	protected static class PagerefHandler extends AbstractPagerefHandler {
		protected PagerefHandler() {
			super(HyperlinkUtil.HTML_OUTPUT);
		}

		@Override
		protected Node createPageref(AbstractWmlConversionContext context, Document doc, String bookmarkId) {
		Element ret = doc.createElement("span");
		String pageNumberFormat = context.getSections().getCurrentSection().getPageNumberInformation().getNumpagesFormat();
			pageNumberFormat = FormattingSwitchHelper.getFoPageNumberFormat(pageNumberFormat);
			ret.appendChild(doc.createTextNode(FoNumberFormatUtil.format(1, pageNumberFormat)));
			return ret;
		}
		
	}
	
	public FldSimpleWriter() {
		super(null, "span");
	}

	@Override
	protected void registerHandlers() {
		super.registerHandlers();
		registerHandler(new PageHandler());
		//disabled until 2pass is implemented
		registerHandler(new NumpagesHandler());
		registerHandler(new SectionpagesHandler());
		registerHandler(new HyperlinkWriter());
		registerHandler(new RefHandler(HyperlinkUtil.HTML_OUTPUT));
		registerHandler(new PagerefHandler());
	}

	@Override
	protected void applyProperties(List properties, Node node) {
		HtmlCssHelper.applyAttributes(properties, (Element)node);
	}
}